org.jolokia.request

Class JmxObjectNameRequest

java.lang.Object

org.jolokia.request.JmxRequest

org.jolokia.request.JmxObjectNameRequest

Direct Known Subclasses:

JmxExecRequest, JmxReadRequest, JmxSearchRequest, JmxWriteRequest

public abstract class JmxObjectNameRequest
extends JmxRequest

Abstract JMX request which takes an object name.

Since:

15.03.11

Author:

roland

Constructor Summary

Constructors

Constructor and Description
JmxObjectNameRequest(Map<String,?> pRequestMap, ProcessingParameters pParams) Constructor for POST requests
JmxObjectNameRequest(RequestType pType, String pObjectName, List<String> pPathParts, ProcessingParameters pProcessingParams) Constructor for GET requests

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getInfo() Textual description of this request containing base information.
ObjectName	getObjectName() Get object name of MBean
String	getObjectNameAsString() String representation of the object name for this request.
String	getOrderedObjectName(ObjectName pName) Name prepared according to requested formatting note.
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 org.jolokia.request.JmxRequest

getHttpMethod, getParameter, getParameterAsBool, getParameterAsInt, getPath, getPathParts, getTargetConfig, getType, getValueFaultHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxObjectNameRequest

public JmxObjectNameRequest(RequestType pType,
                    String pObjectName,
                    List<String> pPathParts,
                    ProcessingParameters pProcessingParams)
                     throws MalformedObjectNameException

Constructor for GET requests

Parameters:

pType - request type

pObjectName - object name, which must not be null.

pPathParts - parts of an path

pProcessingParams - optional init params

Throws:

MalformedObjectNameException - if the given MBean name is not a valid object name

JmxObjectNameRequest

public JmxObjectNameRequest(Map<String,?> pRequestMap,
                    ProcessingParameters pParams)
                     throws MalformedObjectNameException

Constructor for POST requests

Parameters:

pRequestMap - object representation of the request

pParams - processing parameters

Throws:

MalformedObjectNameException - if the given MBean name (key: "mbean") is not a valid object name.

Method Detail

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.

Overrides:

toJSON in class JmxRequest

Returns:

JSON object representing this base request object

getInfo

protected String getInfo()

Description copied from class: JmxRequest

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

Overrides:

getInfo in class JmxRequest

Returns:

description of this base request

getObjectName

public ObjectName getObjectName()

Get object name of MBean

Returns:

the object name

getObjectNameAsString

public String getObjectNameAsString()

String representation of the object name for this request.

Returns:

the object name a string representation

getOrderedObjectName

public String getOrderedObjectName(ObjectName pName)

Name prepared according to requested formatting note. The key ordering can be influenced by the processing parameter ConfigKey.CANONICAL_NAMING. If not given or set to "true", then the canonical order is used, if set to "initial" the name is given to construction time is used.

Parameters:

pName - name to format

Returns:

formatted string