Package org.apache.catalina.util
Class LifecycleMBeanBase
- java.lang.Object
- 
- org.apache.catalina.util.LifecycleBase
- 
- org.apache.catalina.util.LifecycleMBeanBase
 
 
- 
- All Implemented Interfaces:
- javax.management.MBeanRegistration,- JmxEnabled,- Lifecycle
 - Direct Known Subclasses:
- Connector,- ContainerBase,- FailedContext,- ManagerBase,- MapperListener,- NamingResourcesImpl,- RealmBase,- SimpleTcpCluster,- StandardRoot,- StandardServer,- StandardService,- StandardThreadExecutor,- ValveBase,- WebappLoader
 
 public abstract class LifecycleMBeanBase extends LifecycleBase implements JmxEnabled 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected javax.management.MBeanServermserver- 
Fields 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 Constructor Description LifecycleMBeanBase()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voiddestroyInternal()Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.java.lang.StringgetDomain()Obtain the domain under which this component will be / has been registered.protected abstract java.lang.StringgetDomainInternal()Method implemented by sub-classes to identify the domain in which MBeans should be registered.javax.management.ObjectNamegetObjectName()Obtain the name under which this component has been registered with JMX.protected abstract java.lang.StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.protected voidinitInternal()Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.voidpostDeregister()Not used - NOOP.voidpostRegister(java.lang.Boolean registrationDone)Not used - NOOP.voidpreDeregister()Not used - NOOP.javax.management.ObjectNamepreRegister(javax.management.MBeanServer server, javax.management.ObjectName name)Allows the object to be registered with an alternativeMBeanServerand/orObjectName.protected javax.management.ObjectNameregister(java.lang.Object obj, java.lang.String objectNameKeyProperties)Utility method to enable sub-classes to easily register additional components that don't implementJmxEnabledwith an MBean server.voidsetDomain(java.lang.String domain)Specify the domain under which this component should be registered.protected voidunregister(javax.management.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
 
- 
 
- 
- 
- 
Method Detail- 
initInternalprotected void initInternal() throws LifecycleExceptionSub-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
 
 - 
destroyInternalprotected void destroyInternal() throws LifecycleExceptionSub-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
 
 - 
setDomainpublic final void setDomain(java.lang.String domain) Specify 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
 
 - 
getDomainpublic final java.lang.String getDomain() Obtain 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.
 
 - 
getDomainInternalprotected abstract java.lang.String getDomainInternal() Method 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.
 
 - 
getObjectNamepublic final javax.management.ObjectName getObjectName() Obtain 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.
 
 - 
getObjectNameKeyPropertiesprotected abstract java.lang.String getObjectNameKeyProperties() Allow 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
 
 - 
registerprotected final javax.management.ObjectName register(java.lang.Object obj, java.lang.String objectNameKeyProperties)Utility 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
 
 - 
unregisterprotected final void unregister(javax.management.ObjectName on) Utility 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- javax.management.MBeanRegistration
 
 - 
postRegisterpublic final void postRegister(java.lang.Boolean registrationDone) Not used - NOOP.- Specified by:
- postRegisterin interface- javax.management.MBeanRegistration
 
 - 
preDeregisterpublic final void preDeregister() throws java.lang.ExceptionNot used - NOOP.- Specified by:
- preDeregisterin interface- javax.management.MBeanRegistration
- Throws:
- java.lang.Exception
 
 - 
preRegisterpublic final javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) throws java.lang.ExceptionAllows the object to be registered with an alternativeMBeanServerand/orObjectName.- Specified by:
- preRegisterin interface- javax.management.MBeanRegistration
- Throws:
- java.lang.Exception
 
 
- 
 
-