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,ValveBase,WebappLoader
public abstract class LifecycleMBeanBase extends LifecycleBase implements JmxEnabled
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
-
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_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 Summary
Constructors Constructor Description LifecycleMBeanBase()
-
Method Summary
All 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.StringgetDomain()Obtain the domain under which this component will be / has been registered.protected abstract StringgetDomainInternal()Method implemented by sub-classes to identify the domain in which MBeans should be registered.ObjectNamegetObjectName()Obtain the name under which this component has been registered with JMX.protected abstract 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(Boolean registrationDone)Not used - NOOP.voidpreDeregister()Not used - NOOP.ObjectNamepreRegister(MBeanServer server, ObjectName name)Allows the object to be registered with an alternativeMBeanServerand/orObjectName.protected ObjectNameregister(Object obj, String objectNameKeyProperties)Utility method to enable sub-classes to easily register additional components that don't implementJmxEnabledwith an MBean server.voidsetDomain(String domain)Specify the domain under which this component should be registered.protected voidunregister(String objectNameKeyProperties)Utility method to enable sub-classes to easily unregister additional components that don't implementJmxEnabledwith an MBean server.protected 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.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, startInternal, stop, stopInternal
-
-
-
-
Method Detail
-
initInternal
protected 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 classLifecycleBase- Throws:
LifecycleException- If the initialisation fails
-
destroyInternal
protected 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 classLifecycleBase- Throws:
LifecycleException- If the destruction fails
-
setDomain
public final void setDomain(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 interfaceJmxEnabled- Parameters:
domain- The name of the domain under which this component should be registered
-
getDomain
public final String getDomain()
Obtain the domain under which this component will be / has been registered.- Specified by:
getDomainin interfaceJmxEnabled- Returns:
- the domain under which this component will be / has been registered.
-
getDomainInternal
protected abstract 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.
-
getObjectName
public final ObjectName getObjectName()
Obtain the name under which this component has been registered with JMX.- Specified by:
getObjectNamein interfaceJmxEnabled- Returns:
- the name under which this component has been registered with JMX.
-
getObjectNameKeyProperties
protected abstract 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
-
register
protected final ObjectName register(Object obj, 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 registerobjectNameKeyProperties- The key properties component of the object name to use to register the object- Returns:
- The name used to register the object
-
unregister
protected final void unregister(String objectNameKeyProperties)
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:
objectNameKeyProperties- The key properties component of the object name to use to unregister the object
-
unregister
protected final void unregister(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
-
postDeregister
public final void postDeregister()
Not used - NOOP.- Specified by:
postDeregisterin interfaceMBeanRegistration
-
postRegister
public final void postRegister(Boolean registrationDone)
Not used - NOOP.- Specified by:
postRegisterin interfaceMBeanRegistration
-
preDeregister
public final void preDeregister() throws ExceptionNot used - NOOP.- Specified by:
preDeregisterin interfaceMBeanRegistration- Throws:
Exception
-
preRegister
public final ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
Allows the object to be registered with an alternativeMBeanServerand/orObjectName.- Specified by:
preRegisterin interfaceMBeanRegistration- Throws:
Exception
-
-