001    /**
002     *
003     * Copyright 2003-2004 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  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    
021    /**
022     * An optional interface for a GBean.  When a GBean implements this interface, the implementation
023     * will get life-cycle callbacks.
024     *
025     * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
026     */
027    public interface GBeanLifecycle {
028        /**
029         * Starts the GBean.  This informs the GBean that it is about to transition to the running state.
030         *
031         * @throws Exception if the target failed to start; this will cause a transition to the failed state
032         */
033        void doStart() throws Exception;
034    
035        /**
036         * Stops the target.  This informs the GBean that it is about to transition to the stopped state.
037         *
038         * @throws Exception if the target failed to stop; this will cause a transition to the failed state
039         */
040        void doStop() throws Exception;
041    
042        /**
043         * Fails the GBean.  This informs the GBean that it is about to transition to the failed state.
044         */
045        void doFail();
046    }