org.jolokia.handler

Class ReadHandler

java.lang.Object

org.jolokia.handler.JsonRequestHandler<JmxReadRequest>

org.jolokia.handler.ReadHandler

public class ReadHandler
extends JsonRequestHandler<JmxReadRequest>

Handler for managing READ requests for reading attributes.

Since:

Jun 12, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
ReadHandler(Restrictor pRestrictor) Read handler constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForRestriction(JmxReadRequest pRequest) We override it here with a noop since we do a more fine grained check during processing of the request.
Object	doHandleRequest(MBeanServerConnection pServer, JmxReadRequest pRequest) Used for a request to a single attribute from a single MBean.
Object	doHandleRequest(MBeanServerExecutor pServerManager, JmxReadRequest pRequest) Default implementation fo handling a request for multiple servers at once.
RequestType	getType() The type of request which can be served by this handler
boolean	handleAllServersAtOnce(JmxReadRequest pRequest) For a simple requests (one MBean, one attribute) we let the dispatching of the servers done by the upper level.

Methods inherited from class org.jolokia.handler.JsonRequestHandler

checkForModifiedSince, checkType, getRestrictor, handleRequest, handleRequest, useReturnValueWithPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadHandler

public ReadHandler(Restrictor pRestrictor)

Read handler constructor

Parameters:

pRestrictor - access restriction to apply

Method Detail

getType

public RequestType getType()

Description copied from class: JsonRequestHandler

The type of request which can be served by this handler

Specified by:

getType in class JsonRequestHandler<JmxReadRequest>

Returns:

the request typ of this handler

handleAllServersAtOnce

public boolean handleAllServersAtOnce(JmxReadRequest pRequest)

For a simple requests (one MBean, one attribute) we let the dispatching of the servers done by the upper level. If the request is for an MBean pattern or multiple attributes are required, we try multiple requests for multiple server.

Overrides:

handleAllServersAtOnce in class JsonRequestHandler<JmxReadRequest>

Parameters:

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

Returns:

true if this is a multi attribute request, has an MBean pattern to look for or is a request for all attributes.

doHandleRequest

public Object doHandleRequest(MBeanServerConnection pServer,
                     JmxReadRequest pRequest)
                       throws InstanceNotFoundException,
                              AttributeNotFoundException,
                              ReflectionException,
                              MBeanException,
                              IOException

Used for a request to a single attribute from a single MBean. Merging of MBeanServers is done one layer above.

Specified by:

doHandleRequest in class JsonRequestHandler<JmxReadRequest>

Parameters:

pServer - server on which to request the attribute

pRequest - the request itself.

Returns:

the attribute's value

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException

doHandleRequest

public Object doHandleRequest(MBeanServerExecutor pServerManager,
                     JmxReadRequest pRequest)
                       throws InstanceNotFoundException,
                              AttributeNotFoundException,
                              ReflectionException,
                              MBeanException,
                              IOException

Description copied from class: JsonRequestHandler

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

Overrides:

doHandleRequest in class JsonRequestHandler<JmxReadRequest>

Parameters:

pServerManager - all MBean servers found in this JVM

pRequest - the original request

Returns:

the result of the the request.

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException

checkForRestriction

protected void checkForRestriction(JmxReadRequest pRequest)

We override it here with a noop since we do a more fine grained check during processing of the request.

Specified by:

checkForRestriction in class JsonRequestHandler<JmxReadRequest>

Parameters:

pRequest - request to check