org.jolokia.handler

Class SearchHandler

java.lang.Object

org.jolokia.handler.JsonRequestHandler<JmxSearchRequest>

org.jolokia.handler.SearchHandler

public class SearchHandler
extends JsonRequestHandler<JmxSearchRequest>

Handler responsible for searching for MBean names.

Since:

Jun 18, 2009

Author:

roland

Constructor Summary

Constructors

Constructor and Description
SearchHandler(Restrictor pRestrictor) Create search handler

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForRestriction(JmxSearchRequest pRequest) Check whether there is a restriction on the type to apply.
protected Object	doHandleRequest(MBeanServerConnection server, JmxSearchRequest request) Abstract method to be subclassed by a concrete handler for performing the request.
Object	doHandleRequest(MBeanServerExecutor serverManager, JmxSearchRequest request) 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(JmxSearchRequest pRequest) Override this if you want all servers as list in the argument, e.g.

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

SearchHandler

public SearchHandler(Restrictor pRestrictor)

Create search handler

Parameters:

pRestrictor - access restriction 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<JmxSearchRequest>

Returns:

the request typ of this handler

checkForRestriction

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

Parameters:

pRequest - request to check

doHandleRequest

public Object doHandleRequest(MBeanServerExecutor serverManager,
                     JmxSearchRequest request)
                       throws MBeanException,
                              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<JmxSearchRequest>

Parameters:

serverManager -

request -

Returns:

the result of the the request.

Throws:

MBeanException

IOException

NotChangedException

handleAllServersAtOnce

public boolean handleAllServersAtOnce(JmxSearchRequest 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

Overrides:

handleAllServersAtOnce in class JsonRequestHandler<JmxSearchRequest>

Parameters:

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

Returns:

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

doHandleRequest

protected Object doHandleRequest(MBeanServerConnection server,
                     JmxSearchRequest request)
                          throws InstanceNotFoundException,
                                 AttributeNotFoundException,
                                 ReflectionException,
                                 MBeanException,
                                 IOException

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

Specified by:

doHandleRequest in class JsonRequestHandler<JmxSearchRequest>

Parameters:

server - server to try

request - request to process

Returns:

the object result from the request

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException