Package org.jolokia.service.jmx.handler

Class ExecHandler

java.lang.Object

org.jolokia.service.jmx.handler.AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

org.jolokia.service.jmx.handler.ExecHandler

All Implemented Interfaces:

CommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

public class ExecHandler
extends AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Handler for dealing with execute requests.

Since:

Jun 12, 2009

Author:

roland

Field Summary

Fields inherited from class org.jolokia.service.jmx.handler.AbstractCommandHandler

context, pProvider

Constructor Summary

Constructors

Constructor	Description
ExecHandler()

Method Summary

Modifier and Type	Method	Description
protected void	checkForRestriction(org.jolokia.server.core.request.JolokiaExecRequest pRequest)	Check whether there is a restriction on the type to apply.
Object	doHandleAllServerRequest(org.jolokia.server.core.util.jmx.MBeanServerAccess pServerManager, org.jolokia.server.core.request.JolokiaExecRequest pRequest, Object pPreviousResult)	Default implementation fo handling a request for multiple servers at once.
Object	doHandleSingleServerRequest(MBeanServerConnection server, org.jolokia.server.core.request.JolokiaExecRequest request)	Execute an JMX operation.
org.jolokia.server.core.util.RequestType	getType()	The type of request which can be served by this handler
boolean	handleAllServersAtOnce(org.jolokia.server.core.request.JolokiaExecRequest pRequest)	EXEC may be performed on multiple objects if they match the ObjectName pattern

Methods inherited from class org.jolokia.service.jmx.handler.AbstractCommandHandler

checkForModifiedSince, checkType, destroy, handleAllServerRequest, handleSingleServerRequest, init, isObjectNameHidden

Methods inherited from class java.lang.Object

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

Constructor Details

ExecHandler

public ExecHandler()

Method Details

getType

public 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

checkForRestriction

protected void checkForRestriction(org.jolokia.server.core.request.JolokiaExecRequest 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 AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Parameters:

pRequest - request to check

handleAllServersAtOnce

public boolean handleAllServersAtOnce(org.jolokia.server.core.request.JolokiaExecRequest pRequest)

EXEC may be performed on multiple objects if they match the ObjectName pattern

Specified by:

handleAllServersAtOnce in interface CommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Overrides:

handleAllServersAtOnce in class AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Parameters:

pRequest -

Returns:

doHandleSingleServerRequest

public Object doHandleSingleServerRequest(MBeanServerConnection server,
 org.jolokia.server.core.request.JolokiaExecRequest request)
                                   throws InstanceNotFoundException,
ReflectionException,
MBeanException,
IOException

Execute an JMX operation. The operation name is taken from the request, as well as the arguments to use. If the operation is given in the format "op(type1,type2,...)" (e.g "getText(java.lang.String,int)" then the argument types are taken into account as well. This way, overloaded JMX operation can be used. If an overloaded JMX operation is called without specifying the argument types, then an exception is raised.

Specified by:

doHandleSingleServerRequest in class AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Parameters:

server - server to try

request - request to process from where the operation and its arguments are extracted.

Returns:

the return value of the operation call

Throws:

InstanceNotFoundException

ReflectionException

MBeanException

IOException

doHandleAllServerRequest

public Object doHandleAllServerRequest(org.jolokia.server.core.util.jmx.MBeanServerAccess pServerManager,
 org.jolokia.server.core.request.JolokiaExecRequest pRequest,
 Object pPreviousResult)
                                throws InstanceNotFoundException,
AttributeNotFoundException,
ReflectionException,
MBeanException,
IOException

Description copied from class: AbstractCommandHandler

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

Overrides:

doHandleAllServerRequest in class AbstractCommandHandler<org.jolokia.server.core.request.JolokiaExecRequest>

Parameters:

pServerManager - all MBean servers found in this JVM

pRequest - the original request

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

Returns:

the result of the the request.

Throws:

InstanceNotFoundException

AttributeNotFoundException

ReflectionException

MBeanException

IOException