KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > gbean > GBeanLifecycle


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
21 /**
22  * An optional interface for a GBean. When a GBean implements this interface, the implementation
23  * will get life-cycle callbacks.
24  *
25  * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
26  */
27 public interface GBeanLifecycle {
28     /**
29      * Starts the GBean. This informs the GBean that it is about to transition to the running state.
30      *
31      * @throws Exception if the target failed to start; this will cause a transition to the failed state
32      */
33     void doStart() throws Exception JavaDoc;
34
35     /**
36      * Stops the target. This informs the GBean that it is about to transition to the stopped state.
37      *
38      * @throws Exception if the target failed to stop; this will cause a transition to the failed state
39      */
40     void doStop() throws Exception JavaDoc;
41
42     /**
43      * Fails the GBean. This informs the GBean that it is about to transition to the failed state.
44      */
45     void doFail();
46 }
47
Popular Tags