Package org.apache.commons.modeler
Class Registry
java.lang.Object
org.apache.commons.modeler.Registry
- All Implemented Interfaces:
MBeanRegistration
,RegistryMBean
Registry for modeler MBeans.
This is the main entry point into modeler. It provides methods to create
and manipulate model mbeans and simplify their use.
Starting with version 1.1, this is no longer a singleton and the static
methods are strongly deprecated. In a container environment we can expect
different applications to use different registries.
This class is itself an mbean.
IMPORTANT: public methods not marked with @since x.x are experimental or
internal. Should not be used.
- Author:
- Craig R. McClanahan, Costin Manolache
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final HashMap
The set of ManagedBean instances for the beans this registry knows about, keyed by name.private final HashMap
List of managed byeans, keyed by class nameprivate Object
private Hashtable
private Hashtable
private static org.apache.commons.logging.Log
The Log instance to which we will write our log messages.static String
Experimental support for manifest-based discovery.private static HashMap
Will be used to isolate different apps and enhance securityprivate static Registry
The registry instance created by our factory method the first time it is called.private final Map
private MBeanServer
TheMBeanServer
instance that we will use to register management beans. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addManagedBean
(ManagedBean bean) Add a new bean metadata to the set of beans known to this registry.convertValue
(String type, String value) EXPERIMENTAL Convert a string to object, based on type.private void
findDescriptor
(Class beanClass, String type) Lookup the component descriptor in the package and in the parent packages.findManagedBean
(Class beanClass, String type) findManagedBean
(Object bean, Class beanClass, String type) Find or load metadata.findManagedBean
(String name) Find and return the managed bean definition for the specified bean name, if any; otherwise returnnull
.String[]
Return the set of bean names for all managed beans known to this registry.String[]
findManagedBeans
(String group) Return the set of bean names for all managed beans known to this registry that belong to the specified group.int
Return an int ID for faster access.Factory method to create (if necessary) and return ourMBeanServer
instance.getMethodInfo
(ObjectName oname, String opName) Find the operation info for a methodprivate ModelerSource
getModelerSource
(String type) static Registry
Deprecated.Not enough info - use the method that takes CL and domainstatic Registry
getRegistry
(Object key, Object guard) Factory method to create (if necessary) and return ourRegistry
instance.static MBeanServer
Deprecated.Use the instance methodgetType
(ObjectName oname, String attName) Get the type of an attribute of the object, from the metadata.void
Invoke a operation on a list of mbeans.Deprecated.bad interface, mixing of metadata and mbeansvoid
loadCachedDescriptors
(Object source) Deprecated.Loaded automatically or using a File or Url ending in .servoid
loadDescriptors
(Object source) Load the registry from the XML input found in the specified input stream.void
loadDescriptors
(String packageName, ClassLoader classLoader) Lookup the component descriptor in the package and in the parent packages.void
loadDescriptors
(String sourceType, Object source, String param) Deprecated.loadMBeans
(Object source) loadMBeans
(Object source, ClassLoader cl) Load an extended mlet file.void
loadMetadata
(Object source) Load descriptors.private void
Discover all META-INF/modeler.xml files in classpath and register the componentsstatic void
loadRegistry
(InputStream stream) Deprecated.use normal class method insteadvoid
void
postRegister
(Boolean registrationDone) void
preRegister
(MBeanServer server, ObjectName name) void
registerComponent
(Object bean, String oname, String type) Register a bean by creating a modeler mbean and adding it to the MBeanServer.void
registerComponent
(Object bean, String domain, String type, String name) Deprecated.- may still be used in code using pre-1.1 buildsvoid
registerComponent
(Object bean, ObjectName oname, String type) Register a component XXX make it privatevoid
removeManagedBean
(ManagedBean bean) Remove an existing bean from the set of beans known to this registry.void
void
Set a guard object that will prevent access to this registry by unauthorized componentsvoid
setMBeanServer
(MBeanServer server) Set theMBeanServer
to be utilized for our registered management beans.static void
setServer
(MBeanServer mbeanServer) Deprecated.Use the instance methodstatic void
setUseContextClassLoader
(boolean enable) Allow containers to isolate apps.private String
void
stop()
Lifecycle method - clean up the registry metadata.void
unregisterComponent
(String oname) Unregister a component.void
unregisterComponent
(String domain, String name) void
unregisterComponent
(ObjectName oname) Unregister a component.void
unregisterRegistry
(ClassLoader loader) Called by a registry or by the container to unload a loader
-
Field Details
-
MODELER_MANIFEST
Experimental support for manifest-based discovery. -
log
private static org.apache.commons.logging.Log logThe Log instance to which we will write our log messages. -
perLoaderRegistries
Will be used to isolate different apps and enhance security -
registry
The registry instance created by our factory method the first time it is called. -
server
TheMBeanServer
instance that we will use to register management beans. -
descriptors
The set of ManagedBean instances for the beans this registry knows about, keyed by name. -
descriptorsByClass
List of managed byeans, keyed by class name -
searchedPaths
-
guard
-
idDomains
-
ids
-
-
Constructor Details
-
Registry
public Registry()
-
-
Method Details
-
getRegistry
Factory method to create (if necessary) and return ourRegistry
instance. Use this method to obtain a Registry - all other static methods are deprecated and shouldn't be used. The current version uses a static - future versions could use the thread class loader.- Parameters:
key
- Support for application isolation. If null, the context class loader will be used ( if setUseContextClassLoader is called ) or the default registry is returned.guard
- Prevent access to the registry by untrusted components- Since:
- 1.1
-
setUseContextClassLoader
public static void setUseContextClassLoader(boolean enable) Allow containers to isolate apps. Can be called only once. It is highly recommended you call this method if using Registry in a container environment. The default is false for backward compatibility- Parameters:
enable
-- Since:
- 1.1
-
setGuard
Set a guard object that will prevent access to this registry by unauthorized components- Parameters:
guard
-- Since:
- 1.1
-
stop
public void stop()Lifecycle method - clean up the registry metadata.- Specified by:
stop
in interfaceRegistryMBean
- Since:
- 1.1
-
loadMBeans
Load an extended mlet file. The source can be an URL, File or InputStream. All mbeans will be instantiated, registered and the attributes will be set. The result is a list of ObjectNames.- Specified by:
loadMBeans
in interfaceRegistryMBean
- Parameters:
source
- InputStream or URL of the filecl
- ClassLoader to be used to load the mbeans, or null to use the default JMX mechanism ( i.e. all registered loaders )- Returns:
- List of ObjectName for the loaded mbeans
- Throws:
Exception
- Since:
- 1.1
-
loadMetadata
Load descriptors. The source can be a File or URL or InputStream for the descriptors file. In the case of File and URL, if the extension is ".ser" a serialized version will be loaded. Also ( experimental for now ) a ClassLoader - in which case META-INF/ will be used. This method should be used to explicitely load metadata - but this is not required in most cases. The registerComponent() method will find metadata in the same pacakge.- Specified by:
loadMetadata
in interfaceRegistryMBean
- Parameters:
source
-- Throws:
Exception
-
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.- Specified by:
registerComponent
in interfaceRegistryMBean
- Parameters:
bean
- Object to be registeredoname
- Name used for registrationtype
- 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.- Throws:
Exception
- Since:
- 1.1
-
unregisterComponent
Unregister a component. We'll first check if it is registered, and mask all errors. This is mostly a helper.- Specified by:
unregisterComponent
in interfaceRegistryMBean
- Parameters:
oname
-- Since:
- 1.1
-
invoke
Invoke a operation on a list of mbeans. Can be used to implement lifecycle operations.- Specified by:
invoke
in interfaceRegistryMBean
- Parameters:
mbeans
- list of ObjectName on which we'll invoke the operationsoperation
- Name of the operation ( init, start, stop, etc)failFirst
- If false, exceptions will be ignored- Throws:
Exception
- Since:
- 1.1
-
getId
Return an int ID for faster access. Will be used for notifications and for other operations we want to optimize.- Specified by:
getId
in interfaceRegistryMBean
- Parameters:
domain
- Namespacename
- Type of the notification- Returns:
- An unique id for the domain:name combination
- Since:
- 1.1
-
addManagedBean
Add a new bean metadata to the set of beans known to this registry. This is used by internal components.- Parameters:
bean
- The managed bean to be added- Since:
- 1.0
-
findManagedBean
Find and return the managed bean definition for the specified bean name, if any; otherwise returnnull
.- Parameters:
name
- Name of the managed bean to be returned. Since 1.1, both short names or the full name of the class can be used.- Since:
- 1.0
-
findManagedBeans
Return the set of bean names for all managed beans known to this registry.- Since:
- 1.0
-
findManagedBeans
Return the set of bean names for all managed beans known to this registry that belong to the specified group.- Parameters:
group
- Name of the group of interest, ornull
to select beans that do not belong to a group- Since:
- 1.0
-
removeManagedBean
Remove an existing bean from the set of beans known to this registry.- Parameters:
bean
- The managed bean to be removed- Since:
- 1.0
-
getServer
Deprecated.Use the instance methodFactory method to create (if necessary) and return ourMBeanServer
instance.- Since:
- 1.0
-
setServer
Deprecated.Use the instance methodSet theMBeanServer
to be utilized for our registered management beans.- Parameters:
mbeanServer
- The newMBeanServer
instance- Since:
- 1.0
-
loadRegistry
Deprecated.use normal class method insteadLoad the registry from the XML input found in the specified input stream.- Parameters:
stream
- InputStream containing the registry configuration information- Throws:
Exception
- if any parsing or processing error occurs- Since:
- 1.0
-
getRegistry
Deprecated.Not enough info - use the method that takes CL and domainGet a "singelton" registry, or one per thread if setUseContextLoader was called- Since:
- 1.0
-
getType
Get the type of an attribute of the object, from the metadata.- Parameters:
oname
-attName
-- Returns:
- null if metadata about the attribute is not found
- Since:
- 1.1
-
getMethodInfo
Find the operation info for a method- Parameters:
oname
-opName
-- Returns:
- the operation info for the specified operation
-
unregisterComponent
Unregister a component. This is just a helper that avoids exceptions by checking if the mbean is already registered- Parameters:
oname
-
-
getMBeanServer
Factory method to create (if necessary) and return ourMBeanServer
instance. -
findManagedBean
Find or load metadata.- Throws:
Exception
-
convertValue
EXPERIMENTAL 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
- Fully qualified class name of the resulting valuevalue
- String value to be converted- Returns:
- Converted value
-
load
Deprecated.bad interface, mixing of metadata and mbeansExperimental.- Parameters:
sourceType
-source
-param
-- Returns:
- List of descriptors
- Throws:
Exception
-
sourceTypeFromExt
-
registerComponent
Register a component XXX make it private- Parameters:
bean
-oname
-type
-- Throws:
Exception
-
loadDescriptors
Lookup the component descriptor in the package and in the parent packages.- Parameters:
packageName
-
-
loadDescriptors
Deprecated.Experimental. Will become private, some code may still use it- Parameters:
sourceType
-source
-param
-- Throws:
Exception
-
loadMetaInfDescriptors
Discover all META-INF/modeler.xml files in classpath and register the components- Since:
- EXPERIMENTAL
-
findDescriptor
Lookup the component descriptor in the package and in the parent packages.- Parameters:
beanClass
-type
-
-
getModelerSource
- Throws:
Exception
-
preRegister
- Specified by:
preRegister
in interfaceMBeanRegistration
- Throws:
Exception
-
postRegister
- Specified by:
postRegister
in interfaceMBeanRegistration
-
preDeregister
- Specified by:
preDeregister
in interfaceMBeanRegistration
- Throws:
Exception
-
postDeregister
public void postDeregister()- Specified by:
postDeregister
in interfaceMBeanRegistration
-
unregisterRegistry
Called by a registry or by the container to unload a loader- Parameters:
loader
-
-
findManagedBean
- Throws:
Exception
-
setMBeanServer
Set theMBeanServer
to be utilized for our registered management beans.- Parameters:
server
- The newMBeanServer
instance
-
resetMetadata
public void resetMetadata() -
loadDescriptors
Load the registry from the XML input found in the specified input stream.- Parameters:
source
- Source to be used to load. Can be an InputStream or URL.- Throws:
Exception
- if any parsing or processing error occurs
-
registerComponent
public void registerComponent(Object bean, String domain, String type, String name) throws Exception Deprecated.- may still be used in code using pre-1.1 builds- Throws:
Exception
-
unregisterComponent
-
loadMBeans
- Throws:
Exception
-
loadCachedDescriptors
Deprecated.Loaded automatically or using a File or Url ending in .serLoad the registry from a cached .ser file. This is typically 2-3 times faster than parsing the XML.- Parameters:
source
- Source to be used to load. Can be an InputStream or URL.- Throws:
Exception
- if any parsing or processing error occurs
-