wamblee.org Git - xmlrouter/blob - config/src/main/java/org/wamblee/xmlrouter/config/RouterConfigService.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 import org.wamblee.xmlrouter.common.Id;
  19
  20 /**
  21  * Router configuration service that provides atomic configuration of the
  22  * router. This is the entry point for configuring the router.
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public interface RouterConfigService {
  27
  28     // TODO must deal with conflicts with ids provided by applications and those
  29     // used by the xmlrouter internally.
  30
  31     /**
  32      * @return New empty configuration.
  33      */
  34     RouterConfig emptyConfig(String aId);
  35
  36     /**
  37      * Applies a given configuration.
  38      *
  39      * @param aConfig
  40      *            Configuration to use.
  41      * @param aOldConfig
  42      *            Id of the configuration to replace or null if this is a new
  43      *            configuration.
  44      * @return Id of the applied configuration.
  45      */
  46     void apply(RouterConfig aConfig, Id<RouterConfig> aOldConfig);
  47
  48     /**
  49      * Clears the configuration for a given id.
  50      *
  51      * @param aConfig
  52      *            Configuration id.
  53      */
  54     void clear(Id<RouterConfig> aConfig);
  55 }