Interface JMXEndpointBuilderFactory.JMXEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- JMXEndpointBuilderFactory
public static interface JMXEndpointBuilderFactory.JMXEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the JMX component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
differenceMode
(boolean differenceMode) If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only).differenceMode
(String differenceMode) If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only).Format for the message body.granularityPeriod
(long granularityPeriod) The frequency to poll the bean to check the monitor (monitor types only).granularityPeriod
(String granularityPeriod) The frequency to poll the bean to check the monitor (monitor types only).initThreshold
(int initThreshold) Initial threshold for the monitor.initThreshold
(String initThreshold) Initial threshold for the monitor.modulus
(int modulus) The value at which the counter is reset to zero (counter monitor only).The value at which the counter is reset to zero (counter monitor only).monitorType
(String monitorType) The type of monitor to create.notifyDiffer
(boolean notifyDiffer) If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer).notifyDiffer
(String notifyDiffer) If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer).notifyHigh
(boolean notifyHigh) If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only).notifyHigh
(String notifyHigh) If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only).notifyLow
(boolean notifyLow) If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only).If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only).notifyMatch
(boolean notifyMatch) If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer).notifyMatch
(String notifyMatch) If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer).objectDomain
(String objectDomain) The domain for the mbean you're connecting to.objectName
(String objectName) The name key for the mbean you're connecting to.observedAttribute
(String observedAttribute) The attribute to observe for the monitor bean or consumer.offset
(int offset) The amount to increment the threshold after it's been exceeded (counter monitor only).The amount to increment the threshold after it's been exceeded (counter monitor only).Credentials for making a remote connection.stringToCompare
(String stringToCompare) Value for attribute to compare (string monitor or consumer).thresholdHigh
(Double thresholdHigh) Value for the gauge's high threshold (gauge monitor only).thresholdHigh
(String thresholdHigh) Value for the gauge's high threshold (gauge monitor only).thresholdLow
(Double thresholdLow) Value for the gauge's low threshold (gauge monitor only).thresholdLow
(String thresholdLow) Value for the gauge's low threshold (gauge monitor only).Credentials for making a remote connection.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
format
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. The option is a: <code>java.lang.String</code> type. Default: xml Group: consumer- Parameters:
format
- the value to set- Returns:
- the dsl builder
-
granularityPeriod
The frequency to poll the bean to check the monitor (monitor types only). The option is a: <code>long</code> type. Default: 10000 Group: consumer- Parameters:
granularityPeriod
- the value to set- Returns:
- the dsl builder
-
granularityPeriod
The frequency to poll the bean to check the monitor (monitor types only). The option will be converted to a <code>long</code> type. Default: 10000 Group: consumer- Parameters:
granularityPeriod
- the value to set- Returns:
- the dsl builder
-
monitorType
The type of monitor to create. One of string, gauge, counter (monitor types only). The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
monitorType
- the value to set- Returns:
- the dsl builder
-
objectDomain
The domain for the mbean you're connecting to. The option is a: <code>java.lang.String</code> type. Required: true Group: consumer- Parameters:
objectDomain
- the value to set- Returns:
- the dsl builder
-
objectName
The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
objectName
- the value to set- Returns:
- the dsl builder
-
observedAttribute
The attribute to observe for the monitor bean or consumer. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
observedAttribute
- the value to set- Returns:
- the dsl builder
-
initThreshold
Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only). The option is a: <code>int</code> type. Group: counter- Parameters:
initThreshold
- the value to set- Returns:
- the dsl builder
-
initThreshold
Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only). The option will be converted to a <code>int</code> type. Group: counter- Parameters:
initThreshold
- the value to set- Returns:
- the dsl builder
-
modulus
The value at which the counter is reset to zero (counter monitor only). The option is a: <code>int</code> type. Group: counter- Parameters:
modulus
- the value to set- Returns:
- the dsl builder
-
modulus
The value at which the counter is reset to zero (counter monitor only). The option will be converted to a <code>int</code> type. Group: counter- Parameters:
modulus
- the value to set- Returns:
- the dsl builder
-
offset
The amount to increment the threshold after it's been exceeded (counter monitor only). The option is a: <code>int</code> type. Group: counter- Parameters:
offset
- the value to set- Returns:
- the dsl builder
-
offset
The amount to increment the threshold after it's been exceeded (counter monitor only). The option will be converted to a <code>int</code> type. Group: counter- Parameters:
offset
- the value to set- Returns:
- the dsl builder
-
differenceMode
If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only). The option is a: <code>boolean</code> type. Default: false Group: gauge- Parameters:
differenceMode
- the value to set- Returns:
- the dsl builder
-
differenceMode
If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only). The option will be converted to a <code>boolean</code> type. Default: false Group: gauge- Parameters:
differenceMode
- the value to set- Returns:
- the dsl builder
-
notifyHigh
If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only). The option is a: <code>boolean</code> type. Default: false Group: gauge- Parameters:
notifyHigh
- the value to set- Returns:
- the dsl builder
-
notifyHigh
If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only). The option will be converted to a <code>boolean</code> type. Default: false Group: gauge- Parameters:
notifyHigh
- the value to set- Returns:
- the dsl builder
-
notifyLow
If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only). The option is a: <code>boolean</code> type. Default: false Group: gauge- Parameters:
notifyLow
- the value to set- Returns:
- the dsl builder
-
notifyLow
If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only). The option will be converted to a <code>boolean</code> type. Default: false Group: gauge- Parameters:
notifyLow
- the value to set- Returns:
- the dsl builder
-
thresholdHigh
Value for the gauge's high threshold (gauge monitor only). The option is a: <code>java.lang.Double</code> type. Group: gauge- Parameters:
thresholdHigh
- the value to set- Returns:
- the dsl builder
-
thresholdHigh
Value for the gauge's high threshold (gauge monitor only). The option will be converted to a <code>java.lang.Double</code> type. Group: gauge- Parameters:
thresholdHigh
- the value to set- Returns:
- the dsl builder
-
thresholdLow
Value for the gauge's low threshold (gauge monitor only). The option is a: <code>java.lang.Double</code> type. Group: gauge- Parameters:
thresholdLow
- the value to set- Returns:
- the dsl builder
-
thresholdLow
Value for the gauge's low threshold (gauge monitor only). The option will be converted to a <code>java.lang.Double</code> type. Group: gauge- Parameters:
thresholdLow
- the value to set- Returns:
- the dsl builder
-
password
Credentials for making a remote connection. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
user
Credentials for making a remote connection. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
user
- the value to set- Returns:
- the dsl builder
-
notifyDiffer
If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured. The option is a: <code>boolean</code> type. Default: false Group: string- Parameters:
notifyDiffer
- the value to set- Returns:
- the dsl builder
-
notifyDiffer
If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured. The option will be converted to a <code>boolean</code> type. Default: false Group: string- Parameters:
notifyDiffer
- the value to set- Returns:
- the dsl builder
-
notifyMatch
If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured. The option is a: <code>boolean</code> type. Default: false Group: string- Parameters:
notifyMatch
- the value to set- Returns:
- the dsl builder
-
notifyMatch
If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured. The option will be converted to a <code>boolean</code> type. Default: false Group: string- Parameters:
notifyMatch
- the value to set- Returns:
- the dsl builder
-
stringToCompare
Value for attribute to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured. The option is a: <code>java.lang.String</code> type. Group: string- Parameters:
stringToCompare
- the value to set- Returns:
- the dsl builder
-