org.jolokia.client.request

Class J4pRequest

java.lang.Object

org.jolokia.client.request.J4pRequest

Direct Known Subclasses:

AbtractJ4pMBeanRequest, J4pListRequest, J4pVersionRequest

public abstract class J4pRequest
extends Object

Request object abstracting a request to a j4p agent.

Since:

Apr 24, 2010

Author:

roland

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	J4pRequest(J4pType pType, J4pTargetConfig pTargetConfig) Constructor for subclasses

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPath(List<String> pParts, String pPath)
static String	escape(String pInput) Escape a input (like the part of an path) so that it can be safely used e.g.
String	getPreferredHttpMethod() The preferred HTTP method to use (either 'GET' or 'POST')
J4pTargetConfig	getTargetConfig() Get a target configuration for use with an agent in JSR-160 proxy mode
J4pType	getType() Get the type of the request
protected Object	serializeArgumentToJson(Object pArg) Serialize an object to an string or JSON structure for write/exec POST requests.
protected String	serializeArgumentToRequestPart(Object pArg) Serialize an object to a string which can be uses as URL part in a GET request when object should be transmitted to the agent.
void	setPreferredHttpMethod(String pPreferredHttpMethod) Set the preferred HTTP method, either 'GET' or 'POST'.
protected List<String>	splitPath(String pArg) Split up a path taking into account proper escaping (as descibed in the reference manual).

Methods inherited from class java.lang.Object

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

Constructor Detail

J4pRequest

protected J4pRequest(J4pType pType,
          J4pTargetConfig pTargetConfig)

Constructor for subclasses

Parameters:

pType - type of this request

pTargetConfig - a target configuration if used in proxy mode or null if this is a direct request

Method Detail

escape

public static String escape(String pInput)

Escape a input (like the part of an path) so that it can be safely used e.g. as a path

Parameters:

pInput - input to escape

Returns:

the escaped input

getType

public J4pType getType()

Get the type of the request

Returns:

request's type

getTargetConfig

public J4pTargetConfig getTargetConfig()

Get a target configuration for use with an agent in JSR-160 proxy mode

Returns:

the target config or null if this is a direct request

getPreferredHttpMethod

public String getPreferredHttpMethod()

The preferred HTTP method to use (either 'GET' or 'POST')

Returns:

the HTTP method to use for this request, or null if the method should be automatically selected.

setPreferredHttpMethod

public void setPreferredHttpMethod(String pPreferredHttpMethod)

Set the preferred HTTP method, either 'GET' or 'POST'.

Parameters:

pPreferredHttpMethod - HTTP method to use.

addPath

protected void addPath(List<String> pParts,
           String pPath)

serializeArgumentToRequestPart

protected String serializeArgumentToRequestPart(Object pArg)

Serialize an object to a string which can be uses as URL part in a GET request when object should be transmitted to the agent. The serialization is rather limited: If it is an array, the array's member's string representation are used in a comma separated list (without escaping so far, so the strings must not contain any commas themselves). If it is not an array, the string representation ist used (Object.toString()) Any null value is transformed in the special marker [null] which on the agent side is converted back into a null.

You should consider POST requests when you need a more sophisticated JSON serialization.

Parameters:

pArg - the argument to serialize for an GET request

Returns:

the string representation

serializeArgumentToJson

protected Object serializeArgumentToJson(Object pArg)

Serialize an object to an string or JSON structure for write/exec POST requests. Serialization is up to now rather limited:

• If the argument is null null is returned.
• If the argument is of type JSONAware, the it is used directly for inclusion in the POST request.
• If the argument is an array, this array's content is put into an JSONArray, where each array member is serialized recursively.
• If the argument is a map, it is transformed into a JSONObject with the keys taken directly from the map and the values recursively serialized to their JSON representation. So it is only save fto use or a simple map with string keys.
• If the argument is a Collection, it is transformed into a JSONArray with the values recursively serialized to their JSON representaion.
• Otherwise the object is used directly.

Future version of this lib will probably provide a more sophisticated serialization mechanism. This is how it is supposed to be for the next release, currently a simplified serialization is in place

Parameters:

pArg - the object to serialize

Returns:

a JSON serialized object

splitPath

protected List<String> splitPath(String pArg)

Split up a path taking into account proper escaping (as descibed in the reference manual).

Parameters:

pArg - string to split with escaping taken into account

Returns:

splitted element or null if the argument was null.