org.jolokia.backend

Class MBeanServerHandler

java.lang.Object

org.jolokia.backend.MBeanServerHandler

All Implemented Interfaces:

MBeanRegistration, MBeanServerHandlerMBean

public class MBeanServerHandler
extends Object
implements MBeanServerHandlerMBean, MBeanRegistration

Handler for finding and merging various MBeanServers locally when used as an agent.

Since:

Jun 15, 2009

Author:

roland

Field Summary

Fields inherited from interface org.jolokia.backend.MBeanServerHandlerMBean

OBJECT_NAME

Constructor Summary

Constructors

Constructor and Description
MBeanServerHandler(Configuration pConfig, LogHandler pLogHandler) Create a new MBeanServer handler who is responsible for managing multiple intra VM MBeanServer at once An optional qualifier used for registering this object as an MBean is taken from the given configuration as well

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Unregister all previously registered MBean.
Object	dispatchRequest(JsonRequestHandler pRequestHandler, JmxRequest pJmxReq) Dispatch a request to the MBeanServer which can handle it
MBeanServerExecutorLocal	getMBeanServerManager() Get the set of MBeanServers found
String	getObjectName()
ServerHandle	getServerHandle() Get information about the detected server this agent is running on.
String	mBeanServersInfo() Get a description of all MBeanServers found
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
ObjectName	registerMBean(Object pMBean, String... pOptionalName) Register a MBean under a certain name to the platform MBeanServer

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanServerHandler

public MBeanServerHandler(Configuration pConfig,
                  LogHandler pLogHandler)

Create a new MBeanServer handler who is responsible for managing multiple intra VM MBeanServer at once An optional qualifier used for registering this object as an MBean is taken from the given configuration as well

Parameters:

pConfig - configuration for this agent which is also given to the ServerHandle#postDetect() method for special initialization.

pLogHandler - log handler used for logging purposes

Method Detail

dispatchRequest

public Object dispatchRequest(JsonRequestHandler pRequestHandler,
                     JmxRequest pJmxReq)
                       throws InstanceNotFoundException,
                              AttributeNotFoundException,
                              ReflectionException,
                              MBeanException,
                              NotChangedException

Dispatch a request to the MBeanServer which can handle it

Parameters:

pRequestHandler - request handler to be called with an MBeanServer

pJmxReq - the request to dispatch

Returns:

the result of the request

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

NotChangedException

registerMBean

public final ObjectName registerMBean(Object pMBean,
                       String... pOptionalName)
                               throws MalformedObjectNameException,
                                      NotCompliantMBeanException,
                                      InstanceAlreadyExistsException

Register a MBean under a certain name to the platform MBeanServer

Parameters:

pMBean - MBean to register

pOptionalName - optional name under which the bean should be registered. If not provided, it depends on whether the MBean to register implements MBeanRegistration or not.

Returns:

the name under which the MBean is registered.

Throws:

MalformedObjectNameException

NotCompliantMBeanException

InstanceAlreadyExistsException

destroy

public final void destroy()
                   throws JMException

Unregister all previously registered MBean. This is tried for all previously registered MBeans

Throws:

JMException - if an exception occurs during unregistration

getMBeanServerManager

public MBeanServerExecutorLocal getMBeanServerManager()

Get the set of MBeanServers found

Returns:

set of mbean servers

getServerHandle

public ServerHandle getServerHandle()

Get information about the detected server this agent is running on.

Returns:

the server info if detected or null if no server could be detected.

mBeanServersInfo

public String mBeanServersInfo()

Get a description of all MBeanServers found

Specified by:

mBeanServersInfo in interface MBeanServerHandlerMBean

Returns:

a description of all MBeanServers along with their stored MBeans

preRegister

public ObjectName preRegister(MBeanServer server,
                     ObjectName name)
                       throws MalformedObjectNameException

Specified by:

preRegister in interface MBeanRegistration

Throws:

MalformedObjectNameException

getObjectName

public final String getObjectName()

postRegister

public void postRegister(Boolean registrationDone)

Specified by:

postRegister in interface MBeanRegistration

preDeregister

public void preDeregister()

Specified by:

preDeregister in interface MBeanRegistration

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration