JMX

JMX

Scheme: jmx

Endpoint that describes a connection to an mbean.

The component can connect to the local platform mbean server with the following URI:

jmx://platform?options

A remote mbean server url can be provided following the initial JMX scheme like so:

jmx:service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi?options

You can append query options to the URI in the following format, ?options=value&option2=value&...

Name Kind Type Required Deprecated Default Value Enum Values Description
serverURL path java.lang.String false server url comes from the remaining endpoint
observedAttribute parameter java.lang.String false URI Property: [monitor types only] The attribute to observe for the monitor bean.
granularityPeriod parameter long false 10000 URI Property: [monitor types only] The frequency to poll the bean to check the monitor.
monitorType parameter java.lang.String false counter
gauge
string
URI Property: [monitor types only] The type of monitor to create. One of string, gauge, counter.
initThreshold parameter int false URI Property: [counter monitor only] Initial threshold for the monitor. The value must exceed this before notifications are fired.
offset parameter int false URI Property: [counter monitor only] The amount to increment the threshold after it's been exceeded.
modulus parameter int false URI Property: [counter monitor only] The value at which the counter is reset to zero
differenceMode parameter boolean false URI Property: [counter + gauge monitor only] If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself.
notifyHigh parameter boolean false URI Property: [gauge monitor only] If true, the gauge will fire a notification when the high threshold is exceeded
notifyLow parameter boolean false URI Property: [gauge monitor only] If true, the gauge will fire a notification when the low threshold is exceeded
thresholdHigh parameter java.lang.Double false URI Property: [gauge monitor only] Value for the gauge's high threshold
thresholdLow parameter java.lang.Double false URI Property: [gauge monitor only] Value for the gauge's low threshold
notifyDiffer parameter boolean false URI Property: [string monitor only] If true, the string monitor will fire a notification when the string attribute differs from the string to compare.
notifyMatch parameter boolean false URI Property: [string monitor only] If true, the string monitor will fire a notification when the string attribute matches the string to compare.
stringToCompare parameter java.lang.String false URI Property: [string monitor only] Value for the string monitor's string to compare.
format parameter java.lang.String false xml xml
raw
URI Property: Format for the message body. Either "xml" or "raw". If xml, the notification is serialized to xml. If raw, then the raw java object is set as the body.
user parameter java.lang.String false URI Property: credentials for making a remote connection
password parameter java.lang.String false URI Property: credentials for making a remote connection
objectDomain parameter java.lang.String true false URI Property: The domain for the mbean you're connecting to
objectName parameter java.lang.String false URI Property: The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed.
notificationFilter parameter javax.management.NotificationFilter false URI Property: Reference to a bean that implements the NotificationFilter.
handback parameter java.lang.Object false URI Property: Value to handback to the listener when a notification is received. This value will be put in the message header with the key "jmx.handback"
testConnectionOnStartup parameter boolean false true URI Property: If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false, the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay
reconnectOnConnectionFailure parameter boolean false URI Property: If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay
reconnectDelay parameter int false 10 URI Property: The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

jmx consumer

Consumer will add itself as a NotificationListener on the object specified by the objectName param.