/*
 * Copyright 2005-2011 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wamblee.xmlrouter.config;

import org.wamblee.xmlrouter.common.Id;

/**
 * Router configuration service that provides atomic configuration of the
 * router. This is the entry point for configuring the router.
 * 
 * @author Erik Brakkee
 */
public interface RouterConfigService {

    // TODO must deal with conflicts with ids provided by applications and those
    // used by the xmlrouter internally.

    /**
     * @return New empty configuration.
     */
    RouterConfig emptyConfig(String aId);

    /**
     * Applies a given configuration.
     * 
     * @param aConfig
     *            Configuration to use.
     * @param aOldConfig
     *            Id of the configuration to replace or null if this is a new
     *            configuration.
     * @return Id of the applied configuration.
     */
    void apply(RouterConfig aConfig, Id<RouterConfig> aOldConfig);

    /**
     * Clears the configuration for a given id.
     * 
     * @param aConfig
     *            Configuration id.
     */
    void clear(Id<RouterConfig> aConfig);
}