org.jolokia.request

Class JmxRequest

java.lang.Object

org.jolokia.request.JmxRequest

Direct Known Subclasses:

JmxListRequest, JmxObjectNameRequest, JmxVersionRequest

public abstract class JmxRequest
extends Object

Abstract base class for a JMX request. This is the server side representation of a Jolokia request.

Since:

15.03.11

Author:

roland

Constructor Summary

Constructors

Modifier	Constructor and Description
	JmxRequest(Map<String,?> pMap, ProcessingParameters pInitParams) Constructor used for HttpMethod.POST requests, which receive a JSON payload.
protected	JmxRequest(RequestType pType, List<String> pPathParts, ProcessingParameters pProcessingParams) Constructor used for representing HttpMethod.GET requests.

Method Summary

Methods

Modifier and Type	Method and Description
HttpMethod	getHttpMethod() HTTP method used for creating this request
protected String	getInfo() Textual description of this request containing base information.
String	getParameter(ConfigKey pConfigKey) Get a processing configuration or null if not set
Boolean	getParameterAsBool(ConfigKey pConfigKey) Get a processing configuration as a boolean value
int	getParameterAsInt(ConfigKey pConfigKey) Get a processing configuration as integer or null if not set
String	getPath() Get the path combined with proper escaping
List<String>	getPathParts() Get the parts of a path
ProxyTargetConfig	getTargetConfig() Get the proxy target configuration provided with the request
RequestType	getType() Get request type
ValueFaultHandler	getValueFaultHandler() Get tha value fault handler, which can be passwed around.
org.json.simple.JSONObject	toJSON() Convert this request to a JSON object, which can be used as a part of a return value.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxRequest

protected JmxRequest(RequestType pType,
          List<String> pPathParts,
          ProcessingParameters pProcessingParams)

Constructor used for representing HttpMethod.GET requests.

Parameters:

pType - request type

pPathParts - an optional path, splitted up in parts. Not all requests do handle a path.

pProcessingParams - init parameters provided as query params for a GET request. They are used to to influence the processing.

JmxRequest

public JmxRequest(Map<String,?> pMap,
          ProcessingParameters pInitParams)

Constructor used for HttpMethod.POST requests, which receive a JSON payload.

Parameters:

pMap - map containing requests parameters

pInitParams - optional processing parameters (obtained as query parameters or from within the JSON request)

Method Detail

getType

public RequestType getType()

Get request type

Returns:

request type of this request.

getParameter

public String getParameter(ConfigKey pConfigKey)

Get a processing configuration or null if not set

Parameters:

pConfigKey - configuration key to fetch

Returns:

string value or null if not set

getParameterAsInt

public int getParameterAsInt(ConfigKey pConfigKey)

Get a processing configuration as integer or null if not set

Parameters:

pConfigKey - configuration to lookup

Returns:

integer value of configuration or 0 if not set.

getParameterAsBool

public Boolean getParameterAsBool(ConfigKey pConfigKey)

Get a processing configuration as a boolean value

Parameters:

pConfigKey - configuration to lookup

Returns:

boolean value of the configuration, the default value or false if the default value is null

getTargetConfig

public ProxyTargetConfig getTargetConfig()

Get the proxy target configuration provided with the request

Returns:

the proxy target configuration or null if the the request is not a proxy based request.

getHttpMethod

public HttpMethod getHttpMethod()

HTTP method used for creating this request

Returns:

HTTP method which lead to this request

getValueFaultHandler

public ValueFaultHandler getValueFaultHandler()

Get tha value fault handler, which can be passwed around.

Returns:

the value fault handler

getInfo

protected String getInfo()

Textual description of this request containing base information. Can be used in toString() methods of subclasses

Returns:

description of this base request

getPathParts

public List<String> getPathParts()

Get the parts of a path

Returns:

the parts of an path or null if no path was used

getPath

public String getPath()

Get the path combined with proper escaping

Returns:

path as string or null if no path is given.

toJSON

public org.json.simple.JSONObject toJSON()

Convert this request to a JSON object, which can be used as a part of a return value.

Returns:

JSON object representing this base request object