org.jolokia.client.request

Class J4pReadRequest

java.lang.Object

org.jolokia.client.request.J4pRequest

org.jolokia.client.request.AbtractJ4pMBeanRequest

org.jolokia.client.request.J4pReadRequest

public class J4pReadRequest
extends AbtractJ4pMBeanRequest

A read request to get one or more attributes from one or more MBeans within a single request.

Since:

Apr 24, 2010

Author:

roland

Constructor Summary

Constructors

Constructor and Description
J4pReadRequest(J4pTargetConfig pTargetConfig, ObjectName pObjectName, String... pAttribute) Create a READ request to request one or more attributes from the remote j4p agent
J4pReadRequest(J4pTargetConfig pTargetConfig, String pObjectName, String... pAttribute) Create a READ request to request one or more attributes from the remote j4p agent
J4pReadRequest(ObjectName pObjectName, String... pAttribute) Create a READ request to request one or more attributes from the remote j4p agent
J4pReadRequest(String pObjectName, String... pAttribute) Create a READ request to request one or more attributes from the remote j4p agent

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute() If this request is for a single attribute, this attribute is returned by this getter.
Collection<String>	getAttributes() Get all attributes of this request.
String	getPath() Get the path for extracting parts of the return value
boolean	hasAllAttributes() Whether all attributes should be fetched
boolean	hasSingleAttribute() Whether this request represents a request for a single attribute
void	setPath(String pPath) Set the path for diving into the return value

Methods inherited from class org.jolokia.client.request.AbtractJ4pMBeanRequest

getObjectName

Methods inherited from class org.jolokia.client.request.J4pRequest

addPath, escape, getPreferredHttpMethod, getTargetConfig, getType, serializeArgumentToJson, serializeArgumentToRequestPart, setPreferredHttpMethod, splitPath

Methods inherited from class java.lang.Object

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

Constructor Detail

J4pReadRequest

public J4pReadRequest(ObjectName pObjectName,
              String... pAttribute)

Create a READ request to request one or more attributes from the remote j4p agent

Parameters:

pObjectName - Name of the MBean to request, which can be a pattern in which case the given attributes are looked at all MBeans matched by this pattern. If an attribute does not fit to a matched MBean it is ignored.

pAttribute - one or more attributes to request.

J4pReadRequest

public J4pReadRequest(J4pTargetConfig pTargetConfig,
              ObjectName pObjectName,
              String... pAttribute)

Create a READ request to request one or more attributes from the remote j4p agent

Parameters:

pTargetConfig - proxy target configuration or null if no proxy should be used

pObjectName - Name of the MBean to request, which can be a pattern in which case the given attributes are looked at all MBeans matched by this pattern. If an attribute does not fit to a matched MBean it is ignored.

pAttribute - one or more attributes to request.

J4pReadRequest

public J4pReadRequest(String pObjectName,
              String... pAttribute)
               throws MalformedObjectNameException

Create a READ request to request one or more attributes from the remote j4p agent

Parameters:

pObjectName - object name as sting which gets converted to a ObjectName}

pAttribute - zero, one or more attributes to request.

Throws:

MalformedObjectNameException - when argument is not a valid object name

J4pReadRequest

public J4pReadRequest(J4pTargetConfig pTargetConfig,
              String pObjectName,
              String... pAttribute)
               throws MalformedObjectNameException

Create a READ request to request one or more attributes from the remote j4p agent

Parameters:

pTargetConfig - proxy target configuration or null if no proxy should be used

pObjectName - object name as sting which gets converted to a ObjectName}

pAttribute - zero, one or more attributes to request.

Throws:

MalformedObjectNameException - when argument is not a valid object name

Method Detail

getAttributes

public Collection<String> getAttributes()

Get all attributes of this request. This list can be empty if all attributes should be fetched.

Returns:

attributes

getAttribute

public String getAttribute()

If this request is for a single attribute, this attribute is returned by this getter.

Returns:

single attribute

Throws:

IllegalArgumentException - if no or more than one attribute are used when this request was constructed.

hasSingleAttribute

public boolean hasSingleAttribute()

Whether this request represents a request for a single attribute

Returns:

true if the client request is for a single attribute

hasAllAttributes

public boolean hasAllAttributes()

Whether all attributes should be fetched

Returns:

true if all attributes should be fetched

getPath

public String getPath()

Get the path for extracting parts of the return value

Returns:

path used for extracting

setPath

public void setPath(String pPath)

Set the path for diving into the return value

Parameters:

pPath - path to set