org.apache.camel.builder.endpoint.dsl

Interface JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

Enclosing interface:

JMXEndpointBuilderFactory

public static interface JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint for the JMX component.

Method Summary

Modifier and Type	Method and Description
default JMXEndpointBuilderFactory.JMXEndpointBuilder	basic()
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	executorService(ExecutorService executorService) To use a custom shared thread pool for the consumers.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	executorService(String executorService) To use a custom shared thread pool for the consumers.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	handback(Object handback) Value to handback to the listener when a notification is received.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	handback(String handback) Value to handback to the listener when a notification is received.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	notificationFilter(Object notificationFilter) Reference to a bean that implements the NotificationFilter.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	notificationFilter(String notificationFilter) Reference to a bean that implements the NotificationFilter.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	objectProperties(Map values) Properties for the object name.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	objectProperties(String key, Object value) Properties for the object name.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	reconnectDelay(int reconnectDelay) The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	reconnectDelay(String reconnectDelay) The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	reconnectOnConnectionFailure(boolean reconnectOnConnectionFailure) If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	reconnectOnConnectionFailure(String reconnectOnConnectionFailure) If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) If true the consumer will throw an exception if unable to establish the JMX connection upon startup.
default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup) If true the consumer will throw an exception if unable to establish the JMX connection upon startup.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default JMXEndpointBuilderFactory.JMXEndpointBuilder basic()

exceptionHandler

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

executorService

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder executorService(ExecutorService executorService)

To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications. The option is a: <code>java.util.concurrent.ExecutorService</code> type. Group: advanced

Parameters:

executorService - the value to set

Returns:

the dsl builder

executorService

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder executorService(String executorService)

To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications. The option will be converted to a <code>java.util.concurrent.ExecutorService</code> type. Group: advanced

Parameters:

executorService - the value to set

Returns:

the dsl builder

handback

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder handback(Object handback)

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. The option is a: <code>java.lang.Object</code> type. Group: advanced

Parameters:

handback - the value to set

Returns:

the dsl builder

handback

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder handback(String handback)

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. The option will be converted to a <code>java.lang.Object</code> type. Group: advanced

Parameters:

handback - the value to set

Returns:

the dsl builder

notificationFilter

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder notificationFilter(Object notificationFilter)

Reference to a bean that implements the NotificationFilter. The option is a: <code>javax.management.NotificationFilter</code> type. Group: advanced

Parameters:

notificationFilter - the value to set

Returns:

the dsl builder

notificationFilter

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder notificationFilter(String notificationFilter)

Reference to a bean that implements the NotificationFilter. The option will be converted to a <code>javax.management.NotificationFilter</code> type. Group: advanced

Parameters:

notificationFilter - the value to set

Returns:

the dsl builder

objectProperties

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder objectProperties(String key,
                                                                              Object value)

Properties for the object name. These values will be used if the objectName param is not set. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. The option is multivalued, and you can use the objectProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

objectProperties

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder objectProperties(Map values)

Properties for the object name. These values will be used if the objectName param is not set. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. The option is multivalued, and you can use the objectProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

values - the values

Returns:

the dsl builder

reconnectDelay

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder reconnectDelay(int reconnectDelay)

The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection. The option is a: <code>int</code> type. Default: 10 Group: advanced

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder reconnectDelay(String reconnectDelay)

The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection. The option will be converted to a <code>int</code> type. Default: 10 Group: advanced

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectOnConnectionFailure

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder reconnectOnConnectionFailure(boolean reconnectOnConnectionFailure)

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. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

reconnectOnConnectionFailure - the value to set

Returns:

the dsl builder

reconnectOnConnectionFailure

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder reconnectOnConnectionFailure(String reconnectOnConnectionFailure)

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. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

reconnectOnConnectionFailure - the value to set

Returns:

the dsl builder

synchronous

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder testConnectionOnStartup(boolean testConnectionOnStartup)

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. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default JMXEndpointBuilderFactory.AdvancedJMXEndpointBuilder testConnectionOnStartup(String testConnectionOnStartup)

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. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder