Interface CommandHandler<R extends org.jolokia.server.core.request.JolokiaRequest>

All Known Implementing Classes:

AbstractCommandHandler, ExecHandler, ListHandler, NotificationHandler, ReadHandler, SearchHandler, WriteHandler

public interface CommandHandler<R extends org.jolokia.server.core.request.JolokiaRequest>

Since:

09.03.14

Author:

roland

Method Summary

Modifier and Type	Method	Description
void	destroy()	Lifecycle method called when agent goes down.
org.jolokia.server.core.util.RequestType	getType()	The type of request which can be served by this handler
Object	handleAllServerRequest(org.jolokia.server.core.util.jmx.MBeanServerAccess pServerManager, R request, Object pPreviousResult)	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	handleAllServersAtOnce(R pRequest)	Override this if you want all servers as list in the argument, e.g.
Object	handleSingleServerRequest(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.
void	init(org.jolokia.server.core.service.api.JolokiaContext pContext, String pProvider)	Lifecycle method in order to initialize the handler

Method Details

getType

org.jolokia.server.core.util.RequestType getType()

The type of request which can be served by this handler

Returns:

the request typ of this handler

handleAllServersAtOnce

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 handleSingleServerRequest(MBeanServerConnection, JolokiaRequest) (false) or handleAllServerRequest(MBeanServerAccess, JolokiaRequest, Object) (true) called.

handleSingleServerRequest

Object handleSingleServerRequest(MBeanServerConnection pServer,
 R pRequest)
                          throws InstanceNotFoundException,
AttributeNotFoundException,
ReflectionException,
MBeanException,
IOException,
org.jolokia.server.core.request.NotChangedException,
org.jolokia.server.core.request.EmptyResponseException

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

org.jolokia.server.core.request.NotChangedException

org.jolokia.server.core.request.EmptyResponseException

handleAllServerRequest

Object handleAllServerRequest(org.jolokia.server.core.util.jmx.MBeanServerAccess pServerManager,
 R request,
 Object pPreviousResult)
                       throws ReflectionException,
InstanceNotFoundException,
MBeanException,
AttributeNotFoundException,
IOException,
org.jolokia.server.core.request.NotChangedException,
org.jolokia.server.core.request.EmptyResponseException

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(JolokiaRequest) returns true

Parameters:

pServerManager - server manager holding all MBeans servers detected

request - request to process

pPreviousResult - a previous result which for merging requests can be used to merge files

Returns:

the object found

Throws:

IOException

AttributeNotFoundException

InstanceNotFoundException

MBeanException

ReflectionException

org.jolokia.server.core.request.NotChangedException

org.jolokia.server.core.request.EmptyResponseException

init

void init(org.jolokia.server.core.service.api.JolokiaContext pContext,
 String pProvider)

Lifecycle method in order to initialize the handler

Parameters:

pContext - the jolokia context

pProvider - provider to use for returned names. Handlers can use this for returning meta data with the proper provider prefixed.

destroy

void destroy()
      throws JMException

Lifecycle method called when agent goes down. Should be overridden by a handler if required.

Throws:

JMException