org.jolokia.handler

Class ListHandler

java.lang.Object

org.jolokia.handler.JsonRequestHandler<JmxListRequest>

org.jolokia.handler.ListHandler

public class ListHandler
extends JsonRequestHandler<JmxListRequest>

Handler for obtaining a list of all available MBeans and its attributes and operations.

Since:

Jun 12, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
ListHandler(Restrictor pRestrictor) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForRestriction(JmxListRequest pRequest) Check whether there is a restriction on the type to apply.
Object	doHandleRequest(MBeanServerConnection server, JmxListRequest request) Abstract method to be subclassed by a concrete handler for performing the request.
Object	doHandleRequest(MBeanServerExecutor pServerManager, JmxListRequest 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(JmxListRequest pRequest) Return true since a list handler needs to merge all information
boolean	useReturnValueWithPath() Use the path for the return value by default

Methods inherited from class org.jolokia.handler.JsonRequestHandler

checkForModifiedSince, checkType, getRestrictor, handleRequest, handleRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

ListHandler

public ListHandler(Restrictor pRestrictor)

Constructor

Parameters:

pRestrictor - restrictor to apply

Method Detail

getType

public RequestType getType()

The type of request which can be served by this handler

Specified by:

getType in class JsonRequestHandler<JmxListRequest>

Returns:

the request typ of this handler

handleAllServersAtOnce

public boolean handleAllServersAtOnce(JmxListRequest pRequest)

Return true since a list handler needs to merge all information

Overrides:

handleAllServersAtOnce in class JsonRequestHandler<JmxListRequest>

Parameters:

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

Returns:

always true

checkForRestriction

protected void checkForRestriction(JmxListRequest 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

Specified by:

checkForRestriction in class JsonRequestHandler<JmxListRequest>

Parameters:

pRequest - request to check

doHandleRequest

public Object doHandleRequest(MBeanServerExecutor pServerManager,
                     JmxListRequest pRequest)
                       throws IOException,
                              NotChangedException

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<JmxListRequest>

Parameters:

pServerManager - all MBean servers found in this JVM

pRequest - the original request

Returns:

the result of the the request.

Throws:

IOException

NotChangedException

doHandleRequest

public Object doHandleRequest(MBeanServerConnection server,
                     JmxListRequest request)
                       throws InstanceNotFoundException,
                              AttributeNotFoundException,
                              ReflectionException,
                              MBeanException

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

Specified by:

doHandleRequest in class JsonRequestHandler<JmxListRequest>

Parameters:

server - server to try

request - request to process

Returns:

the object result from the request

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

useReturnValueWithPath

public boolean useReturnValueWithPath()

Description copied from class: JsonRequestHandler

Use the path for the return value by default

Overrides:

useReturnValueWithPath in class JsonRequestHandler<JmxListRequest>

Returns:

true