Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.modeler.Registry
Field Summary | |
static String |
|
private HashMap |
|
private HashMap |
|
private Object | |
private Hashtable | |
private Hashtable | |
private Object | |
private static Log |
|
private static HashMap |
|
private static Registry |
|
private HashMap | |
private MBeanServer |
|
Constructor Summary | |
|
Method Summary | |
void |
|
Object |
|
private void |
|
ManagedBean |
|
ManagedBean |
|
ManagedBean |
|
String[] |
|
String[] |
|
int |
|
MBeanServer |
|
MBeanOperationInfo |
|
private ModelerSource |
|
static Registry |
|
static Registry |
|
static MBeanServer |
|
String |
|
void |
|
List |
|
void |
|
void |
|
void |
|
void |
|
List |
|
List |
|
private void |
|
void |
|
static void |
|
void | |
void |
|
void | |
ObjectName |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
static void |
|
static void |
|
private String |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public static String MODELER_MANIFEST
Experimental support for manifest-based discovery.
private HashMap descriptors
The set of ManagedBean instances for the beans this registry knows about, keyed by name.
private HashMap descriptorsByClass
List of managed byeans, keyed by class name
private Object guard
private Hashtable idDomains
private Hashtable ids
private Object key
private static Log log
The Log instance to which we will write our log messages.
private static HashMap perLoaderRegistries
Will be used to isolate different apps and enhance security
private static Registry registry
The registry instance created by our factory method the first time it is called.
private HashMap searchedPaths
private MBeanServer server
TheMBeanServer
instance that we will use to register management beans.
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
- The managed bean to be added
- Since:
- 1.0
public Object convertValue(String type, String value)
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
private void findDescriptor(Class beanClass, String type)
Lookup the component descriptor in the package and in the parent packages.
- Parameters:
beanClass
-type
-
public ManagedBean findManagedBean(Object bean, Class beanClass, String type) throws Exception
Find or load metadata.
public ManagedBean findManagedBean(String name)
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
public String[] findManagedBeans()
Return the set of bean names for all managed beans known to this registry.
- Since:
- 1.0
public String[] findManagedBeans(String group)
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
public int getId(String domain, String name)
Return an int ID for faster access. Will be used for notifications and for other operations we want to optimize.
- Specified by:
- getId in interface RegistryMBean
- Parameters:
domain
- Namespacename
- Type of the notification
- Returns:
- An unique id for the domain:name combination
- Since:
- 1.1
public MBeanServer getMBeanServer()
Factory method to create (if necessary) and return ourMBeanServer
instance.
public MBeanOperationInfo getMethodInfo(ObjectName oname, String opName)
Find the operation info for a method
- Parameters:
oname
-opName
-
- Returns:
- the operation info for the specified operation
public static Registry getRegistry()
Deprecated. Not enough info - use the method that takes CL and domain
Get a "singelton" registry, or one per thread if setUseContextLoader was called
- Since:
- 1.0
public static Registry getRegistry(Object key, Object guard)
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
public static MBeanServer getServer()
Deprecated. Use the instance method
Factory method to create (if necessary) and return ourMBeanServer
instance.
- Since:
- 1.0
public String getType(ObjectName oname, String attName)
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
public void invoke(List mbeans, String operation, boolean failFirst) throws Exception
Invoke a operation on a list of mbeans. Can be used to implement lifecycle operations.
- Specified by:
- invoke in interface RegistryMBean
- 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
- Since:
- 1.1
public List load(String sourceType, Object source, String param) throws Exception
Deprecated. bad interface, mixing of metadata and mbeans
Experimental.
- Parameters:
sourceType
-source
-param
-
- Returns:
- List of descriptors
public void loadCachedDescriptors(Object source) throws Exception
Deprecated. Loaded automatically or using a File or Url ending in .ser
Load 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.
public void loadDescriptors(Object source) throws Exception
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.
public void loadDescriptors(String packageName, ClassLoader classLoader)
Lookup the component descriptor in the package and in the parent packages.
- Parameters:
packageName
-
public void loadDescriptors(String sourceType, Object source, String param) throws Exception
Deprecated.
Experimental. Will become private, some code may still use it
- Parameters:
sourceType
-source
-param
-
public List loadMBeans(Object source) throws Exception
public List loadMBeans(Object source, ClassLoader cl) throws Exception
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 interface RegistryMBean
- 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
- Since:
- 1.1
private void loadMetaInfDescriptors(ClassLoader cl)
Discover all META-INF/modeler.xml files in classpath and register the components
- Since:
- EXPERIMENTAL
public void loadMetadata(Object source) throws Exception
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 interface RegistryMBean
- Parameters:
source
-
public static void loadRegistry(InputStream stream) throws Exception
Deprecated. use normal class method instead
Load the registry from the XML input found in the specified input stream.
- Parameters:
stream
- InputStream containing the registry configuration information
- Since:
- 1.0
public void postDeregister()
public void postRegister(Boolean registrationDone)
public void preDeregister() throws Exception
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
public void registerComponent(Object bean, ObjectName oname, String type) throws Exception
Register a component XXX make it private
- Parameters:
bean
-oname
-type
-
public void registerComponent(Object bean, String oname, String type) throws Exception
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 interface RegistryMBean
- 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.
- Since:
- 1.1
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
public void removeManagedBean(ManagedBean bean)
Remove an existing bean from the set of beans known to this registry.
- Parameters:
bean
- The managed bean to be removed
- Since:
- 1.0
public void resetMetadata()
public void setGuard(Object guard)
Set a guard object that will prevent access to this registry by unauthorized components
- Parameters:
guard
-
- Since:
- 1.1
public void setMBeanServer(MBeanServer server)
Set theMBeanServer
to be utilized for our registered management beans.
- Parameters:
server
- The newMBeanServer
instance
public static void setServer(MBeanServer mbeanServer)
Deprecated. Use the instance method
Set theMBeanServer
to be utilized for our registered management beans.
- Parameters:
mbeanServer
- The newMBeanServer
instance
- Since:
- 1.0
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
private String sourceTypeFromExt(String s)
public void stop()
Lifecycle method - clean up the registry metadata.
- Specified by:
- stop in interface RegistryMBean
- Since:
- 1.1
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
-
public void unregisterComponent(String oname)
Unregister a component. We'll first check if it is registered, and mask all errors. This is mostly a helper.
- Specified by:
- unregisterComponent in interface RegistryMBean
- Parameters:
oname
-
- Since:
- 1.1
public void unregisterComponent(String domain, String name)
public void unregisterRegistry(ClassLoader loader)
Called by a registry or by the container to unload a loader
- Parameters:
loader
-