org.apache.camel.builder.endpoint.dsl

Interface SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

SjmsBatchEndpointBuilderFactory

public static interface SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint for the Simple JMS Batch component.

Method Summary

Modifier and Type	Method and Description
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	asyncStartListener(boolean asyncStartListener) Whether to startup the consumer message listener asynchronously, when starting a route.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	asyncStartListener(String asyncStartListener) Whether to startup the consumer message listener asynchronously, when starting a route.
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder	basic()
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	jmsKeyFormatStrategy(Object jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	jmsKeyFormatStrategy(String jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	keepAliveDelay(int keepAliveDelay) The delay in millis between attempts to re-establish a valid session.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	keepAliveDelay(String keepAliveDelay) The delay in millis between attempts to re-establish a valid session.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	messageCreatedStrategy(Object messageCreatedStrategy) To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	messageCreatedStrategy(String messageCreatedStrategy) To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	recoveryInterval(int recoveryInterval) Specifies the interval between recovery attempts, i.e.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	recoveryInterval(String recoveryInterval) Specifies the interval between recovery attempts, i.e.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	timeoutCheckerExecutorService(ScheduledExecutorService timeoutCheckerExecutorService) If using the completionInterval option a background thread is created to trigger the completion interval.
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder	timeoutCheckerExecutorService(String timeoutCheckerExecutorService) If using the completionInterval option a background thread is created to trigger the completion interval.

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 SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder basic()

exceptionHandler

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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 SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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 SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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 SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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

asyncStartListener

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder asyncStartListener(boolean asyncStartListener)

Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStartListener

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder asyncStartListener(String asyncStartListener)

Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

headerFilterStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder jmsKeyFormatStrategy(Object jmsKeyFormatStrategy)

Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation. The option is a: <code>org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy</code> type. Group: advanced

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder jmsKeyFormatStrategy(String jmsKeyFormatStrategy)

Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation. The option will be converted to a <code>org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy</code> type. Group: advanced

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

keepAliveDelay

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder keepAliveDelay(int keepAliveDelay)

The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an Exception during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value then the SjmsBatchConsumer will bail out and the consumer will not stop consuming new messages. The default is 5000 ms, that is, 5 seconds. The option is a: <code>int</code> type. Default: 5000 Group: advanced

Parameters:

keepAliveDelay - the value to set

Returns:

the dsl builder

keepAliveDelay

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder keepAliveDelay(String keepAliveDelay)

The delay in millis between attempts to re-establish a valid session. If this is a positive value the SjmsBatchConsumer will attempt to create a new session if it sees an Exception during message consumption. This delay value allows you to pause between attempts to prevent spamming the logs. If this is a negative value then the SjmsBatchConsumer will bail out and the consumer will not stop consuming new messages. The default is 5000 ms, that is, 5 seconds. The option will be converted to a <code>int</code> type. Default: 5000 Group: advanced

Parameters:

keepAliveDelay - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder messageCreatedStrategy(Object messageCreatedStrategy)

To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. The option is a: <code>org.apache.camel.component.sjms.jms.MessageCreatedStrategy</code> type. Group: advanced

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder messageCreatedStrategy(String messageCreatedStrategy)

To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. The option will be converted to a <code>org.apache.camel.component.sjms.jms.MessageCreatedStrategy</code> type. Group: advanced

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

recoveryInterval

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder recoveryInterval(int recoveryInterval)

Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. The option is a: <code>int</code> type. Default: 5000 Group: advanced

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

recoveryInterval

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder recoveryInterval(String recoveryInterval)

Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. The option will be converted to a <code>int</code> type. Default: 5000 Group: advanced

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

synchronous

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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 SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder 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

timeoutCheckerExecutorService

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder timeoutCheckerExecutorService(ScheduledExecutorService timeoutCheckerExecutorService)

If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: advanced

Parameters:

timeoutCheckerExecutorService - the value to set

Returns:

the dsl builder

timeoutCheckerExecutorService

default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder timeoutCheckerExecutorService(String timeoutCheckerExecutorService)

If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: advanced

Parameters:

timeoutCheckerExecutorService - the value to set

Returns:

the dsl builder