org.jolokia.backend

Class LocalRequestDispatcher

java.lang.Object

org.jolokia.backend.LocalRequestDispatcher

All Implemented Interfaces:

RequestDispatcher

public class LocalRequestDispatcher
extends Object
implements RequestDispatcher

Dispatcher which dispatches to one or more local MBeanServer.

Since:

Nov 11, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
LocalRequestDispatcher(Converters pConverters, Restrictor pRestrictor, Configuration pConfig, LogHandler pLogHandler) Create a new local dispatcher which accesses local MBeans.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(JmxRequest pJmxRequest) Check whether current dispatcher can handle the given request
void	destroy() Unregister the config MBean
Object	dispatchRequest(JmxRequest pJmxReq) Dispatch a JmxRequest to a certain backend and return the result of the JMX action.
ServerHandle	getServerHandle() Get information about the current server
void	initMBeans(HistoryStore pHistoryStore, DebugStore pDebugStore) Initialise this request dispatcher, which will register a ConfigMBean for easy external access to the HistoryStore and DebugStore.
boolean	useReturnValueWithPath(JmxRequest pJmxRequest) Whether a return value should be returned directly, ignoring any path.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalRequestDispatcher

public LocalRequestDispatcher(Converters pConverters,
                              Restrictor pRestrictor,
                              Configuration pConfig,
                              LogHandler pLogHandler)

Create a new local dispatcher which accesses local MBeans.

Parameters:

pConverters - object/string converters

pRestrictor - restrictor which checks the access for various operations

pConfig - agent configuration

pLogHandler - local handler used for logging out errors and warnings

Method Detail

canHandle

public boolean canHandle(JmxRequest pJmxRequest)

Check whether current dispatcher can handle the given request

Specified by:

canHandle in interface RequestDispatcher

Parameters:

pJmxRequest - request to check

Returns:

true if this dispatcher can handle the request

useReturnValueWithPath

public boolean useReturnValueWithPath(JmxRequest pJmxRequest)

Whether a return value should be returned directly, ignoring any path. E.g for the WriteHandler this is important to return the original value, (using the path would return the new value)

Specified by:

useReturnValueWithPath in interface RequestDispatcher

Parameters:

pJmxRequest - request for getting the handler

Returns:

true if the path within the request should be respected, false if the value should be directly returned

dispatchRequest

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

Dispatch a JmxRequest to a certain backend and return the result of the JMX action.

Specified by:

dispatchRequest in interface RequestDispatcher

Parameters:

pJmxReq - the request to dispatch

Returns:

result object

Throws:

InstanceNotFoundException - when a certain MBean could not be found

AttributeNotFoundException - in case an attributes couldnt be resolved

ReflectionException

MBeanException

NotChangedException

initMBeans

public void initMBeans(HistoryStore pHistoryStore,
                       DebugStore pDebugStore)
                throws MalformedObjectNameException,
                       MBeanRegistrationException,
                       NotCompliantMBeanException

Initialise this request dispatcher, which will register a ConfigMBean for easy external access to the HistoryStore and DebugStore. Also a JolokiaDiscoveryMBean is registered

Parameters:

pHistoryStore - history store to be managed from within an MBean

pDebugStore - managed debug store

Throws:

MalformedObjectNameException - if our MBean's name is wrong (which cannot happen)

MBeanRegistrationException - if registration fails

NotCompliantMBeanException - if we have a non compliant MBean (cannot happen, too)

destroy

public void destroy()
             throws JMException

Unregister the config MBean

Throws:

JMException - if unregistration fails

getServerHandle

public ServerHandle getServerHandle()

Get information about the current server

Returns:

the server information