org.jolokia.backend

Class BackendManager

java.lang.Object

org.jolokia.backend.BackendManager

All Implemented Interfaces:

AgentDetailsHolder

public class BackendManager
extends Object
implements AgentDetailsHolder

Backendmanager for dispatching to various backends based on a given JmxRequest

Since:

Nov 11, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
BackendManager(Configuration pConfig, LogHandler pLogHandler) Construct a new backend manager with the given configuration and which allows every operation (no restrictor)
BackendManager(Configuration pConfig, LogHandler pLogHandler, Restrictor pRestrictor) Construct a new backend manager with the given configuration.
BackendManager(Configuration pConfig, LogHandler pLogHandler, Restrictor pRestrictor, boolean pLazy) Construct a new backend manager with the given configuration.

Method Summary

Modifier and Type	Method and Description
Object	convertExceptionToJson(Throwable pExp, JmxRequest pJmxReq) Convert a Throwable to a JSON object so that it can be included in an error response
void	debug(String msg) Log at debug level
void	destroy() Remove MBeans
void	error(String message, Throwable t) Log at error level.
AgentDetails	getAgentDetails() Get the details for the agent which can be updated or used
org.json.simple.JSONObject	handleRequest(JmxRequest pJmxReq) Handle a single JMXRequest.
void	info(String msg) Log at info level
boolean	isDebug() Whether debug is switched on
boolean	isOriginAllowed(String pOrigin, boolean pStrictChecking) Check whether CORS access is allowed for the given origin.
boolean	isRemoteAccessAllowed(String pRemoteHost, String pRemoteAddr) Check whether remote access from the given client is allowed.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendManager

public BackendManager(Configuration pConfig,
                      LogHandler pLogHandler)

Construct a new backend manager with the given configuration and which allows every operation (no restrictor)

Parameters:

pConfig - configuration used for tuning this handler's behaviour

pLogHandler - logger

BackendManager

public BackendManager(Configuration pConfig,
                      LogHandler pLogHandler,
                      Restrictor pRestrictor)

Construct a new backend manager with the given configuration.

Parameters:

pConfig - configuration used for tuning this handler's behaviour

pLogHandler - logger

pRestrictor - a restrictor for limiting access. Can be null in which case every operation is allowed

BackendManager

public BackendManager(Configuration pConfig,
                      LogHandler pLogHandler,
                      Restrictor pRestrictor,
                      boolean pLazy)

Construct a new backend manager with the given configuration.

Parameters:

pConfig - configuration map used for tuning this handler's behaviour

pLogHandler - logger

pRestrictor - a restrictor for limiting access. Can be null in which case every operation is allowed

pLazy - whether the initialisation should be done lazy

Method Detail

handleRequest

public org.json.simple.JSONObject handleRequest(JmxRequest pJmxReq)
                                         throws InstanceNotFoundException,
                                                AttributeNotFoundException,
                                                ReflectionException,
                                                MBeanException,
                                                IOException

Handle a single JMXRequest. The response status is set to 200 if the request was successful

Parameters:

pJmxReq - request to perform

Returns:

the already converted answer.

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException

convertExceptionToJson

public Object convertExceptionToJson(Throwable pExp,
                                     JmxRequest pJmxReq)

Convert a Throwable to a JSON object so that it can be included in an error response

Parameters:

pExp - throwable to convert

pJmxReq - the request from where to take the serialization options

Returns:

the exception.

destroy

public void destroy()

Remove MBeans

isRemoteAccessAllowed

public boolean isRemoteAccessAllowed(String pRemoteHost,
                                     String pRemoteAddr)

Check whether remote access from the given client is allowed.

Parameters:

pRemoteHost - remote host to check against. Can be null if no reverse lookup is configured.

pRemoteAddr - alternative IP address

Returns:

true if remote access is allowed

isOriginAllowed

public boolean isOriginAllowed(String pOrigin,
                               boolean pStrictChecking)

Check whether CORS access is allowed for the given origin.

Parameters:

pOrigin - origin URL which needs to be checked

pStrictChecking - whether to a strict check (i.e. server side check)

Returns:

true if if cors access is allowed

info

public void info(String msg)

Log at info level

Parameters:

msg - to log

debug

public void debug(String msg)

Log at debug level

Parameters:

msg - message to log

error

public void error(String message,
                  Throwable t)

Log at error level.

Parameters:

message - message to log

t - ecxeption occured

isDebug

public boolean isDebug()

Whether debug is switched on

Returns:

true if debug is switched on

getAgentDetails

public AgentDetails getAgentDetails()

Get the details for the agent which can be updated or used

Specified by:

getAgentDetails in interface AgentDetailsHolder

Returns:

agent details