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.

Version:

$Id: MBeanUtils.java 1001923 2010-09-27 22:01:45Z markt $

Author:

Craig R. McClanahan, Amy Roh

Constructor Summary

MBeanUtils()

Method Summary

static ObjectName	createObjectName(String domain, ContextEnvironment environment) Create an ObjectName for this Service object.
static ObjectName	createObjectName(String domain, ContextResource resource) Create an ObjectName for this ContextResource object.
static ObjectName	createObjectName(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 MBeanServer	createServer() Create and configure (if necessary) and return the MBeanServer with which we will be registering our DynamicMBean implementations.
static 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 String	getDomain(Container container) Determine the name of the domain to register MBeans for from a given Container.
static 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

createObjectName

public static ObjectName createObjectName(String domain,
                                          ContextEnvironment environment)
                                   throws 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:

MalformedObjectNameException - if a name cannot be created

createObjectName

public static ObjectName createObjectName(String domain,
                                          ContextResource resource)
                                   throws 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:

MalformedObjectNameException - if a name cannot be created

createObjectName

public static ObjectName createObjectName(String domain,
                                          ContextResourceLink resourceLink)
                                   throws 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:

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 MBeanServer createServer()

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

getDomain

public static String getDomain(Service service)

Determine the name of the domain to register MBeans for from a given Service.

Parameters:

service -

getDomain

public static String getDomain(Container container)

Determine the name of the domain to register MBeans for from a given Container.

Parameters:

container -

getContainerKeyProperties

public static 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