wamblee.org Git - xmlrouter/blob - config/src/main/java/org/wamblee/xmlrouter/config/ConfigurationProvider.java

   1 /*
   2  * Copyright 2005-2011 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.xmlrouter.config;
  17
  18 /**
  19  * The configuration provider must be imp0lemneted to provide a part of the
  20  * configuration. The XML Router calls the configuration provider repeatedly to
  21  * find out the current configuration.
  22  *
  23  * How the XML router obtains an instance of the configuration provider depends
  24  * on how the \ XML router is deployed. In an OSGi type deployment, this could
  25  * be for instance through an extender pattern whereby the XML router discovers
  26  * configuration providers at runtime.
  27  *
  28  * @author Erik Brakkee
  29  *
  30  */
  31 public interface ConfigurationProvider {
  32
  33     /**
  34      * Gets the current configuration to use. An implementation may cache the
  35      * configuration objects an return it a second time or it may return a new
  36      * configuration object each time.
  37      *
  38      * @return Configuration, may not be null.
  39      */
  40     Configuration getConfiguration();
  41 }