org.jolokia.client.request

Class J4pReadResponse

java.lang.Object

org.jolokia.client.request.J4pResponse<J4pReadRequest>

org.jolokia.client.request.J4pReadResponse

public final class J4pReadResponse
extends J4pResponse<J4pReadRequest>

Response for a J4pType.READ request. Since a single READ request can result in multiple values returned, this response object allows for obtaining iteration of those values in case the MBean name given for the request was a pattern of when multiple attributes were requested.

Since:

Apr 26, 2010

Author:

roland

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getAttributes() Get all attributes obtained.
Collection<String>	getAttributes(ObjectName pObjectName) Get the name of all attributes fetched for a certain MBean name.
Collection<ObjectName>	getObjectNames() Get all MBean names for which the request fetched values.
<V> V	getValue(ObjectName pObjectName, String pAttribute) Get the value for a certain MBean and a given attribute.
<V> V	getValue(String pAttribute) Get the value for a single attribute.

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

asJSONObject, getRequest, getRequestDate, getType, getValue

Methods inherited from class java.lang.Object

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

Method Detail

getObjectNames

public Collection<ObjectName> getObjectNames()
                                      throws MalformedObjectNameException

Get all MBean names for which the request fetched values. If the request contained an MBean pattern then all MBean names matching this pattern and which contained attributes of the given name are returned. If the MBean wasnt a pattern a single value collection with the single MBean name of the request is returned.

Returns:

list of MBean names

Throws:

MalformedObjectNameException - if the returned MBean names could not be converted to ObjectNames. Shouldnt occur, though.

getAttributes

public Collection<String> getAttributes(ObjectName pObjectName)

Get the name of all attributes fetched for a certain MBean name. If the request was performed for a single MBean, then the given name must match that of the MBean name provided in the request. If null is given as argument, then this method will return all attributes for the single MBean given in the request

Parameters:

pObjectName - MBean for which to get the attribute names,

Returns:

a collection of attribute names

getAttributes

public Collection<String> getAttributes()

Get all attributes obtained. This method can be only used, if the requested MBean was not a pattern (i.e. the request was for a single MBean).

Returns:

a list of attributes for this request. If the request was performed for only a single attribute, the attribute name of the request is returend as a single valued list. For more than one attribute, the attribute names a returned from the returned list.

getValue

public <V> V getValue(ObjectName pObjectName,
             String pAttribute)

Get the value for a certain MBean and a given attribute. This method is especially useful if the request leading to this response was done for multiple MBeans (i.e. a read for an MBean pattern) and multiple attributes. However, this method can be used for a request for single MBeans and single attributes as well, but then the given parameters must match the parameters given in the request.

Type Parameters:

V - the object type of the return value (String,Map or List)

Parameters:

pObjectName - name of the Mbean or null if the request was only for a single Mbeans in which case this single MBean is taken from the request

pAttribute - the attribute or null if the request was for a single attribute in which case the attribute name is taken from the request

Returns:

the value

Throws:

IllegalArgumentException - if there was no value for the given parameters or if null was given for given for one or both arguments and the request was for multiple MBeans or attributes.

getValue

public <V> V getValue(String pAttribute)

Get the value for a single attribute. This method is appropriate if the request was done for a single MBean (no pattern), but multiple attributes. If it is called for a request with non-pattern MBean and a single attribute, the given attribute must match the attribute of the request. If this method is called with a null argument, then it will return the value if the request was for a single attribute, otherwise it will raise an IllegalArgumentException

Type Parameters:

V - value type

Parameters:

pAttribute - attribute for which to get the value

Returns:

value

Throws:

IllegalArgumentException - if the attribute could not be found in the return value or if this method is called with a null argument, but the request leads to multiple attribute return values.