com.sun.jbi.management.facade

Class ComponentLifeCycle

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.ComponentLifeCycle

All Implemented Interfaces:

ComponentLifeCycleMBean, LifeCycleMBean

public class ComponentLifeCycle
extends Facade
implements ComponentLifeCycleMBean

ComponentLifeCycleMBean defines the standard life cycle controls for JBI Installable Components.

• Initialize the component, preparing it to receive service requests.
• Start the component, allowing it to initiate service requests.
• Stop the component from initiating any more service requests.
• Shut down the component, returning it to the uninitialized state where it cannot receive service requests.
• Query the JMX object name of the extension MBean for the component.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.facade.Facade

CONFIG_SCHEMA_PATH, DOMAIN, MASKED_FIELD_VALUE, mComponentConfigSchema, mEnvCtx, mLog, mMBeanNames, mMBeanSvr, mMgtCtx, mMsgBuilder, mPlatform, mTarget, mTranslator, PASSWORD, SERVER, sTypeMap, WORKSPACE_ROOT

Fields inherited from interface javax.jbi.management.LifeCycleMBean

SHUTDOWN, STARTED, STOPPED, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ComponentLifeCycle(EnvironmentContext ctx, String target, String compName, ComponentType compType, Map<String,ObjectName> compLCMBeans)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCurrentState() Get the current state of the managed compononent on the target.
ObjectName	getExtensionMBeanName() Get the JMX ObjectName for the life cycle extension MBean for this component.
void	shutDown() Shut down the item.
void	shutDown(boolean force) Shut down this component.
void	start() Start the component.
void	stop() Stop the item.

Methods inherited from class com.sun.jbi.management.facade.Facade

archiveEqualityCheck, areAllInstancesUp, componentInstallationCheck, convertToString, fromFileURL, getAllTargets, getComponentConfigurationData, getComponentConfigurationNS, getComponentConfigurationSchema, getComponentLifeCycleMBeanName, getComponentQuery, getComponentQuery, getComponentState, getComponentStateOnInstance, getComponentType, getFacadeInstallerMBeanName, getFacadeInstallerMBeanName, getGenericQuery, getMBeanServerConnection, getRegistry, getRemoteAdminServiceObjectName, getRemoteAttribute, getRemoteAttributes, getServiceAssemblyQuery, getUpdater, handleClusteredInstanceFailures, initPrimitiveTypeMap, instanceRunningCheck, invokeLocalOperation, invokeRemoteOperation, invokeRemoteVoidOperation, isComponentInstalled, isInstanceRunning, isMBeanRegisteredOnInstance, isSharedLibraryInstalled, isTargetUp, mbeanRegistrationCheck, setRemoteAttribute, setRemoteAttributes, sharedLibraryInstallationCheck, throwNotSupportedManagementException, toFileURL, unregisterComponentConfigurationMBean, unregisterComponentConfigurationMBean, unregisterComponentExtensionMBean, unregisterComponentExtensionMBean, unregisterComponentLifeCycleMBean, unregisterComponentLifeCycleMBean, uploadFile, validateArchive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentLifeCycle

public ComponentLifeCycle(EnvironmentContext ctx,
                  String target,
                  String compName,
                  ComponentType compType,
                  Map<String,ObjectName> compLCMBeans)
                   throws ManagementException

Throws:

ManagementException

Method Detail

start

public void start()
           throws JBIException

Start the component.

Specified by:

start in interface LifeCycleMBean

Throws:

JBIException - if the item fails to start.

stop

public void stop()
          throws JBIException

Stop the item. This suspends current messaging activities.

Specified by:

stop in interface LifeCycleMBean

Throws:

JBIException - if the item fails to stop.

shutDown

public void shutDown()
              throws JBIException

Shut down the item. This releases resources and returns the item to an uninitialized state.

Specified by:

shutDown in interface LifeCycleMBean

Throws:

JBIException - if the item fails to shut down.

getCurrentState

public String getCurrentState()

Get the current state of the managed compononent on the target.

Specified by:

getCurrentState in interface LifeCycleMBean

Returns:

the current state of this managed component (must be one of the string constants defined by this interface)

getExtensionMBeanName

public ObjectName getExtensionMBeanName()
                                 throws JBIException

Get the JMX ObjectName for the life cycle extension MBean for this component. If there is none, return null. Note that this MBean may serve as a container for multiple MBeans, as required by the component implementation.

Specified by:

getExtensionMBeanName in interface ComponentLifeCycleMBean

Returns:

ObjectName the JMX object name of the additional MBean or null if there is no additional MBean.

Throws:

JBIException - if there is a failure getting component information for the component to which this life cycle applies.

shutDown

public void shutDown(boolean force)
              throws JBIException

Shut down this component.

Parameters:

force - set to true indicates that the component should be shutdown forcefully; that is, place the component in the "Shutdown" state regardless of the result of calling its LifeCycle shutDown method.

Throws:

JBIException - if some other failure occurs.