org.bedework.util.jmx

Class ManagementContext

java.lang.Object

org.bedework.util.misc.Logged

org.bedework.util.jmx.ManagementContext

public class ManagementContext
extends Logged

Heavily modified version from activemq.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOMAIN Default jmx domain
static boolean	isJboss5 I think we need this for the class loading

Fields inherited from class org.bedework.util.misc.Logged

auditLoggerName, debug, errorLoggerName, metricsLoggerName

Constructor Summary

Constructors

Constructor and Description
ManagementContext()
ManagementContext(MBeanServer server)
ManagementContext(String domain)

Method Summary

Modifier and Type	Method and Description
ObjectName	createCustomComponentMBeanName(String type, String name) Formulate and return the MBean ObjectName of a custom control MBean
protected MBeanServer	createMBeanServer()
static String	encodeObjectNamePart(String part)
protected MBeanServer	findMBeanServer()
Object	getAttribute(ObjectName name, String attribute)
String	getJmxDomainName()
MBeanServer	getMBeanServer() Get the MBeanServer
static ObjectName	getSystemObjectName(String domainName, String containerName, Class theClass) Retrieve a System ObjectName
boolean	isCreateMBeanServer()
boolean	isUseMBeanServer()
Object	newProxyInstance(ObjectName objectName, Class interfaceClass, boolean notificationBroadcaster)
Set	queryNames(ObjectName name, QueryExp query) Gets the names of MBeans controlled by the MBean server.
void	registerMBean(Object bean, ObjectName name)
void	setCreateMBeanServer(boolean enableJMX)
void	setJmxDomainName(String val)
void	setMBeanServer(MBeanServer val) Set the MBeanServer
void	setUseMBeanServer(boolean useMBeanServer)
void	start()
void	stop()
void	unregisterMBean(ObjectName name) Unregister an MBean

Methods inherited from class org.bedework.util.misc.Logged

audit, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, getAuditLoggerIfEnabled, getErrorLoggerIfEnabled, getLogger, getLogger, getMetricsLoggerIfEnabled, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsLoggerEnabled, metrics, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

Default jmx domain

isJboss5

public static final boolean isJboss5

I think we need this for the class loading

Constructor Detail

ManagementContext

public ManagementContext()

ManagementContext

public ManagementContext(String domain)

Parameters:

domain - name or null

ManagementContext

public ManagementContext(MBeanServer server)

Parameters:

server - an mbean server

Method Detail

start

public void start()
           throws IOException

Throws:

IOException

stop

public void stop()
          throws Exception

Throws:

Exception

setJmxDomainName

public void setJmxDomainName(String val)

Parameters:

val - The jmxDomainName to set.

getJmxDomainName

public String getJmxDomainName()

Returns:

the jmxDomainName.

setMBeanServer

public void setMBeanServer(MBeanServer val)

Set the MBeanServer

Parameters:

val - the server

getMBeanServer

public MBeanServer getMBeanServer()

Get the MBeanServer

Returns:

the MBeanServer

isUseMBeanServer

public boolean isUseMBeanServer()

Returns:

Returns the useMBeanServer.

setUseMBeanServer

public void setUseMBeanServer(boolean useMBeanServer)

Parameters:

useMBeanServer - The useMBeanServer to set.

isCreateMBeanServer

public boolean isCreateMBeanServer()

Returns:

Returns the createMBeanServer flag.

setCreateMBeanServer

public void setCreateMBeanServer(boolean enableJMX)

Parameters:

enableJMX - Set createMBeanServer.

createCustomComponentMBeanName

public ObjectName createCustomComponentMBeanName(String type,
                                                 String name)

Formulate and return the MBean ObjectName of a custom control MBean

Parameters:

type -

name -

Returns:

the JMX ObjectName of the MBean, or null if customName is invalid.

encodeObjectNamePart

public static String encodeObjectNamePart(String part)

Parameters:

part -

Returns:

encoded object name part

getSystemObjectName

public static ObjectName getSystemObjectName(String domainName,
                                             String containerName,
                                             Class theClass)
                                      throws MalformedObjectNameException

Retrieve a System ObjectName

Parameters:

domainName -

containerName -

theClass -

Returns:

the ObjectName

Throws:

MalformedObjectNameException

newProxyInstance

public Object newProxyInstance(ObjectName objectName,
                               Class interfaceClass,
                               boolean notificationBroadcaster)

Parameters:

objectName -

interfaceClass -

notificationBroadcaster -

Returns:

new instance

getAttribute

public Object getAttribute(ObjectName name,
                           String attribute)
                    throws Exception

Parameters:

name -

attribute -

Returns:

attribute

Throws:

Exception

registerMBean

public void registerMBean(Object bean,
                          ObjectName name)
                   throws Exception

Parameters:

bean - to register

name - its name

Throws:

Exception - on error

queryNames

public Set queryNames(ObjectName name,
                      QueryExp query)
               throws Exception

Gets the names of MBeans controlled by the MBean server. This method enables any of the following to be obtained:

• The names of all MBeans,
• the names of a set of MBeans specified by pattern matching on the ObjectName and/or a Query expression,
• a specific MBean name (equivalent to testing whether an MBean is registered).

When the object name is null or no domain and key properties are specified, all objects are selected (and filtered if a query is specified). It returns the set of ObjectNames for the MBeans selected.

Parameters:

name -

query -

Returns:

A set containing the ObjectNames for the MBeans selected. If no MBean satisfies the query, an empty list is returned.

Throws:

Exception

unregisterMBean

public void unregisterMBean(ObjectName name)
                     throws JMException

Unregister an MBean

Parameters:

name - of mbean

Throws:

JMException

findMBeanServer

protected MBeanServer findMBeanServer()

createMBeanServer

protected MBeanServer createMBeanServer()
                                 throws MalformedObjectNameException,
                                        IOException

Returns:

a server

Throws:

NullPointerException

MalformedObjectNameException

IOException