wamblee.org Git - xmlrouter/blob - impl/src/main/java/org/wamblee/xmlrouter/impl/XMLRouterConfiguration.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.impl;
  17
  18 /**
  19  * The XML Router configuration contains both configuration data as well as
  20  * derived data used by the XML router. It is important that all this data is
  21  * consistent. Therefore, this class provides a read-write locking mechanism for
  22  * accessing the data.
  23  *
  24  * @author Erik Brakkee
  25  *
  26  */
  27 public interface XMLRouterConfiguration {
  28
  29     /**
  30      * To be called before the configuration is used. Corresponds to read lock
  31      * acquire.
  32      */
  33     void startPublishEvent();
  34
  35     /**
  36      * @return Configuration data. {@link #startPublishEvent()} must have been
  37      *         called before doing this.
  38      */
  39     ExtendedRouterConfig getRouterConfig();
  40
  41     /**
  42      * @return Transformation paths (derived data).
  43      */
  44     TransformationPaths getTransformations();
  45
  46     /**
  47      * To be called after the configuration is used. Corresponds to read lock
  48      * release.
  49      */
  50     void endPublishEvent();
  51
  52     /**
  53      * Atomically sets the configuration and updates derived data. There will be
  54      * a short time during which read attempts will fail.
  55      *
  56      * @param aConfig
  57      *            Configuration to set.
  58      */
  59     void setRouterConfig(ExtendedRouterConfig aConfig);
  60 }