Apache Tomcat 7.0.25

org.apache.catalina.mbeans
Class MBeanUtils

java.lang.Object
  extended by org.apache.catalina.mbeans.MBeanUtils

public class MBeanUtils
extends java.lang.Object

Public utility methods in support of the server side MBeans implementation.

Version:
$Id: MBeanUtils.java 1189423 2011-10-26 20:12:27Z markt $
Author:
Craig R. McClanahan, Amy Roh

Constructor Summary
MBeanUtils()
           
 
Method Summary
static javax.management.DynamicMBean createMBean(ContextEnvironment environment)
          Create, register, and return an MBean for this ContextEnvironment object.
static javax.management.DynamicMBean createMBean(ContextResource resource)
          Create, register, and return an MBean for this ContextResource object.
static javax.management.DynamicMBean createMBean(ContextResourceLink resourceLink)
          Create, register, and return an MBean for this ContextResourceLink object.
static javax.management.ObjectName createObjectName(java.lang.String domain, ContextEnvironment environment)
          Create an ObjectName for this Service object.
static javax.management.ObjectName createObjectName(java.lang.String domain, ContextResource resource)
          Create an ObjectName for this ContextResource object.
static javax.management.ObjectName createObjectName(java.lang.String domain, ContextResourceLink resourceLink)
          Create an ObjectName for this ContextResourceLink object.
static Registry createRegistry()
          Create and configure (if necessary) and return the registry of managed object descriptions.
static javax.management.MBeanServer createServer()
          Create and configure (if necessary) and return the MBeanServer with which we will be registering our DynamicMBean implementations.
static void destroyMBean(ContextEnvironment environment)
          Deregister the MBean for this ContextEnvironment object.
static void destroyMBean(ContextResource resource)
          Deregister the MBean for this ContextResource object.
static void destroyMBean(ContextResourceLink resourceLink)
          Deregister the MBean for this ContextResourceLink object.
static java.lang.String getContainerKeyProperties(Container container)
          Calculate the key properties string to be added to an object's ObjectName to indicate that it is associated with that container.
static java.lang.String getDomain(Container container)
          Determine the name of the domain to register MBeans for from a given Container.
static java.lang.String getDomain(Service service)
          Determine the name of the domain to register MBeans for from a given Service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBeanUtils

public MBeanUtils()
Method Detail

createMBean

public static javax.management.DynamicMBean createMBean(ContextEnvironment environment)
                                                 throws java.lang.Exception
Create, register, and return an MBean for this ContextEnvironment object.

Parameters:
environment - The ContextEnvironment to be managed
Throws:
java.lang.Exception - if an MBean cannot be created or registered

createMBean

public static javax.management.DynamicMBean createMBean(ContextResource resource)
                                                 throws java.lang.Exception
Create, register, and return an MBean for this ContextResource object.

Parameters:
resource - The ContextResource to be managed
Throws:
java.lang.Exception - if an MBean cannot be created or registered

createMBean

public static javax.management.DynamicMBean createMBean(ContextResourceLink resourceLink)
                                                 throws java.lang.Exception
Create, register, and return an MBean for this ContextResourceLink object.

Parameters:
resourceLink - The ContextResourceLink to be managed
Throws:
java.lang.Exception - if an MBean cannot be created or registered

createObjectName

public static javax.management.ObjectName createObjectName(java.lang.String domain,
                                                           ContextEnvironment environment)
                                                    throws javax.management.MalformedObjectNameException
Create an ObjectName for this Service object.

Parameters:
domain - Domain in which this name is to be created
environment - The ContextEnvironment to be named
Throws:
javax.management.MalformedObjectNameException - if a name cannot be created

createObjectName

public static javax.management.ObjectName createObjectName(java.lang.String domain,
                                                           ContextResource resource)
                                                    throws javax.management.MalformedObjectNameException
Create an ObjectName for this ContextResource object.

Parameters:
domain - Domain in which this name is to be created
resource - The ContextResource to be named
Throws:
javax.management.MalformedObjectNameException - if a name cannot be created

createObjectName

public static javax.management.ObjectName createObjectName(java.lang.String domain,
                                                           ContextResourceLink resourceLink)
                                                    throws javax.management.MalformedObjectNameException
Create an ObjectName for this ContextResourceLink object.

Parameters:
domain - Domain in which this name is to be created
resourceLink - The ContextResourceLink to be named
Throws:
javax.management.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.


createServer

public static javax.management.MBeanServer createServer()
Create and configure (if necessary) and return the MBeanServer with which we will be registering our DynamicMBean implementations.


destroyMBean

public static void destroyMBean(ContextEnvironment environment)
                         throws java.lang.Exception
Deregister the MBean for this ContextEnvironment object.

Parameters:
environment - The ContextEnvironment to be managed
Throws:
java.lang.Exception - if an MBean cannot be deregistered

destroyMBean

public static void destroyMBean(ContextResource resource)
                         throws java.lang.Exception
Deregister the MBean for this ContextResource object.

Parameters:
resource - The ContextResource to be managed
Throws:
java.lang.Exception - if an MBean cannot be deregistered

destroyMBean

public static void destroyMBean(ContextResourceLink resourceLink)
                         throws java.lang.Exception
Deregister the MBean for this ContextResourceLink object.

Parameters:
resourceLink - The ContextResourceLink to be managed
Throws:
java.lang.Exception - if an MBean cannot be deregistered

getDomain

public static java.lang.String getDomain(Service service)
Determine the name of the domain to register MBeans for from a given Service.

Parameters:
service -

getDomain

public static java.lang.String getDomain(Container container)
Determine the name of the domain to register MBeans for from a given Container.

Parameters:
container -

getContainerKeyProperties

public static java.lang.String getContainerKeyProperties(Container container)
Calculate the key properties string to be added to an object's ObjectName to indicate that it is associated with that container.

Parameters:
container - The container the object is associated with
Returns:
A string suitable for appending to the ObjectName

Apache Tomcat 7.0.25

Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.