Tomcat 10.1.19 · org.apache.tomcat.util.modeler.Registry

Modifier and Type	Field and Description
private Map<String, ManagedBean>	descriptors The set of ManagedBean instances for the beans this registry knows about, keyed by name.
private Map<String, ManagedBean>	descriptorsByClass List of managed beans, keyed by class name
private Object	guard
private final Hashtable<String, Hashtable<String, Integer>>	idDomains
private final Hashtable<String, int[]>	ids
private static final Log	log The Log instance to which we will write our log messages.
private static Registry	registry The registry instance created by our factory method the first time it is called.
private Map<String, URL>	searchedPaths
private volatile MBeanServer	server The `MBeanServer` instance that we will use to register management beans.
private final Object	serverLock
private static final StringManager	sm

Access	Constructor and Description
protected	Registry()

Method Summary

Modifier and Type	Method and Description
public void	addManagedBean(ManagedBean The managed bean to be added bean) Add a new bean metadata to the set of beans known to this registry.
public Object	Returns: Converted value convertValue(String Fully qualified class name of the resulting value type, String String value to be converted value) Convert a string to object, based on type.
public static synchronized void	disableRegistry()
private void	findDescriptor(Class<?> beanClass, String type) Lookup the component descriptor in the package and in the parent packages.
public ManagedBean	Returns: the managed bean findManagedBean(String Name of the managed bean to be returned. Since 1.1, both short names or the full name of the class can be used. name) Find and return the managed bean definition for the specified bean name, if any; otherwise return `null`.
public ManagedBean	Returns: the managed bean findManagedBean(Object The bean bean, Class<?> The bean class beanClass, String The registry type type) Find or load metadata.
public synchronized int	Returns: A unique id for the domain:name combination getId(String Namespace domain, String Type of the notification name) Implements org.apache.tomcat.util.modeler.RegistryMBean.getId. Return an int ID for faster access.
public MBeanServer	Returns: the MBean server getMBeanServer() Factory method to create (if necessary) and return our `MBeanServer` instance.
public MBeanOperationInfo	Returns: the operation info for the specified operation getMethodInfo(ObjectName The bean name oname, String The operation name opName) Find the operation info for a method
public MBeanOperationInfo	Returns: the operation info for the specified operation getMethodInfo(ObjectName The bean name oname, String The operation name opName, int The number of arguments to the method argCount) Find the operation info for a method.
private ModelerSource	getModelerSource(String type)
public static synchronized Registry	Returns: the registry getRegistry(Object Unused key, Object Prevent access to the registry by untrusted components guard) Factory method to create (if necessary) and return our `Registry` instance.
public String	Returns: null if metadata about the attribute is not found getType(ObjectName The bean name oname, String The attribute name attName) Get the type of an attribute of the object, from the metadata.
public void	invoke(List<ObjectName> list of ObjectName on which we'll invoke the operations mbeans, String Name of the operation ( init, start, stop, etc) operation, boolean If false, exceptions will be ignored failFirst) Implements org.apache.tomcat.util.modeler.RegistryMBean.invoke. Invoke a operation on a list of mbeans.
public List<ObjectName>	Returns: List of descriptors load(String The source type sourceType, Object The bean source, String A type to load param) Load descriptors.
public void	loadDescriptors(String The package name packageName, ClassLoader The class loader classLoader) Lookup the component descriptor in the package and in the parent packages.
public void	postDeregister() Implements javax.management.MBeanRegistration.postDeregister. Allows the MBean to perform any operations needed after having been unregistered in the MBean server.
public 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. Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
public void	preDeregister() Implements javax.management.MBeanRegistration.preDeregister. Allows the MBean to perform any operations it needs before being unregistered by the MBean server.
public 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 MBean to perform any operations it needs before being registered in the MBean Server.
public void	registerComponent(Object Object to be registered bean, String Name used for registration oname, String The type of the mbean, as declared in mbeans-descriptors. If null, the name of the class will be used. This can be used as a hint or by subclasses. type) Implements org.apache.tomcat.util.modeler.RegistryMBean.registerComponent. Register a bean by creating a modeler mbean and adding it to the MBeanServer.
public void	registerComponent(Object The bean bean, ObjectName The object name oname, String The registry type type) Register a component
public void	stop() Implements org.apache.tomcat.util.modeler.RegistryMBean.stop. Lifecycle method - clean up the registry metadata.
public void	unregisterComponent(String Name used for unregistration oname) Implements org.apache.tomcat.util.modeler.RegistryMBean.unregisterComponent. Unregister a component.
public void	unregisterComponent(ObjectName The bean name oname) Unregister a component.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

descriptors	back to summary
private Map<String, ManagedBean> descriptors The set of ManagedBean instances for the beans this registry knows about, keyed by name.

descriptorsByClass	back to summary
private Map<String, ManagedBean> descriptorsByClass List of managed beans, keyed by class name

guard	back to summary
private Object guard

idDomains	back to summary
private final Hashtable<String, Hashtable<String, Integer>> idDomains

ids	back to summary
private final Hashtable<String, int[]> ids

log	back to summary
private static final Log log The Log instance to which we will write our log messages.

registry	back to summary
private static Registry registry The registry instance created by our factory method the first time it is called.

searchedPaths	back to summary
private Map<String, URL> searchedPaths

server	back to summary
private volatile MBeanServer server The `MBeanServer` instance that we will use to register management beans.

serverLock	back to summary
private final Object serverLock

sm	back to summary
private static final StringManager sm

Registry	back to summary
protected Registry()

Method Detail

addManagedBean	back to summary
public void addManagedBean(ManagedBean bean) Add a new bean metadata to the set of beans known to this registry. This is used by internal components. Parameters bean:ManagedBean The managed bean to be added Since 1.0

addManagedBean

back to summary

public void addManagedBean(ManagedBean bean)

Add a new bean metadata to the set of beans known to this registry. This is used by internal components.

Parameters

bean:ManagedBean: The managed bean to be added

Since

1.0

convertValue	back to summary
public Object convertValue(String type, String value) Convert a string to object, based on type. Used by several components. We could provide some pluggability. It is here to keep things consistent and avoid duplication in other tasks Parameters type:String Fully qualified class name of the resulting value value:String String value to be converted Returns:Object Converted value

convertValue

back to summary

public Object convertValue(String type, String value)

Convert a string to object, based on type. Used by several components. We could provide some pluggability. It is here to keep things consistent and avoid duplication in other tasks

Parameters

type:String: Fully qualified class name of the resulting value
value:String: String value to be converted

Returns:Object

Converted value

disableRegistry	back to summary
public static synchronized void disableRegistry()

findDescriptor	back to summary
private void findDescriptor(Class<?> beanClass, String type) Lookup the component descriptor in the package and in the parent packages.

findManagedBean back to summary

findManagedBean	back to summary
public ManagedBean findManagedBean(String name) Find and return the managed bean definition for the specified bean name, if any; otherwise return `null`. Parameters name:String Name of the managed bean to be returned. Since 1.1, both short names or the full name of the class can be used. Returns:ManagedBean the managed bean Since 1.0

public ManagedBean findManagedBean(String name)

Find and return the managed bean definition for the specified bean name, if any; otherwise return null.

Parameters

name:String: Name of the managed bean to be returned. Since 1.1, both short names or the full name of the class can be used.

Returns:ManagedBean

the managed bean

Since

1.0

findManagedBean	back to summary
public ManagedBean findManagedBean(Object bean, Class<?> beanClass, String type) throws Exception Find or load metadata. Parameters bean:Object The bean beanClass:Class<?> The bean class type:String The registry type Returns:ManagedBean the managed bean Exceptions Exception: An error occurred

findManagedBean

back to summary

public ManagedBean findManagedBean(Object bean, Class<?> beanClass, String type) throws Exception

Find or load metadata.

Parameters

bean:Object: The bean
beanClass:Class<?>: The bean class
type:String: The registry type

Returns:ManagedBean

the managed bean

Exceptions

Exception:: An error occurred

getId	back to summary
public synchronized int getId(String domain, String name) Implements org.apache.tomcat.util.modeler.RegistryMBean.getId. Return an int ID for faster access. Will be used for notifications and for other operations we want to optimize. Parameters domain:String Namespace name:String Type of the notification Returns:int A unique id for the domain:name combination Annotations @Override Since 1.1

getId

back to summary

public synchronized int getId(String domain, String name)

Implements org.apache.tomcat.util.modeler.RegistryMBean.getId.

Return an int ID for faster access. Will be used for notifications and for other operations we want to optimize.

Parameters

domain:String: Namespace
name:String: Type of the notification

Returns:int

A unique id for the domain:name combination

Annotations

@Override

Since

1.1

getMBeanServer back to summary

getMBeanServer	back to summary
public MBeanServer getMBeanServer() Factory method to create (if necessary) and return our `MBeanServer` instance. Returns:MBeanServer the MBean server

public MBeanServer getMBeanServer()

Factory method to create (if necessary) and return our MBeanServer instance.

Returns:MBeanServer: the MBean server

getMethodInfo	back to summary
public MBeanOperationInfo getMethodInfo(ObjectName oname, String opName) Find the operation info for a method Parameters oname:ObjectName The bean name opName:String The operation name Returns:MBeanOperationInfo the operation info for the specified operation

getMethodInfo

back to summary

public MBeanOperationInfo getMethodInfo(ObjectName oname, String opName)

Find the operation info for a method

Parameters

oname:ObjectName: The bean name
opName:String: The operation name

Returns:MBeanOperationInfo

the operation info for the specified operation

getMethodInfo	back to summary
public MBeanOperationInfo getMethodInfo(ObjectName oname, String opName, int argCount) throws InstanceNotFoundException Find the operation info for a method. Parameters oname:ObjectName The bean name opName:String The operation name argCount:int The number of arguments to the method Returns:MBeanOperationInfo the operation info for the specified operation Exceptions InstanceNotFoundException: If the object name is not bound to an MBean

getMethodInfo

back to summary

public MBeanOperationInfo getMethodInfo(ObjectName oname, String opName, int argCount) throws InstanceNotFoundException

Find the operation info for a method.

Parameters

oname:ObjectName: The bean name
opName:String: The operation name
argCount:int: The number of arguments to the method

Returns:MBeanOperationInfo

the operation info for the specified operation

Exceptions

InstanceNotFoundException:: If the object name is not bound to an MBean

getModelerSource	back to summary
private ModelerSource getModelerSource(String type) throws Exception

getRegistry back to summary

getRegistry	back to summary
public static synchronized Registry getRegistry(Object key, Object guard) Factory method to create (if necessary) and return our `Registry` instance. Parameters key:Object Unused guard:Object Prevent access to the registry by untrusted components Returns:Registry the registry Since 1.1

public static synchronized Registry getRegistry(Object key, Object guard)

Factory method to create (if necessary) and return our Registry instance.

Parameters

key:Object: Unused
guard:Object: Prevent access to the registry by untrusted components

Returns:Registry

the registry

Since

1.1

getType	back to summary
public String getType(ObjectName oname, String attName) Get the type of an attribute of the object, from the metadata. Parameters oname:ObjectName The bean name attName:String The attribute name Returns:String null if metadata about the attribute is not found Since 1.1

getType

back to summary

public String getType(ObjectName oname, String attName)

Get the type of an attribute of the object, from the metadata.

Parameters

oname:ObjectName: The bean name
attName:String: The attribute name

Returns:String

null if metadata about the attribute is not found

Since

1.1

invoke	back to summary
public void invoke(List<ObjectName> mbeans, String operation, boolean failFirst) throws Exception Implements org.apache.tomcat.util.modeler.RegistryMBean.invoke. Invoke a operation on a list of mbeans. Can be used to implement lifecycle operations. Parameters mbeans:List<ObjectName> list of ObjectName on which we'll invoke the operations operation:String Name of the operation ( init, start, stop, etc) failFirst:boolean If false, exceptions will be ignored Annotations @Override Exceptions Exception: Error invoking operation Since 1.1

invoke

back to summary

public void invoke(List<ObjectName> mbeans, String operation, boolean failFirst) throws Exception

Implements org.apache.tomcat.util.modeler.RegistryMBean.invoke.

Invoke a operation on a list of mbeans. Can be used to implement lifecycle operations.

Parameters

mbeans:List<ObjectName>: list of ObjectName on which we'll invoke the operations
operation:String: Name of the operation ( init, start, stop, etc)
failFirst:boolean: If false, exceptions will be ignored

Annotations

@Override

Exceptions

Exception:: Error invoking operation

Since

1.1

load	back to summary
public List<ObjectName> load(String sourceType, Object source, String param) throws Exception Load descriptors. Parameters sourceType:String The source type source:Object The bean param:String A type to load Returns:List<ObjectName> List of descriptors Exceptions Exception: Error loading descriptors

load

back to summary

public List<ObjectName> load(String sourceType, Object source, String param) throws Exception

Load descriptors.

Parameters

sourceType:String: The source type
source:Object: The bean
param:String: A type to load

Returns:List<ObjectName>

List of descriptors

Exceptions

Exception:: Error loading descriptors

loadDescriptors	back to summary
public void loadDescriptors(String packageName, ClassLoader classLoader) Lookup the component descriptor in the package and in the parent packages. Parameters packageName:String The package name classLoader:ClassLoader The class loader

loadDescriptors

back to summary

public void loadDescriptors(String packageName, ClassLoader classLoader)

Lookup the component descriptor in the package and in the parent packages.

Parameters

packageName:String: The package name
classLoader:ClassLoader: The class loader

postDeregister back to summary

postDeregister	back to summary
public void postDeregister() Implements javax.management.MBeanRegistration.postDeregister. Doc from javax.management.MBeanRegistration.postDeregister. Allows the MBean to perform any operations needed after having been unregistered in the MBean server. If the implementation of this method throws a `RuntimeException` or an `Error`, the MBean Server will rethrow those inside a `RuntimeMBeanException` or `RuntimeErrorException`, respectively. However, throwing an exception in `postDeregister` will not change the state of the MBean: the MBean was already successfully deregistered and will remain so. This might be confusing for the code calling `unregisterMBean()`, as it might assume that MBean deregistration has failed. Therefore it is recommended that implementations of `postDeregister` do not throw Runtime Exceptions or Errors if it can be avoided. Annotations @Override

public void postDeregister()

Implements javax.management.MBeanRegistration.postDeregister.

Doc from javax.management.MBeanRegistration.postDeregister.

Allows the MBean to perform any operations needed after having been unregistered in the MBean server.

If the implementation of this method throws a RuntimeException or an Error, the MBean Server will rethrow those inside a RuntimeMBeanException or RuntimeErrorException, respectively. However, throwing an exception in postDeregister will not change the state of the MBean: the MBean was already successfully deregistered and will remain so.

This might be confusing for the code calling unregisterMBean(), as it might assume that MBean deregistration has failed. Therefore it is recommended that implementations of postDeregister do not throw Runtime Exceptions or Errors if it can be avoided.

Annotations

@Override

postRegister back to summary

postRegister	back to summary
public void postRegister(Boolean registrationDone) Implements javax.management.MBeanRegistration.postRegister. Doc from javax.management.MBeanRegistration.postRegister. Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed. If the implementation of this method throws a `RuntimeException` or an `Error`, the MBean Server will rethrow those inside a `RuntimeMBeanException` or `RuntimeErrorException`, respectively. However, throwing an exception in `postRegister` will not change the state of the MBean: if the MBean was already registered (`registrationDone` is `true`), the MBean will remain registered. This might be confusing for the code calling `createMBean()` or `registerMBean()`, as such code might assume that MBean registration has failed when such an exception is raised. Therefore it is recommended that implementations of `postRegister` do not throw Runtime Exceptions or Errors if it can be avoided. Parameters registrationDone: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. Annotations @Override

public void postRegister(Boolean registrationDone)

Implements javax.management.MBeanRegistration.postRegister.

Doc from javax.management.MBeanRegistration.postRegister.

Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

If the implementation of this method throws a RuntimeException or an Error, the MBean Server will rethrow those inside a RuntimeMBeanException or RuntimeErrorException, respectively. However, throwing an exception in postRegister will not change the state of the MBean: if the MBean was already registered (registrationDone is true), the MBean will remain registered.

This might be confusing for the code calling createMBean() or registerMBean(), as such code might assume that MBean registration has failed when such an exception is raised. Therefore it is recommended that implementations of postRegister do not throw Runtime Exceptions or Errors if it can be avoided.

Parameters

registrationDone: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.

Annotations

@Override

preDeregister back to summary

preDeregister	back to summary
public void preDeregister() throws Exception Implements javax.management.MBeanRegistration.preDeregister. Doc from javax.management.MBeanRegistration.preDeregister. Allows the MBean to perform any operations it needs before being unregistered by the MBean server. Annotations @Override Exceptions Exception: This exception will be caught by the MBean server and re-thrown as an `MBeanRegistrationException`.

public void preDeregister() throws Exception

Implements javax.management.MBeanRegistration.preDeregister.

Doc from javax.management.MBeanRegistration.preDeregister.

Allows the MBean to perform any operations it needs before being unregistered by the MBean server.

Annotations

@Override

Exceptions

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

preRegister back to summary

preRegister	back to summary
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception Implements javax.management.MBeanRegistration.preRegister. Doc from javax.management.MBeanRegistration.preRegister. Allows the MBean to perform any operations it needs before being registered in the MBean Server. If the name of the MBean is not specified, the MBean can provide a name for its registration. If any exception is raised, the MBean will not be registered in the MBean Server. Parameters server:MBeanServer The MBean Server in which the MBean will be registered. name: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. Returns:ObjectName 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: This exception will be caught by the MBean Server and re-thrown as an `MBeanRegistrationException`.

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

Implements javax.management.MBeanRegistration.preRegister.

Doc from javax.management.MBeanRegistration.preRegister.

Allows the MBean to perform any operations it needs before being registered in the MBean Server. If the name of the MBean is not specified, the MBean can provide a name for its registration. If any exception is raised, the MBean will not be registered in the MBean Server.

Parameters

server:MBeanServer: The MBean Server in which the MBean will be registered.
name: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.

Returns:ObjectName

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:: This exception will be caught by the MBean Server and re-thrown as an MBeanRegistrationException.

registerComponent	back to summary
public void registerComponent(Object bean, String oname, String type) throws Exception Implements org.apache.tomcat.util.modeler.RegistryMBean.registerComponent. Register a bean by creating a modeler mbean and adding it to the MBeanServer. If metadata is not loaded, we'll look up and read a file named "mbeans-descriptors.ser" or "mbeans-descriptors.xml" in the same package or parent. If the bean is an instance of DynamicMBean. it's metadata will be converted to a model mbean and we'll wrap it - so modeler services will be supported If the metadata is still not found, introspection will be used to extract it automatically. If an mbean is already registered under this name, it'll be first unregistered. If the component implements MBeanRegistration, the methods will be called. If the method has a method "setRegistry" that takes a RegistryMBean as parameter, it'll be called with the current registry. Parameters bean:Object Object to be registered oname:String Name used for registration type:String The type of the mbean, as declared in mbeans-descriptors. If null, the name of the class will be used. This can be used as a hint or by subclasses. Annotations @Override Exceptions Exception: if a registration error occurred Since 1.1

registerComponent

back to summary

public void registerComponent(Object bean, String oname, String type) throws Exception

Implements org.apache.tomcat.util.modeler.RegistryMBean.registerComponent.

Register a bean by creating a modeler mbean and adding it to the MBeanServer. If metadata is not loaded, we'll look up and read a file named "mbeans-descriptors.ser" or "mbeans-descriptors.xml" in the same package or parent. If the bean is an instance of DynamicMBean. it's metadata will be converted to a model mbean and we'll wrap it - so modeler services will be supported If the metadata is still not found, introspection will be used to extract it automatically. If an mbean is already registered under this name, it'll be first unregistered. If the component implements MBeanRegistration, the methods will be called. If the method has a method "setRegistry" that takes a RegistryMBean as parameter, it'll be called with the current registry.

Parameters

bean:Object: Object to be registered
oname:String: Name used for registration
type:String: The type of the mbean, as declared in mbeans-descriptors. If null, the name of the class will be used. This can be used as a hint or by subclasses.

Annotations

@Override

Exceptions

Exception:: if a registration error occurred

Since

1.1

registerComponent	back to summary
public void registerComponent(Object bean, ObjectName oname, String type) throws Exception Register a component Parameters bean:Object The bean oname:ObjectName The object name type:String The registry type Exceptions Exception: Error registering component

registerComponent

back to summary

public void registerComponent(Object bean, ObjectName oname, String type) throws Exception

Parameters

bean:Object: The bean
oname:ObjectName: The object name
type:String: The registry type

Exceptions

Exception:: Error registering component

stop	back to summary
public void stop() Implements org.apache.tomcat.util.modeler.RegistryMBean.stop. Lifecycle method - clean up the registry metadata. Called from resetMetadata(). Annotations @Override Since 1.1

stop

back to summary

public void stop()

Implements org.apache.tomcat.util.modeler.RegistryMBean.stop.

Lifecycle method - clean up the registry metadata. Called from resetMetadata().

Annotations

@Override

Since

1.1

unregisterComponent	back to summary
public void unregisterComponent(String oname) Implements org.apache.tomcat.util.modeler.RegistryMBean.unregisterComponent. Unregister a component. We'll first check if it is registered, and mask all errors. This is mostly a helper. Parameters oname:String Name used for unregistration Annotations @Override Since 1.1

unregisterComponent

back to summary

public void unregisterComponent(String oname)

Implements org.apache.tomcat.util.modeler.RegistryMBean.unregisterComponent.

Unregister a component. We'll first check if it is registered, and mask all errors. This is mostly a helper.

Parameters

oname:String: Name used for unregistration

Annotations

@Override

Since

1.1

unregisterComponent	back to summary
public void unregisterComponent(ObjectName oname) Unregister a component. This is just a helper that avoids exceptions by checking if the mbean is already registered Parameters oname:ObjectName The bean name

unregisterComponent

back to summary

public void unregisterComponent(ObjectName oname)

Unregister a component. This is just a helper that avoids exceptions by checking if the mbean is already registered

Parameters

oname:ObjectName: The bean name

public Class Registry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail