org.jolokia.support.spring.jolokia-config.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jolokia-support-spring Show documentation
Show all versions of jolokia-support-spring Show documentation
Jolokia :: Support :: Spring JVM Agent
A JVM Jolokia agent for exposing JMX via Jolokia.
Optional id for specifying this servers name as it
can be referenced from the Spring application context.
If set to true, externally defined configurations are looked
up and used according to their order in addition to the configuration
defined withing this tag.
If set to true, externally defined Jolokia-services are looked up
and added to the set of services to use. Please refer to the documentation
of org.jolokia.server.core.service.api.JolokiaService for details.
If set to true, the application context itself is exposed over the Jolokia protocol.
The container can be reached by using the provider prefix 'spring@'.
The Jolokia MBeanServer which can be used to hide MBean from JSR-160 exports and for
handling @JsonMBeans.
Id for specifying this servers name as it
can be referenced from the Spring application context.
Configuration for a log handler to be used.
Referenced to a Spring Bean implementing org.jolokia.server.core.service.api.LogHandler which then is used
for logging.
Specify which logging backend to use. Available are "log4j2" for Log4J2, "slf4j" for SLF4J,
"jul" for java.util.logging, "commons" for Commons Logging and "logback" for, well, LogBack.
The corresponding libraries must be in the classpath, otherwise things get nasty.
How I love this logging heaven !
The logging category used (and yes, I still call it "category" ;-). By default it's
"org.jolokia".
Configuration for a Jolokia JVM agent
Order in which configuration should be applied. This attribute is
only used when the <jolokia:server>
is configured with "lookup-config" set to true. If multiple
<jolokia:config> config objects exist, they get applied in the provided
order. This attribute is ignored when using <jolokia:config> within a
<jolokia:server> configuration. Embedded configuration always serves as
default value with the lowest precedence. The higher the
order the higher the importance/precedence configuration is.
Host address to listen to. Default is InetAddress.getLocalHost()
Port to listen to. Default is 8778.
Whether to start the Jolokia server automatically. Default is true.
Protocol to use for communication. Can be either "http" or "https".
Threading model of the HTTP server:
"fixed" -- Thread pool with a fixed number of threads (see also "thread-nr"),
"cached" -- Cached thread pool which creates threads on demand,
"single" -- A single thread only
Thread name prefix that executor will use while creating new thread(s)
(default: jolokia-)
Number of threads to use when the execution model is configured to "fixed".
(See attribute "executor")
Size of request backlog before requests get discarded.
Whether client certificates should be used for authentication (https only).
Path to the SSL keystore to use (https only)
Keystore password (https only)
Secure protocol (https only, default: TLS)
Keystore type (https only, default: JKS)
Key manager algorithm (https only, default: SunX509)
Trust manager algorithm (https only, default: SunX509)
User which is allowed to connect
Password for authenticating the user.
Security realm to use
What authentication to use. Support values: "basic" for basic authentication, "jaas" for
JaaS authentication.
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.
Custom authenticator to be used instead of default user/password one.
Context under which the agent is deployed. The full URL
will be protocol://host:port/context
The ID to uniquely identify this agent within a JVM. There
can be multiple agents registered a JVM. This id is e.g. used to
uniquely create MBean names.
A description which can be used to describe the agent further. Typically
this can be used by clients to provide additional information to
the user.
Maximum number of history entries to keep
Whether debug is switched on or not
Maximum number of debug entries to hold
Maximum traversal depth for serialization of complex objects.
Maximum size of collections returned during serialization.
If larger, the collection is truncated
Maximum number of objects returned by serialization
This option specifies in which order the key-value
properties within ObjectNames as returned by
"list" or "search" are
returned. By default this is the so called 'canonical order'
in which the keys are sorted alphabetically. If this option
is set to false, then the natural order
is used, i.e. the object name as it was registered. This
option can be overridden with a query parameter of the same
name. By default this option is set to 'true'.
Whether to include a stacktrace of an exception in case of
an error. By default it it set to "true"
in which case the stacktrace is always included. If set to
"false", no stacktrace is included. If
the value is "runtime" a stacktrace is
only included for RuntimeExceptions. This global option can
be overridden with a query parameter.
When this parameter is set to "true",
then an exception thrown will be serialized as JSON and
included in the response under the key
"error_value". No stack trace information
will be included, though. This global option can be
overridden by a query parameter of the same name.
Classname of an custom restrictor which must be loadable from the classpath
Location of the policy file
Optional domain name for registering own MBeans
Mime Type to use for the response value. By default, this is
"text/plain", but it could be useful to return
"application/json", too.
Class specifying a loghandler to use. This class requires a now argument
constructor.
Whether to enable listening and responding to discovery multicast requests
for discovering agent details.
Specify the agent URL to return for an discovery multicast request. If this option
is given "discoveryEnabled" is set to 'true' automatically. The URL given can contain placeholders:
"$host" or "${host}" : Host name (if possible), otherwise address --
"$ip" or "${ip}" : IP Address --
"${prop:foo}" : System property foo --
"${env:FOO}" : Environment variable FOO --