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 SummaryFieldsFields 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 voidSubclasses implement this method to perform any instance destruction required.final Stringprotected abstract StringMethod implemented by subclasses to identify the domain in which MBeans should be registered.final ObjectNameprotected abstract StringAllow subclasses to specify the key properties component of theObjectNamethat will be used to register this component.protected voidSubclasses implement this method to perform any instance initialisation required.final voidNot used - NOOP.final voidpostRegister(Boolean registrationDone) Not used - NOOP.final voidNot used - NOOP.final ObjectNamepreRegister(MBeanServer server, ObjectName name) protected final ObjectNameUtility method to enable subclasses 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 subclasses to easily unregister additional components that don't implementJmxEnabledwith an MBean server.protected final voidunregister(ObjectName on) Utility method to enable subclasses 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
- 
Field Details- 
mserverDeprecated.
 
- 
- 
Constructor Details- 
LifecycleMBeanBasepublic LifecycleMBeanBase()
 
- 
- 
Method Details- 
initInternalDescription copied from class:LifecycleBaseSubclasses implement this method to perform any instance initialisation required.- Specified by:
- initInternalin class- LifecycleBase
- Throws:
- LifecycleException- If the initialisation fails
 
- 
destroyInternalDescription copied from class:LifecycleBaseSubclasses implement this method to perform any instance destruction required.- Specified by:
- destroyInternalin class- LifecycleBase
- Throws:
- LifecycleException- If the destruction fails
 
- 
setDomainDescription copied from interface:JmxEnabledSpecify 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
 
- 
getDomain- Specified by:
- getDomainin interface- JmxEnabled
- Returns:
- the domain under which this component will be / has been registered.
 
- 
getDomainInternalMethod implemented by subclasses to identify the domain in which MBeans should be registered.- Returns:
- The name of the domain to use to register MBeans.
 
- 
getObjectName- Specified by:
- getObjectNamein interface- JmxEnabled
- Returns:
- the name under which this component has been registered with JMX.
 
- 
getObjectNameKeyPropertiesAllow subclasses 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 subclasses 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 subclasses 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 subclasses 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
 
- 
preRegister- Specified by:
- preRegisterin interface- MBeanRegistration
- Throws:
- Exception
 
 
-