Home » geronimo-2.2-source-release » org.apache.geronimo.gbean » [javadoc | source]

    1   /**
    2    *  Licensed to the Apache Software Foundation (ASF) under one or more
    3    *  contributor license agreements.  See the NOTICE file distributed with
    4    *  this work for additional information regarding copyright ownership.
    5    *  The ASF licenses this file to You under the Apache License, Version 2.0
    6    *  (the "License"); you may not use this file except in compliance with
    7    *  the License.  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    *  Unless required by applicable law or agreed to in writing, software
   12    *  distributed under the License is distributed on an "AS IS" BASIS,
   13    *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    *  See the License for the specific language governing permissions and
   15    *  limitations under the License.
   16    */
   17   
   18   package org.apache.geronimo.gbean;
   19   
   20   import java.util.Properties;
   21   
   22   
   23   /**
   24    * An optional interface for a GBean.  When a GBean implements this interface, the implementation
   25    * will get life-cycle callbacks.
   26    *
   27    * @version $Rev: 573120 $ $Date: 2007-09-05 17:30:21 -0700 (Wed, 05 Sep 2007) $
   28    */
   29   public interface GBeanLifecycle {
   30       /**
   31        * Starts the GBean.  This informs the GBean that it is about to transition to the running state.
   32        *
   33        * @throws Exception if the target failed to start; this will cause a transition to the failed state
   34        */
   35       void doStart() throws Exception;
   36   
   37       /**
   38        * Stops the target.  This informs the GBean that it is about to transition to the stopped state.
   39        *
   40        * @throws Exception if the target failed to stop; this will cause a transition to the failed state
   41        */
   42       void doStop() throws Exception;
   43   
   44       /**
   45        * Fails the GBean.  This informs the GBean that it is about to transition to the failed state.
   46        */
   47       void doFail();
   48   }

Home » geronimo-2.2-source-release » org.apache.geronimo.gbean » [javadoc | source]