01: /*
02: * BEGIN_HEADER - DO NOT EDIT
03: *
04: * The contents of this file are subject to the terms
05: * of the Common Development and Distribution License
06: * (the "License"). You may not use this file except
07: * in compliance with the License.
08: *
09: * You can obtain a copy of the license at
10: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
11: * See the License for the specific language governing
12: * permissions and limitations under the License.
13: *
14: * When distributing Covered Code, include this CDDL
15: * HEADER in each file and include the License file at
16: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
17: * If applicable add the following below this CDDL HEADER,
18: * with the fields enclosed by brackets "[]" replaced with
19: * your own identifying information: Portions Copyright
20: * [year] [name of copyright owner]
21: */
22:
23: /*
24: * @(#)ComponentLifeCycleMBean.java
25: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
26: *
27: * END_HEADER - DO NOT EDIT
28: */
29: package javax.jbi.management;
30:
31: import javax.jbi.management.LifeCycleMBean;
32:
33: import javax.management.ObjectName;
34:
35: /**
36: * ComponentLifeCycleMBean defines the standard life cycle controls for
37: * JBI Installable Components.
38: * <ul>
39: * <li>Initialize the component, preparing it to receive service requests.</li>
40: * <li>Start the component, allowing it to initiate service requests.</li>
41: * <li>Stop the component from initiating any more service requests.</li>
42: * <li>Shut down the component, returning it to the uninitialized state
43: * where it cannot receive service requests.</li>
44: * <li>Query the JMX object name of the extension MBean for the component.</li>
45: * </ul>
46: *
47: * @author JSR208 Expert Group
48: */
49: public interface ComponentLifeCycleMBean extends LifeCycleMBean {
50: /**
51: * Get the JMX ObjectName for the life cycle extension MBean for this
52: * component. If there is none, return <code>null</code>.
53: * Note that this MBean may serve as a container for multiple MBeans,
54: * as required by the component implementation.
55: *
56: * @return ObjectName the JMX object name of the additional MBean
57: * or <code>null</code> if there is no additional MBean.
58: * @exception javax.jbi.JBIException if there is a failure getting component
59: * information for the component to which this life cycle
60: * applies.
61: */
62: ObjectName getExtensionMBeanName() throws javax.jbi.JBIException;
63: }
|