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    
018    package org.apache.geronimo.gbean;
019    
020    import java.util.Properties;
021    
022    
023    /**
024     * An optional interface for a GBean.  When a GBean implements this interface, the implementation
025     * will get life-cycle callbacks.
026     *
027     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
028     */
029    public interface GBeanLifecycle {
030        /**
031         * Starts the GBean.  This informs the GBean that it is about to transition to the running state.
032         *
033         * @throws Exception if the target failed to start; this will cause a transition to the failed state
034         */
035        void doStart() throws Exception;
036    
037        /**
038         * Stops the target.  This informs the GBean that it is about to transition to the stopped state.
039         *
040         * @throws Exception if the target failed to stop; this will cause a transition to the failed state
041         */
042        void doStop() throws Exception;
043    
044        /**
045         * Fails the GBean.  This informs the GBean that it is about to transition to the failed state.
046         */
047        void doFail();
048    }