org.jolokia.handler

Class JsonRequestHandler<R extends JmxRequest>

java.lang.Object

org.jolokia.handler.JsonRequestHandler<R>

Direct Known Subclasses:

ExecHandler, ListHandler, ReadHandler, SearchHandler, VersionHandler, WriteHandler

public abstract class JsonRequestHandler<R extends JmxRequest>
extends Object

Since:

Jun 12, 2009

Author:

roland

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonRequestHandler(Restrictor pRestrictor)

Method Summary

Modifier and Type	Method and Description
protected void	checkForModifiedSince(MBeanServerExecutor pServerManager, JmxRequest pRequest) Check, whether the set of MBeans for any managed MBeanServer has been change since the timestamp provided in the given request
protected abstract void	checkForRestriction(R pRequest) Check whether there is a restriction on the type to apply.
protected void	checkType() Check whether a command of the given type is allowed
protected abstract Object	doHandleRequest(MBeanServerConnection server, R request) Abstract method to be subclassed by a concrete handler for performing the request.
Object	doHandleRequest(MBeanServerExecutor serverManager, R request) Default implementation fo handling a request for multiple servers at once.
protected Restrictor	getRestrictor() Get the restrictor which is currently active
abstract RequestType	getType() The type of request which can be served by this handler
boolean	handleAllServersAtOnce(R pRequest) Override this if you want all servers as list in the argument, e.g.
Object	handleRequest(MBeanServerConnection pServer, R pRequest) Handle a request for a single server and throw an InstanceNotFoundException if the request cannot be handle by the provided server.
Object	handleRequest(MBeanServerExecutor pServerManager, R request) Override this if you want to have all servers at once for processing the request (like need for merging info as for a list command).
boolean	useReturnValueWithPath() Use the path for the return value by default

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRequestHandler

protected JsonRequestHandler(Restrictor pRestrictor)

Method Detail

getType

public abstract RequestType getType()

The type of request which can be served by this handler

Returns:

the request typ of this handler

handleAllServersAtOnce

public boolean handleAllServersAtOnce(R pRequest)

Override this if you want all servers as list in the argument, e.g. to query each server on your own. By default, dispatching of the servers are done for you

Parameters:

pRequest - request to decide on whether to handle all request at once

Returns:

whether you want to have doHandleRequest(MBeanServerConnection, JmxRequest) (false) or doHandleRequest(MBeanServerExecutor, JmxRequest) (true) called.

handleRequest

public Object handleRequest(MBeanServerConnection pServer,
                            R pRequest)
                     throws InstanceNotFoundException,
                            AttributeNotFoundException,
                            ReflectionException,
                            MBeanException,
                            IOException,
                            NotChangedException

Handle a request for a single server and throw an InstanceNotFoundException if the request cannot be handle by the provided server. Does a check for restrictions as well

Parameters:

pServer - server to try

pRequest - request to process

Returns:

the object result from the request

Throws:

InstanceNotFoundException - if the provided server cant handle the request

AttributeNotFoundException

ReflectionException

MBeanException

IOException

NotChangedException

checkForRestriction

protected abstract void checkForRestriction(R pRequest)

Check whether there is a restriction on the type to apply. This method should be overwritten by specific handlers if they support a more sophisticated check than only for the type

Parameters:

pRequest - request to check

checkType

protected void checkType()

Check whether a command of the given type is allowed

doHandleRequest

protected abstract Object doHandleRequest(MBeanServerConnection server,
                                          R request)
                                   throws InstanceNotFoundException,
                                          AttributeNotFoundException,
                                          ReflectionException,
                                          MBeanException,
                                          IOException,
                                          NotChangedException

Abstract method to be subclassed by a concrete handler for performing the request.

Parameters:

server - server to try

request - request to process

Returns:

the object result from the request

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException

NotChangedException

handleRequest

public Object handleRequest(MBeanServerExecutor pServerManager,
                            R request)
                     throws ReflectionException,
                            InstanceNotFoundException,
                            MBeanException,
                            AttributeNotFoundException,
                            IOException,
                            NotChangedException

Override this if you want to have all servers at once for processing the request (like need for merging info as for a list command). This method is only called when handleAllServersAtOnce(JmxRequest) returns true

Parameters:

pServerManager - server manager holding all MBeans servers detected

request - request to process

Returns:

the object found

Throws:

IOException

AttributeNotFoundException

InstanceNotFoundException

MBeanException

ReflectionException

NotChangedException

doHandleRequest

public Object doHandleRequest(MBeanServerExecutor serverManager,
                              R request)
                       throws InstanceNotFoundException,
                              AttributeNotFoundException,
                              ReflectionException,
                              MBeanException,
                              IOException,
                              NotChangedException

Default implementation fo handling a request for multiple servers at once. A subclass, which returns, true on handleAllServersAtOnce(JmxRequest), needs to override this method.

Parameters:

serverManager - all MBean servers found in this JVM

request - the original request

Returns:

the result of the the request.

Throws:

IOException

AttributeNotFoundException

InstanceNotFoundException

MBeanException

ReflectionException

NotChangedException

useReturnValueWithPath

public boolean useReturnValueWithPath()

Use the path for the return value by default

Returns:

true

getRestrictor

protected Restrictor getRestrictor()

Get the restrictor which is currently active

Returns:

restrictor

checkForModifiedSince

protected void checkForModifiedSince(MBeanServerExecutor pServerManager,
                                     JmxRequest pRequest)
                              throws NotChangedException

Check, whether the set of MBeans for any managed MBeanServer has been change since the timestamp provided in the given request

Parameters:

pServerManager - manager for all MBeanServers

pRequest - the request from where to fetch the timestamp

Throws:

NotChangedException - if there has been no REGISTER/UNREGISTER notifications in the meantime