public enum ConfigKey extends Enum<ConfigKey>
Enum Constant and Description |
---|
AGENT_CONTEXT
Context used for agent, used e.g.
|
AGENT_DESCRIPTION
A description which can be used to describe the agent further.
|
AGENT_ID
The ID to uniquely identify this agent within a JVM.
|
AGENT_TYPE
The agent type holds the information which kind of agent (war,jvm,osgi,mule)
is in use.
|
ALLOW_DNS_REVERSE_LOOKUP
Whether a reverse DNS lookup is allowed or not.
|
ALLOW_ERROR_DETAILS
Whether expose extended error information like stacktraces or serialized exception
at all.
|
AUTH_CLASS
Custom authenticator to be used instead of default user/password one (JVM agent)
|
AUTH_IGNORE_CERTS
Whether to ignore CERTS when doing a dispatching authentication (authMode == delegate)
|
AUTH_MATCH
If MultiAuthenticator is used, this config item explains how to combine multiple authenticators
Supported values: "any" at least one authenticator must match, "all" all authenticators must match
|
AUTH_MODE
What authentication to use.
|
AUTH_PRINCIPAL_SPEC
Extractor specification for getting the principal (authMode == delegate)
|
AUTH_URL
URL used for a dispatcher authentication (authMode == delegate)
|
CALLBACK
Option which can be given to a request to specify a JSONP callback.
|
CANONICAL_NAMING
Whether property keys of ObjectNames should be ordered in the canonical way or in the way that they
are created.
|
DEBUG
Whether debug is switched on or not
|
DEBUG_MAX_ENTRIES
Maximum number of debug entries to hold
|
DETECTOR_OPTIONS
Extra options passed to a server handle after it has been detected.
|
DISCOVERY_AGENT_URL
Specify the agent URL to return for an discovery multicast request.
|
DISCOVERY_ENABLED
Whether to enable listening and responding to discovery multicast requests
for discovering agent details.
|
DISPATCHER_CLASSES
Request Dispatcher to use in addition to the local dispatcher.
|
HISTORY_MAX_ENTRIES
Maximum number of history entries to keep
|
HTTP_SERVICE_FILTER
By default, the OSGi Agent will bind to all HttpService implementations.
|
IF_MODIFIED_SINCE
For LIST requests, this option can be used to return
the result only if they set of registered MBeans has
been changed since the timestamp given in this option.
|
IGNORE_ERRORS
Runtime configuration (i.e.
|
INCLUDE_STACKTRACE
Whether to include a stack trace in the response when an error occurs.
|
JSR160_PROXY_ALLOWED_TARGETS
Path to a white list of patterns which are matched against possible
JMX service URL for incoming requests
|
LISTEN_FOR_HTTP_SERVICE
By default, the OSGi Agent listens for an OSGi HttpService to which it will register
an agent servlet.
|
LOGHANDLER_CLASS
Log handler class to use, which must have an empty constructor.
|
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
|
MBEAN_PLUGIN_OPTIONS
Extra options which are passed to
MBeanPlugin . |
MBEAN_QUALIFIER
Optional domain name for registering own MBeans
|
MIME_TYPE
Mime Type to use for the response value.
|
MULTICAST_GROUP
IPv4 Address for Jolokia's Multicast group.
|
MULTICAST_PORT
Multicast port where to listen for queries.
|
PASSWORD
Password for authentication purposes.
|
POLICY_LOCATION
Init parameter for the location of the policy file.
|
REALM
The security realm used for login
|
RESTRICTOR_CLASS
Custom restrictor to be used instead of default one
|
SERIALIZE_EXCEPTION
Whether to include a JSON serialized version of the exception.
|
STREAMING
Whether to use streaming json responses.
|
USE_RESTRICTOR_SERVICE
For OSGi, if set to true, the agent uses a restrictor service when it kicks in,
but denies access otherwise.
|
USER
User for authentication purposes.
|
Modifier and Type | Field and Description |
---|---|
static String |
JAAS_SUBJECT_REQUEST_ATTRIBUTE
JAAS Subject to attach to an HTTP request as attribute if JAAS based authentication is in use.
|
Modifier and Type | Method and Description |
---|---|
String |
getDefaultValue()
Get the default value
|
static ConfigKey |
getGlobalConfigKey(String pKeyS)
Get the configuration key for a global configuration
|
String |
getKeyValue()
Get the string value of a key
|
static ConfigKey |
getRequestConfigKey(String pKeyS)
Get the configuration key for a request configuration
|
boolean |
isGlobalConfig()
Whether this key is a global configuration key
|
boolean |
isRequestConfig()
Whether this key is a request configuration key
|
String |
toString() |
static ConfigKey |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ConfigKey[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ConfigKey HISTORY_MAX_ENTRIES
public static final ConfigKey DEBUG
public static final ConfigKey DEBUG_MAX_ENTRIES
public static final ConfigKey DISPATCHER_CLASSES
public static final ConfigKey JSR160_PROXY_ALLOWED_TARGETS
public static final ConfigKey LOGHANDLER_CLASS
public static final ConfigKey MAX_DEPTH
public static final ConfigKey MAX_COLLECTION_SIZE
public static final ConfigKey MAX_OBJECTS
public static final ConfigKey RESTRICTOR_CLASS
public static final ConfigKey POLICY_LOCATION
classpath
then do a class lookup.
The URL given can contain also placeholders which gets replaced:
public static final ConfigKey ALLOW_DNS_REVERSE_LOOKUP
public static final ConfigKey IGNORE_ERRORS
public static final ConfigKey INCLUDE_STACKTRACE
RuntimeException
s should
be included. Default is "true"public static final ConfigKey SERIALIZE_EXCEPTION
public static final ConfigKey ALLOW_ERROR_DETAILS
public static final ConfigKey CANONICAL_NAMING
public static final ConfigKey STREAMING
public static final ConfigKey MBEAN_QUALIFIER
public static final ConfigKey CALLBACK
public static final ConfigKey MIME_TYPE
text/plain
, but it could be useful to return
application/json
, too. A request parameter overrides a global
configuration.public static final ConfigKey IF_MODIFIED_SINCE
public static final ConfigKey DISCOVERY_ENABLED
public static final ConfigKey DISCOVERY_AGENT_URL
DISCOVERY_ENABLED
is set to true
automatically.
The URL given can contain placeholders:
public static final ConfigKey MULTICAST_GROUP
public static final ConfigKey MULTICAST_PORT
public static final ConfigKey USER
public static final ConfigKey PASSWORD
public static final ConfigKey REALM
public static final ConfigKey AUTH_MODE
public static final ConfigKey AUTH_MATCH
public static final ConfigKey AUTH_CLASS
public static final ConfigKey AUTH_URL
public static final ConfigKey AUTH_PRINCIPAL_SPEC
public static final ConfigKey AUTH_IGNORE_CERTS
public static final ConfigKey AGENT_CONTEXT
public static final ConfigKey USE_RESTRICTOR_SERVICE
public static final ConfigKey LISTEN_FOR_HTTP_SERVICE
public static final ConfigKey HTTP_SERVICE_FILTER
The syntax is that of the standard OSGi Filter.
(VirtualServer=__asadmin) - Glassfish 3+ administration server
Note this will be combined with the objectClass filter for HttpService with the and (&) operator.
public static final ConfigKey DETECTOR_OPTIONS
{ "glassfish" : { "bootAmx" : true}, "jboss" : { "disableWorkaround" : true} }
public static final ConfigKey MBEAN_PLUGIN_OPTIONS
MBeanPlugin
. As for DETECTOR_OPTIONS
, the value
must be a JSON object in string representation where the keys are MBean plugin ids and the values are
JSON objects whith the plugin specific configuration.public static final ConfigKey AGENT_ID
public static final ConfigKey AGENT_TYPE
public static final ConfigKey AGENT_DESCRIPTION
public static final String JAAS_SUBJECT_REQUEST_ATTRIBUTE
public static ConfigKey[] values()
for (ConfigKey c : ConfigKey.values()) System.out.println(c);
public static ConfigKey valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static ConfigKey getGlobalConfigKey(String pKeyS)
pKeyS
- the key to lookuppublic static ConfigKey getRequestConfigKey(String pKeyS)
pKeyS
- the key to lookuppublic String getKeyValue()
public String getDefaultValue()
public boolean isGlobalConfig()
public boolean isRequestConfig()
Copyright © 2021. All rights reserved.