SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

SjmsBatchEndpointBuilderFactory
```
public static interface SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint for the Simple JMS Batch component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder`	`advanced()`
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)` The aggregation strategy to use, which merges all the batched messages into a single message.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`aggregationStrategy(String aggregationStrategy)` The aggregation strategy to use, which merges all the batched messages into a single message.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`allowNullBody(boolean allowNullBody)` Whether to allow sending messages with no body.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`allowNullBody(String allowNullBody)` Whether to allow sending messages with no body.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`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 SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`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 SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionInterval(int completionInterval)` The completion interval in millis, which causes batches to be completed in a scheduled fixed rate every interval.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionInterval(String completionInterval)` The completion interval in millis, which causes batches to be completed in a scheduled fixed rate every interval.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionPredicate(org.apache.camel.Predicate completionPredicate)` The completion predicate, which causes batches to be completed when the predicate evaluates as true.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionPredicate(String completionPredicate)` The completion predicate, which causes batches to be completed when the predicate evaluates as true.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionSize(int completionSize)` The number of messages consumed at which the batch will be completed.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionSize(String completionSize)` The number of messages consumed at which the batch will be completed.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionTimeout(int completionTimeout)` The timeout in millis from receipt of the first first message when the batch will be completed.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`completionTimeout(String completionTimeout)` The timeout in millis from receipt of the first first message when the batch will be completed.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`consumerCount(int consumerCount)` The number of JMS sessions to consume from.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`consumerCount(String consumerCount)` The number of JMS sessions to consume from.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`eagerCheckCompletion(boolean eagerCheckCompletion)` Use eager completion checking which means that the completionPredicate will use the incoming Exchange.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`eagerCheckCompletion(String eagerCheckCompletion)` Use eager completion checking which means that the completionPredicate will use the incoming Exchange.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`includeAllJMSXProperties(boolean includeAllJMSXProperties)` Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`includeAllJMSXProperties(String includeAllJMSXProperties)` Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`mapJmsMessage(boolean mapJmsMessage)` Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`mapJmsMessage(String mapJmsMessage)` Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`pollDuration(int pollDuration)` The duration in milliseconds of each poll for messages.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`pollDuration(String pollDuration)` The duration in milliseconds of each poll for messages.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)` If using completion timeout or interval, then the batch may be empty if the timeout triggered and there was no messages in the batch.
`default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder`	`sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)` If using completion timeout or interval, then the batch may be empty if the timeout triggered and there was no messages in the batch.

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
  - advanced
```
default SjmsBatchEndpointBuilderFactory.AdvancedSjmsBatchEndpointBuilder advanced()
```
  - aggregationStrategy
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)
```
    The aggregation strategy to use, which merges all the batched messages into a single message. The option is a: org.apache.camel.AggregationStrategy type. Required: true Group: consumer
  - aggregationStrategy
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder aggregationStrategy(String aggregationStrategy)
```
    The aggregation strategy to use, which merges all the batched messages into a single message. The option will be converted to a org.apache.camel.AggregationStrategy type. Required: true Group: consumer
  - allowNullBody
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder allowNullBody(boolean allowNullBody)
```
    Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option is a: boolean type. Default: true Group: consumer
  - allowNullBody
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder allowNullBody(String allowNullBody)
```
    Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option will be converted to a boolean type. Default: true Group: consumer
  - bridgeErrorHandler
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder 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: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder 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 boolean type. Default: false Group: consumer
  - completionInterval
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionInterval(int completionInterval)
```
    The completion interval in millis, which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time, only one can be configured. The option is a: int type. Default: 1000 Group: consumer
  - completionInterval
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionInterval(String completionInterval)
```
    The completion interval in millis, which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time, only one can be configured. The option will be converted to a int type. Default: 1000 Group: consumer
  - completionPredicate
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionPredicate(org.apache.camel.Predicate completionPredicate)
```
    The completion predicate, which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message, as otherwise it matches the aggregated message. The option is a: org.apache.camel.Predicate type. Group: consumer
  - completionPredicate
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionPredicate(String completionPredicate)
```
    The completion predicate, which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message, as otherwise it matches the aggregated message. The option will be converted to a org.apache.camel.Predicate type. Group: consumer
  - completionSize
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionSize(int completionSize)
```
    The number of messages consumed at which the batch will be completed. The option is a: int type. Default: 200 Group: consumer
  - completionSize
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionSize(String completionSize)
```
    The number of messages consumed at which the batch will be completed. The option will be converted to a int type. Default: 200 Group: consumer
  - completionTimeout
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionTimeout(int completionTimeout)
```
    The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time, only one can be configured. The option is a: int type. Default: 500 Group: consumer
  - completionTimeout
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder completionTimeout(String completionTimeout)
```
    The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time, only one can be configured. The option will be converted to a int type. Default: 500 Group: consumer
  - consumerCount
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder consumerCount(int consumerCount)
```
    The number of JMS sessions to consume from. The option is a: int type. Default: 1 Group: consumer
  - consumerCount
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder consumerCount(String consumerCount)
```
    The number of JMS sessions to consume from. The option will be converted to a int type. Default: 1 Group: consumer
  - eagerCheckCompletion
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder eagerCheckCompletion(boolean eagerCheckCompletion)
```
    Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange. The option is a: boolean type. Default: false Group: consumer
  - eagerCheckCompletion
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder eagerCheckCompletion(String eagerCheckCompletion)
```
    Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange. The option will be converted to a boolean type. Default: false Group: consumer
  - includeAllJMSXProperties
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder includeAllJMSXProperties(boolean includeAllJMSXProperties)
```
    Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. The option is a: boolean type. Default: false Group: consumer
  - includeAllJMSXProperties
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder includeAllJMSXProperties(String includeAllJMSXProperties)
```
    Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. The option will be converted to a boolean type. Default: false Group: consumer
  - mapJmsMessage
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder mapJmsMessage(boolean mapJmsMessage)
```
    Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. The option is a: boolean type. Default: true Group: consumer
  - mapJmsMessage
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder mapJmsMessage(String mapJmsMessage)
```
    Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. The option will be converted to a boolean type. Default: true Group: consumer
  - pollDuration
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder pollDuration(int pollDuration)
```
    The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. The option is a: int type. Default: 1000 Group: consumer
  - pollDuration
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder pollDuration(String pollDuration)
```
    The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. The option will be converted to a int type. Default: 1000 Group: consumer
  - sendEmptyMessageWhenIdle
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
```
    If using completion timeout or interval, then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed. The option is a: boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
```
    If using completion timeout or interval, then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed. The option will be converted to a boolean type. Default: false Group: consumer

Interface SjmsBatchEndpointBuilderFactory.SjmsBatchEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

aggregationStrategy

aggregationStrategy

allowNullBody

allowNullBody

bridgeErrorHandler

bridgeErrorHandler

completionInterval

completionInterval

completionPredicate

completionPredicate

completionSize

completionSize

completionTimeout

completionTimeout

consumerCount

consumerCount

eagerCheckCompletion

eagerCheckCompletion

includeAllJMSXProperties

includeAllJMSXProperties

mapJmsMessage

mapJmsMessage

pollDuration

pollDuration

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle