001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.kernel.config;
018    
019    import org.apache.geronimo.gbean.AbstractName;
020    import org.apache.geronimo.gbean.GBeanData;
021    import org.apache.geronimo.kernel.GBeanNotFoundException;
022    import org.apache.geronimo.kernel.repository.Artifact;
023    
024    /**
025     * A specialized ConfigurationManager that can change the set of GBeans
026     * included in the configuration at runtime.
027     *
028     * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
029     */
030    public interface EditableConfigurationManager extends ConfigurationManager {
031        /**
032         * Adds a new GBean to an existing Configuration.
033         * @param configID  The configuration to add the GBean to.
034         * @param gbean     The data representing the GBean to add.
035         * @param start     If true, the GBean should be started as part of this call.
036         */
037        void addGBeanToConfiguration(Artifact configID, GBeanData gbean, boolean start) throws InvalidConfigException;
038    
039        /**
040         * Adds a new GBean to an existing Configuration.
041         * @param configID  The configuration to add the GBean to.
042         * @param name      The short name for the new GBean.
043         * @param gbean     The data representing the GBean to add. This must not have an abstract name set.
044         * @param start     If true, the GBean should be started as part of this call.
045         */
046        void addGBeanToConfiguration(Artifact configID, String name, GBeanData gbean, boolean start) throws InvalidConfigException;
047    
048        /**
049         * Removes a GBean from a configuration.  Note: this may simply mark it to
050         * not be loaded in the future, as opposed to actually removing it from
051         * the data in the config store.
052         * @param configID  The configuration to remove the GBean from.
053         * @param gbean     The ObjectName of the GBean to remove.
054         */
055        void removeGBeanFromConfiguration(Artifact configID, AbstractName gbean) throws InvalidConfigException, GBeanNotFoundException;
056    }