Package org.apache.catalina.mbeans
Class MBeanUtils
- java.lang.Object
-
- org.apache.catalina.mbeans.MBeanUtils
-
public class MBeanUtils extends Object
Public utility methods in support of the server side MBeans implementation.- Author:
- Craig R. McClanahan, Amy Roh
-
-
Constructor Summary
Constructors Constructor Description MBeanUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DynamicMBeancreateMBean(ContextEnvironment environment)Create, register, and return an MBean for thisContextEnvironmentobject.static DynamicMBeancreateMBean(ContextResource resource)Create, register, and return an MBean for thisContextResourceobject.static DynamicMBeancreateMBean(ContextResourceLink resourceLink)Create, register, and return an MBean for thisContextResourceLinkobject.static ObjectNamecreateObjectName(String domain, ContextEnvironment environment)Create anObjectNamefor thisServiceobject.static ObjectNamecreateObjectName(String domain, ContextResource resource)Create anObjectNamefor thisContextResourceobject.static ObjectNamecreateObjectName(String domain, ContextResourceLink resourceLink)Create anObjectNamefor thisContextResourceLinkobject.static RegistrycreateRegistry()Create and configure (if necessary) and return the registry of managed object descriptions.static MBeanServercreateServer()Create and configure (if necessary) and return theMBeanServerwith which we will be registering ourDynamicMBeanimplementations.static voiddestroyMBean(ContextEnvironment environment)Deregister the MBean for thisContextEnvironmentobject.static voiddestroyMBean(ContextResource resource)Deregister the MBean for thisContextResourceobject.static voiddestroyMBean(ContextResourceLink resourceLink)Deregister the MBean for thisContextResourceLinkobject.
-
-
-
Method Detail
-
createMBean
public static DynamicMBean createMBean(ContextEnvironment environment) throws Exception
Create, register, and return an MBean for thisContextEnvironmentobject.- Parameters:
environment- The ContextEnvironment to be managed- Returns:
- a new MBean
- Throws:
Exception- if an MBean cannot be created or registered
-
createMBean
public static DynamicMBean createMBean(ContextResource resource) throws Exception
Create, register, and return an MBean for thisContextResourceobject.- Parameters:
resource- The ContextResource to be managed- Returns:
- a new MBean
- Throws:
Exception- if an MBean cannot be created or registered
-
createMBean
public static DynamicMBean createMBean(ContextResourceLink resourceLink) throws Exception
Create, register, and return an MBean for thisContextResourceLinkobject.- Parameters:
resourceLink- The ContextResourceLink to be managed- Returns:
- a new MBean
- Throws:
Exception- if an MBean cannot be created or registered
-
createObjectName
public static ObjectName createObjectName(String domain, ContextEnvironment environment) throws MalformedObjectNameException
Create anObjectNamefor thisServiceobject.- Parameters:
domain- Domain in which this name is to be createdenvironment- The ContextEnvironment to be named- Returns:
- a new object name
- Throws:
MalformedObjectNameException- if a name cannot be created
-
createObjectName
public static ObjectName createObjectName(String domain, ContextResource resource) throws MalformedObjectNameException
Create anObjectNamefor thisContextResourceobject.- Parameters:
domain- Domain in which this name is to be createdresource- The ContextResource to be named- Returns:
- a new object name
- Throws:
MalformedObjectNameException- if a name cannot be created
-
createObjectName
public static ObjectName createObjectName(String domain, ContextResourceLink resourceLink) throws MalformedObjectNameException
Create anObjectNamefor thisContextResourceLinkobject.- Parameters:
domain- Domain in which this name is to be createdresourceLink- The ContextResourceLink to be named- Returns:
- a new object name
- Throws:
MalformedObjectNameException- if a name cannot be created
-
createRegistry
public static Registry createRegistry()
Create and configure (if necessary) and return the registry of managed object descriptions.- Returns:
- the singleton registry
-
createServer
public static MBeanServer createServer()
Create and configure (if necessary) and return theMBeanServerwith which we will be registering ourDynamicMBeanimplementations.- Returns:
- the singleton MBean server
-
destroyMBean
public static void destroyMBean(ContextEnvironment environment) throws Exception
Deregister the MBean for thisContextEnvironmentobject.- Parameters:
environment- The ContextEnvironment to be managed- Throws:
Exception- if an MBean cannot be deregistered
-
destroyMBean
public static void destroyMBean(ContextResource resource) throws Exception
Deregister the MBean for thisContextResourceobject.- Parameters:
resource- The ContextResource to be managed- Throws:
Exception- if an MBean cannot be deregistered
-
destroyMBean
public static void destroyMBean(ContextResourceLink resourceLink) throws Exception
Deregister the MBean for thisContextResourceLinkobject.- Parameters:
resourceLink- The ContextResourceLink to be managed- Throws:
Exception- if an MBean cannot be deregistered
-
-