01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: */package org.apache.geronimo.gbean;
17:
18: import java.util.Properties;
19:
20: /**
21: * An optional interface for a GBean. When a GBean implements this interface, the implementation
22: * will get life-cycle callbacks.
23: *
24: * @version $Rev: 573120 $ $Date: 2007-09-05 17:30:21 -0700 (Wed, 05 Sep 2007) $
25: */
26: public interface GBeanLifecycle {
27: /**
28: * Starts the GBean. This informs the GBean that it is about to transition to the running state.
29: *
30: * @throws Exception if the target failed to start; this will cause a transition to the failed state
31: */
32: void doStart() throws Exception;
33:
34: /**
35: * Stops the target. This informs the GBean that it is about to transition to the stopped state.
36: *
37: * @throws Exception if the target failed to stop; this will cause a transition to the failed state
38: */
39: void doStop() throws Exception;
40:
41: /**
42: * Fails the GBean. This informs the GBean that it is about to transition to the failed state.
43: */
44: void doFail();
45: }
|