wamblee.org Git - xmlrouter/blob - router/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 import org.wamblee.general.Pair;
  19
  20 /**
  21  * The XML Router configuration contains both configuration data as well as
  22  * derived data used by the XML router. It is important that all this data is
  23  * consistent. Therefore, this class provides a read-write locking mechanism for
  24  * accessing the data.
  25  *
  26  * @author Erik Brakkee
  27  *
  28  */
  29 public interface XMLRouterConfiguration {
  30
  31     /**
  32      * Atomically get the configuration. The XMLRouter uses this to get a
  33      * snapshot of the configuration data for handling a single message. In this
  34      * way a consistent configuration is used for each event.
  35      *
  36      * @return Configuration.
  37      */
  38     Pair<ExtendedRouterConfig, TransformationPaths> getConfig();
  39
  40     /**
  41      * Atomically sets the configuration and updates derived data. There will be
  42      * a short time during which read attempts will fail.
  43      *
  44      * @param aConfig
  45      *            Configuration to set.
  46      */
  47     void setRouterConfig(ExtendedRouterConfig aConfig);
  48 }