Package org.apache.catalina.util
Class LifecycleMBeanBase
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
- All Implemented Interfaces:
- MBeanRegistration,- JmxEnabled,- Lifecycle
- Direct Known Subclasses:
- Connector,- ContainerBase,- FailedContext,- ManagerBase,- MapperListener,- NamingResourcesImpl,- RealmBase,- SimpleTcpCluster,- StandardRoot,- StandardServer,- StandardService,- StandardThreadExecutor,- StandardVirtualThreadExecutor,- ValveBase,- WebappLoader
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.final StringObtain the domain under which this component will be / has been registered.protected abstract StringMethod implemented by sub-classes to identify the domain in which MBeans should be registered.final ObjectNameObtain the name under which this component has been registered with JMX.protected abstract StringAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.protected voidSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.final voidNot used - NOOP.final voidpostRegister(Boolean registrationDone) Not used - NOOP.final voidNot used - NOOP.final ObjectNamepreRegister(MBeanServer server, ObjectName name) Allows the object to be registered with an alternativeMBeanServerand/orObjectName.protected final ObjectNameUtility method to enable sub-classes to easily register additional components that don't implementJmxEnabledwith an MBean server.final voidSpecify the domain under which this component should be registered.protected final voidunregister(String objectNameKeyProperties) Utility method to enable sub-classes to easily unregister additional components that don't implementJmxEnabledwith an MBean server.protected final voidunregister(ObjectName on) Utility method to enable sub-classes to easily unregister additional components that don't implementJmxEnabledwith an MBean server.Methods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, startInternal, stop, stopInternal
- 
Constructor Details- 
LifecycleMBeanBasepublic LifecycleMBeanBase()
 
- 
- 
Method Details- 
initInternalSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Specified by:
- initInternalin class- LifecycleBase
- Throws:
- LifecycleException- If the initialisation fails
 
- 
destroyInternalSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.- Specified by:
- destroyInternalin class- LifecycleBase
- Throws:
- LifecycleException- If the destruction fails
 
- 
setDomainSpecify the domain under which this component should be registered. Used with components that cannot (easily) navigate the component hierarchy to determine the correct domain to use.- Specified by:
- setDomainin interface- JmxEnabled
- Parameters:
- domain- The name of the domain under which this component should be registered
 
- 
getDomainObtain the domain under which this component will be / has been registered.- Specified by:
- getDomainin interface- JmxEnabled
- Returns:
- the domain under which this component will be / has been registered.
 
- 
getDomainInternalMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Returns:
- The name of the domain to use to register MBeans.
 
- 
getObjectNameObtain the name under which this component has been registered with JMX.- Specified by:
- getObjectNamein interface- JmxEnabled
- Returns:
- the name under which this component has been registered with JMX.
 
- 
getObjectNameKeyPropertiesAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Returns:
- The string representation of the key properties component of the
          desired ObjectName
 
- 
registerUtility method to enable sub-classes to easily register additional components that don't implementJmxEnabledwith an MBean server.
 Note: This method should only be used onceinitInternal()has been called and beforedestroyInternal()has been called.- Parameters:
- obj- The object the register
- objectNameKeyProperties- The key properties component of the object name to use to register the object
- Returns:
- The name used to register the object
 
- 
unregisterUtility method to enable sub-classes to easily unregister additional components that don't implementJmxEnabledwith an MBean server.
 Note: This method should only be used onceinitInternal()has been called and beforedestroyInternal()has been called.- Parameters:
- objectNameKeyProperties- The key properties component of the object name to use to unregister the object
 
- 
unregisterUtility method to enable sub-classes to easily unregister additional components that don't implementJmxEnabledwith an MBean server.
 Note: This method should only be used onceinitInternal()has been called and beforedestroyInternal()has been called.- Parameters:
- on- The name of the component to unregister
 
- 
postDeregisterpublic final void postDeregister()Not used - NOOP.- Specified by:
- postDeregisterin interface- MBeanRegistration
 
- 
postRegisterNot used - NOOP.- Specified by:
- postRegisterin interface- MBeanRegistration
 
- 
preDeregisterNot used - NOOP.- Specified by:
- preDeregisterin interface- MBeanRegistration
- Throws:
- Exception
 
- 
preRegisterAllows the object to be registered with an alternativeMBeanServerand/orObjectName.- Specified by:
- preRegisterin interface- MBeanRegistration
- Throws:
- Exception
 
 
-