Tomcat 10.1.19 · org.apache.catalina.util.LifecycleMBeanBase

Modifier and Type	Field and Description
private String	domain
private static final Log	log Hides org.apache.catalina.util.LifecycleBase.log.
private ObjectName	oname
private static final StringManager	sm Hides org.apache.catalina.util.LifecycleBase.sm.

Access	Constructor and Description
public	LifecycleMBeanBase()

Method Summary

Modifier and Type	Method and Description
protected void	destroyInternal() Implements abstract org.apache.catalina.util.LifecycleBase.destroyInternal. Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
public final String	getDomain() Implements org.apache.catalina.JmxEnabled.getDomain. Obtain the domain under which this component will be / has been registered.
protected abstract String	Returns: The name of the domain to use to register MBeans. getDomainInternal() Method implemented by sub-classes to identify the domain in which MBeans should be registered.
public final ObjectName	getObjectName() Implements org.apache.catalina.JmxEnabled.getObjectName. Obtain the name under which this component has been registered with JMX.
protected abstract String	Returns: The string representation of the key properties component of the desired `ObjectName` getObjectNameKeyProperties() Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component.
protected void	initInternal() Implements abstract org.apache.catalina.util.LifecycleBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
public final void	postDeregister() Implements javax.management.MBeanRegistration.postDeregister. Not used - NOOP.
public final void	postRegister(Boolean Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed. registrationDone) Implements javax.management.MBeanRegistration.postRegister. Not used - NOOP.
public final void	preDeregister() Implements javax.management.MBeanRegistration.preDeregister. Not used - NOOP.
public final ObjectName	preRegister(MBeanServer The MBean Server in which the MBean will be registered. server, ObjectName The object name of the MBean. This name is null if the name parameter to one of the `createMBean` or `registerMBean` methods in the `MBeanServer` interface is null. In that case, this method must return a non-null ObjectName for the new MBean. name) Implements javax.management.MBeanRegistration.preRegister. Allows the object to be registered with an alternative `MBeanServer` and/or `ObjectName`.
protected final ObjectName	Returns: The name used to register the object register(Object The object the register obj, String The key properties component of the object name to use to register the object objectNameKeyProperties) Utility method to enable sub-classes to easily register additional components that don't implement `JmxEnabled` with an MBean server.
public final void	setDomain(String The name of the domain under which this component should be registered domain) Implements org.apache.catalina.JmxEnabled.setDomain. Specify the domain under which this component should be registered.
protected final void	unregister(String The key properties component of the object name to use to unregister the object objectNameKeyProperties) Utility method to enable sub-classes to easily unregister additional components that don't implement `JmxEnabled` with an MBean server.
protected final void	unregister(ObjectName The name of the component to unregister on) Utility method to enable sub-classes to easily unregister additional components that don't implement `JmxEnabled` with an MBean server.

Inherited from org.apache.catalina.util.LifecycleBase:: addLifecycleListener destroy findLifecycleListeners fireLifecycleEvent getState getStateName getThrowOnFailure init removeLifecycleListener setState setState setThrowOnFailure start startInternal stop stopInternal

domain	back to summary
private String domain

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleBase.log.

oname	back to summary
private ObjectName oname

sm	back to summary
private static final StringManager sm Hides org.apache.catalina.util.LifecycleBase.sm.

LifecycleMBeanBase	back to summary
public LifecycleMBeanBase()

Method Detail

destroyInternal	back to summary
protected void destroyInternal() throws LifecycleException Implements abstract org.apache.catalina.util.LifecycleBase.destroyInternal. Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.destroyInternal. If the destruction fails

destroyInternal

back to summary

protected void destroyInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.destroyInternal.

Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.destroyInternal.

If the destruction fails

getDomain	back to summary
public final String getDomain() Implements org.apache.catalina.JmxEnabled.getDomain. Obtain the domain under which this component will be / has been registered. Returns:String Doc from org.apache.catalina.JmxEnabled.getDomain. the domain under which this component will be / has been registered. Annotations @Override

getDomain

back to summary

public final String getDomain()

Implements org.apache.catalina.JmxEnabled.getDomain.

Obtain the domain under which this component will be / has been registered.

Returns:String

Doc from org.apache.catalina.JmxEnabled.getDomain.

the domain under which this component will be / has been registered.

Annotations

@Override

getDomainInternal	back to summary
protected abstract String getDomainInternal() Method implemented by sub-classes to identify the domain in which MBeans should be registered. Returns:String The name of the domain to use to register MBeans.

getDomainInternal

back to summary

protected abstract String getDomainInternal()

Method implemented by sub-classes to identify the domain in which MBeans should be registered.

Returns:String: The name of the domain to use to register MBeans.

getObjectName	back to summary
public final ObjectName getObjectName() Implements org.apache.catalina.JmxEnabled.getObjectName. Obtain the name under which this component has been registered with JMX. Returns:ObjectName Doc from org.apache.catalina.JmxEnabled.getObjectName. the name under which this component has been registered with JMX. Annotations @Override

getObjectName

back to summary

public final ObjectName getObjectName()

Implements org.apache.catalina.JmxEnabled.getObjectName.

Obtain the name under which this component has been registered with JMX.

Returns:ObjectName

Doc from org.apache.catalina.JmxEnabled.getObjectName.

the name under which this component has been registered with JMX.

Annotations

@Override

getObjectNameKeyProperties back to summary

getObjectNameKeyProperties	back to summary
protected abstract String getObjectNameKeyProperties() Allow sub-classes to specify the key properties component of the `ObjectName` that will be used to register this component. Returns:String The string representation of the key properties component of the desired `ObjectName`

protected abstract String getObjectNameKeyProperties()

Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.

Returns:String: The string representation of the key properties component of the desired ObjectName

initInternal	back to summary
protected void initInternal() throws LifecycleException Implements abstract org.apache.catalina.util.LifecycleBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.initInternal. If the initialisation fails

initInternal

back to summary

protected void initInternal() throws LifecycleException

Implements abstract org.apache.catalina.util.LifecycleBase.initInternal.

Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.initInternal.

If the initialisation fails

postDeregister	back to summary
public final void postDeregister() Implements javax.management.MBeanRegistration.postDeregister. Not used - NOOP. Annotations @Override

postDeregister

back to summary

public final void postDeregister()

Implements javax.management.MBeanRegistration.postDeregister.

Not used - NOOP.

Annotations

@Override

postRegister	back to summary
public final void postRegister(Boolean registrationDone) Implements javax.management.MBeanRegistration.postRegister. Not used - NOOP. Parameters registrationDone:Boolean Doc from javax.management.MBeanRegistration.postRegister. Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed. Annotations @Override

postRegister

back to summary

public final void postRegister(Boolean registrationDone)

Implements javax.management.MBeanRegistration.postRegister.

Not used - NOOP.

Parameters

registrationDone:Boolean

Doc from javax.management.MBeanRegistration.postRegister.

Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed.

Annotations

@Override

preDeregister back to summary

preDeregister	back to summary
public final void preDeregister() throws Exception Implements javax.management.MBeanRegistration.preDeregister. Not used - NOOP. Annotations @Override Exceptions Exception: Doc from javax.management.MBeanRegistration.preDeregister. This exception will be caught by the MBean server and re-thrown as an `MBeanRegistrationException`.

public final void preDeregister() throws Exception

Implements javax.management.MBeanRegistration.preDeregister.

Not used - NOOP.

Annotations

@Override

Exceptions

Exception:

Doc from javax.management.MBeanRegistration.preDeregister.

This exception will be caught by the MBean server and re-thrown as an MBeanRegistrationException.

preRegister back to summary

preRegister	back to summary
public final ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception Implements javax.management.MBeanRegistration.preRegister. Allows the object to be registered with an alternative `MBeanServer` and/or `ObjectName`. Parameters server:MBeanServer Doc from javax.management.MBeanRegistration.preRegister. The MBean Server in which the MBean will be registered. name:ObjectName Doc from javax.management.MBeanRegistration.preRegister. The object name of the MBean. This name is null if the name parameter to one of the `createMBean` or `registerMBean` methods in the `MBeanServer` interface is null. In that case, this method must return a non-null ObjectName for the new MBean. Returns:ObjectName Doc from javax.management.MBeanRegistration.preRegister. The name under which the MBean is to be registered. This value must not be null. If the `name` parameter is not null, it will usually but not necessarily be the returned value. Annotations @Override Exceptions Exception: Doc from javax.management.MBeanRegistration.preRegister. This exception will be caught by the MBean Server and re-thrown as an `MBeanRegistrationException`.

public final ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception

Implements javax.management.MBeanRegistration.preRegister.

Allows the object to be registered with an alternative MBeanServer and/or ObjectName.

Parameters

server:MBeanServer

Doc from javax.management.MBeanRegistration.preRegister.

The MBean Server in which the MBean will be registered.

name:ObjectName

Doc from javax.management.MBeanRegistration.preRegister.

The object name of the MBean. This name is null if the name parameter to one of the createMBean or registerMBean methods in the MBeanServer interface is null. In that case, this method must return a non-null ObjectName for the new MBean.

Returns:ObjectName

Doc from javax.management.MBeanRegistration.preRegister.

The name under which the MBean is to be registered. This value must not be null. If the name parameter is not null, it will usually but not necessarily be the returned value.

Annotations

@Override

Exceptions

Exception:

Doc from javax.management.MBeanRegistration.preRegister.

This exception will be caught by the MBean Server and re-thrown as an MBeanRegistrationException.

register	back to summary
protected final ObjectName register(Object obj, String objectNameKeyProperties) Utility method to enable sub-classes to easily register additional components that don't implement `JmxEnabled` with an MBean server. Note This method should only be used once `initInternal()` has been called and before `destroyInternal()` has been called. Parameters obj:Object The object the register objectNameKeyProperties:String The key properties component of the object name to use to register the object Returns:ObjectName The name used to register the object

protected final ObjectName register(Object obj, String objectNameKeyProperties)

Utility method to enable sub-classes to easily register additional components that don't implement JmxEnabled with an MBean server.

Note

This method should only be used once initInternal() has been called and before destroyInternal() has been called.

Parameters

obj:Object: The object the register
objectNameKeyProperties:String: The key properties component of the object name to use to register the object

Returns:ObjectName

The name used to register the object

setDomain	back to summary
public final void setDomain(String domain) Implements org.apache.catalina.JmxEnabled.setDomain. 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. Parameters domain:String Doc from org.apache.catalina.JmxEnabled.setDomain. The name of the domain under which this component should be registered Annotations @Override

setDomain

back to summary

public final void setDomain(String domain)

Implements org.apache.catalina.JmxEnabled.setDomain.

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.

Parameters

domain:String

Doc from org.apache.catalina.JmxEnabled.setDomain.

The name of the domain under which this component should be registered

Annotations

@Override

unregister back to summary

unregister	back to summary
protected final void unregister(String objectNameKeyProperties) Utility method to enable sub-classes to easily unregister additional components that don't implement `JmxEnabled` with an MBean server. Note This method should only be used once `initInternal()` has been called and before `destroyInternal()` has been called. Parameters objectNameKeyProperties:String The key properties component of the object name to use to unregister the object

protected final void unregister(String objectNameKeyProperties)

Utility method to enable sub-classes to easily unregister additional components that don't implement JmxEnabled with an MBean server.

Note

This method should only be used once initInternal() has been called and before destroyInternal() has been called.

Parameters

objectNameKeyProperties:String: The key properties component of the object name to use to unregister the object

unregister back to summary

unregister	back to summary
protected final void unregister(ObjectName on) Utility method to enable sub-classes to easily unregister additional components that don't implement `JmxEnabled` with an MBean server. Note This method should only be used once `initInternal()` has been called and before `destroyInternal()` has been called. Parameters on:ObjectName The name of the component to unregister

protected final void unregister(ObjectName on)

Utility method to enable sub-classes to easily unregister additional components that don't implement JmxEnabled with an MBean server.

Note

This method should only be used once initInternal() has been called and before destroyInternal() has been called.

Parameters

on:ObjectName: The name of the component to unregister

public abstract Class LifecycleMBeanBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail