org.jolokia.client.request

Enum J4pQueryParameter

java.lang.Object

java.lang.Enum<J4pQueryParameter>

org.jolokia.client.request.J4pQueryParameter

All Implemented Interfaces:

Serializable, Comparable<J4pQueryParameter>

public enum J4pQueryParameter
extends Enum<J4pQueryParameter>

Query parameters which can be used when requesting the server

Since:

15.09.11

Author:

roland

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL_NAMING Whether property keys of ObjectNames should be ordered in the canonical way or in the way that they are created.
IF_MODIFIED_SINCE For LIST request this property can be used to obtain the result (which can be quite lengthy) only if the set of registered MBeans has been changed since the last time (given as epoch time in seconds since 1.1.1970) provided with this parameterd
IGNORE_ERRORS Runtime configuration (i.e. must come in with a request) for ignoring errors during JMX operations and JSON serialization.
INCLUDE_STACKTRACE Whether to include a stack trace in the response when an error occurs.
MAX_COLLECTION_SIZE Maximum size of collections returned during serialization.
MAX_DEPTH Maximum traversal depth for serialization of complex objects.
MAX_OBJECTS Maximum number of objects returned by serialization
SERIALIZE_EXCEPTION Whether to include a JSON serialized version of the exception.

Method Summary

Methods

Modifier and Type	Method and Description
String	getParam()
static J4pQueryParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static J4pQueryParameter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAX_DEPTH

public static final J4pQueryParameter MAX_DEPTH

Maximum traversal depth for serialization of complex objects.

MAX_COLLECTION_SIZE

public static final J4pQueryParameter MAX_COLLECTION_SIZE

Maximum size of collections returned during serialization. If larger, the collection is truncated

MAX_OBJECTS

public static final J4pQueryParameter MAX_OBJECTS

Maximum number of objects returned by serialization

IGNORE_ERRORS

public static final J4pQueryParameter IGNORE_ERRORS

Runtime configuration (i.e. must come in with a request) for ignoring errors during JMX operations and JSON serialization. This works only for certain operations like pattern reads.

INCLUDE_STACKTRACE

public static final J4pQueryParameter INCLUDE_STACKTRACE

Whether to include a stack trace in the response when an error occurs. The allowed values are "true" for inclusion, "false" if no stacktrace should be included or "runtime" if only RuntimeExceptions should be included. Default is "true"

SERIALIZE_EXCEPTION

public static final J4pQueryParameter SERIALIZE_EXCEPTION

Whether to include a JSON serialized version of the exception. If set to "true", the exception is added under the key "error_value" in the response. Default is false.

CANONICAL_NAMING

public static final J4pQueryParameter CANONICAL_NAMING

Whether property keys of ObjectNames should be ordered in the canonical way or in the way that they are created. The allowed values are either "true" in which case the canonical key order (== alphabetical sorted) is used or "false" for getting the keys as registered. Default is "true"

IF_MODIFIED_SINCE

public static final J4pQueryParameter IF_MODIFIED_SINCE

For LIST request this property can be used to obtain the result (which can be quite lengthy) only if the set of registered MBeans has been changed since the last time (given as epoch time in seconds since 1.1.1970) provided with this parameterd

Method Detail

values

public static J4pQueryParameter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (J4pQueryParameter c : J4pQueryParameter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static J4pQueryParameter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getParam

public String getParam()