JMXEndpointBuilderFactory.JMXEndpointBuilder (Camel

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

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder`	`advanced()`
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`bridgeErrorHandler(String bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`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).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`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).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`format(String format)` Format for the message body.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`granularityPeriod(long granularityPeriod)` The frequency to poll the bean to check the monitor (monitor types only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`granularityPeriod(String granularityPeriod)` The frequency to poll the bean to check the monitor (monitor types only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`initThreshold(int initThreshold)` Initial threshold for the monitor.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`initThreshold(String initThreshold)` Initial threshold for the monitor.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`modulus(int modulus)` The value at which the counter is reset to zero (counter monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`modulus(String modulus)` The value at which the counter is reset to zero (counter monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`monitorType(String monitorType)` The type of monitor to create.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyDiffer(boolean notifyDiffer)` If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyDiffer(String notifyDiffer)` If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyHigh(boolean notifyHigh)` If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyHigh(String notifyHigh)` If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyLow(boolean notifyLow)` If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyLow(String notifyLow)` If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyMatch(boolean notifyMatch)` If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`notifyMatch(String notifyMatch)` If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`objectDomain(String objectDomain)` The domain for the mbean you're connecting to.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`objectName(String objectName)` The name key for the mbean you're connecting to.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`observedAttribute(String observedAttribute)` The attribute to observe for the monitor bean or consumer.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`offset(int offset)` The amount to increment the threshold after it's been exceeded (counter monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`offset(String offset)` The amount to increment the threshold after it's been exceeded (counter monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`password(String password)` Credentials for making a remote connection.
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`stringToCompare(String stringToCompare)` Value for attribute to compare (string monitor or consumer).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`thresholdHigh(Double thresholdHigh)` Value for the gauge's high threshold (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`thresholdHigh(String thresholdHigh)` Value for the gauge's high threshold (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`thresholdLow(Double thresholdLow)` Value for the gauge's low threshold (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`thresholdLow(String thresholdLow)` Value for the gauge's low threshold (gauge monitor only).
`default JMXEndpointBuilderFactory.JMXEndpointBuilder`	`user(String user)` Credentials for making a remote connection.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder advanced()
```
  - bridgeErrorHandler
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder bridgeErrorHandler(String bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - format
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder format(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder granularityPeriod(long 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder granularityPeriod(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder monitorType(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder objectDomain(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder objectName(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder observedAttribute(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder initThreshold(int 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder initThreshold(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder modulus(int 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder modulus(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder offset(int 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder offset(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder 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). The option is a: <code>boolean</code> type. Default: false Group: gauge
    
    Parameters:
    
    differenceMode - the value to set
    
    Returns:
    
    the dsl builder
  - differenceMode
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder 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). 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyHigh(boolean 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyHigh(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyLow(boolean 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyLow(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder thresholdHigh(Double 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder thresholdHigh(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder thresholdLow(Double 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder thresholdLow(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder password(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder user(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyDiffer(boolean 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyDiffer(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyMatch(boolean 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder notifyMatch(String 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
```
default JMXEndpointBuilderFactory.JMXEndpointBuilder stringToCompare(String 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

Interface JMXEndpointBuilderFactory.JMXEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

bridgeErrorHandler

bridgeErrorHandler

format

granularityPeriod

granularityPeriod

monitorType

objectDomain

objectName

observedAttribute

initThreshold

initThreshold

modulus

modulus

offset

offset

differenceMode

differenceMode

notifyHigh

notifyHigh

notifyLow

notifyLow

thresholdHigh

thresholdHigh

thresholdLow

thresholdLow

password

user

notifyDiffer

notifyDiffer

notifyMatch

notifyMatch

stringToCompare