org.apache.camel.builder.endpoint.dsl

Interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

SjmsEndpointBuilderFactory.SjmsEndpointBuilder

Enclosing interface:

SjmsEndpointBuilderFactory

public static interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Simple JMS component.

Method Summary

Modifier and Type	Method and Description
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	acknowledgementMode(SjmsEndpointBuilderFactory.SessionAcknowledgementType acknowledgementMode) The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	acknowledgementMode(String acknowledgementMode) The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder	advanced()
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	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 SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	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 SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	consumerCount(int consumerCount) Sets the number of consumer listeners used for this endpoint.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	consumerCount(String consumerCount) Sets the number of consumer listeners used for this endpoint.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	durableSubscriptionId(String durableSubscriptionId) Sets the durable subscription Id required for durable topics.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel) Allows to configure the default errorHandler logging level for logging uncaught exceptions.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	errorHandlerLoggingLevel(String errorHandlerLoggingLevel) Allows to configure the default errorHandler logging level for logging uncaught exceptions.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace) Allows to control whether stacktraces should be logged or not, by the default errorHandler.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	errorHandlerLogStackTrace(String errorHandlerLogStackTrace) Allows to control whether stacktraces should be logged or not, by the default errorHandler.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	reconnectBackOff(long reconnectBackOff) Backoff in millis on consumer pool reconnection attempts.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	reconnectBackOff(String reconnectBackOff) Backoff in millis on consumer pool reconnection attempts.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	reconnectOnError(boolean reconnectOnError) Try to apply reconnection logic on consumer pool.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	reconnectOnError(String reconnectOnError) Try to apply reconnection logic on consumer pool.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transacted(boolean transacted) Specifies whether to use transacted mode.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transacted(String transacted) Specifies whether to use transacted mode.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionBatchCount(int transactionBatchCount) Deprecated.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionBatchCount(String transactionBatchCount) Deprecated.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionBatchTimeout(long transactionBatchTimeout) Deprecated.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionBatchTimeout(String transactionBatchTimeout) Deprecated.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionCommitStrategy(Object transactionCommitStrategy) Sets the commit strategy.
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder	transactionCommitStrategy(String transactionCommitStrategy) Sets the commit strategy.

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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder advanced()

acknowledgementMode

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder acknowledgementMode(SjmsEndpointBuilderFactory.SessionAcknowledgementType acknowledgementMode)

The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE. The option is a: <code>org.apache.camel.component.sjms.jms.SessionAcknowledgementType</code> type. Default: AUTO_ACKNOWLEDGE Group: common

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

acknowledgementMode

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder acknowledgementMode(String acknowledgementMode)

The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE. The option will be converted to a <code>org.apache.camel.component.sjms.jms.SessionAcknowledgementType</code> type. Default: AUTO_ACKNOWLEDGE Group: common

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder 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 SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder 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

consumerCount

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder consumerCount(int consumerCount)

Sets the number of consumer listeners used for this endpoint. The option is a: <code>int</code> type. Default: 1 Group: consumer

Parameters:

consumerCount - the value to set

Returns:

the dsl builder

consumerCount

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder consumerCount(String consumerCount)

Sets the number of consumer listeners used for this endpoint. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer

Parameters:

consumerCount - the value to set

Returns:

the dsl builder

durableSubscriptionId

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder durableSubscriptionId(String durableSubscriptionId)

Sets the durable subscription Id required for durable topics. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

durableSubscriptionId - the value to set

Returns:

the dsl builder

reconnectBackOff

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder reconnectBackOff(long reconnectBackOff)

Backoff in millis on consumer pool reconnection attempts. The option is a: <code>long</code> type. Default: 5000 Group: consumer

Parameters:

reconnectBackOff - the value to set

Returns:

the dsl builder

reconnectBackOff

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder reconnectBackOff(String reconnectBackOff)

Backoff in millis on consumer pool reconnection attempts. The option will be converted to a <code>long</code> type. Default: 5000 Group: consumer

Parameters:

reconnectBackOff - the value to set

Returns:

the dsl builder

reconnectOnError

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder reconnectOnError(boolean reconnectOnError)

Try to apply reconnection logic on consumer pool. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

reconnectOnError - the value to set

Returns:

the dsl builder

reconnectOnError

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder reconnectOnError(String reconnectOnError)

Try to apply reconnection logic on consumer pool. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer

Parameters:

reconnectOnError - the value to set

Returns:

the dsl builder

synchronous

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder 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: true Group: consumer

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder 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: true Group: consumer

Parameters:

synchronous - the value to set

Returns:

the dsl builder

errorHandlerLoggingLevel

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)

Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: logging

Parameters:

errorHandlerLoggingLevel - the value to set

Returns:

the dsl builder

errorHandlerLoggingLevel

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder errorHandlerLoggingLevel(String errorHandlerLoggingLevel)

Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: logging

Parameters:

errorHandlerLoggingLevel - the value to set

Returns:

the dsl builder

errorHandlerLogStackTrace

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace)

Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option is a: <code>boolean</code> type. Default: true Group: logging

Parameters:

errorHandlerLogStackTrace - the value to set

Returns:

the dsl builder

errorHandlerLogStackTrace

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder errorHandlerLogStackTrace(String errorHandlerLogStackTrace)

Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option will be converted to a <code>boolean</code> type. Default: true Group: logging

Parameters:

errorHandlerLogStackTrace - the value to set

Returns:

the dsl builder

transacted

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transacted(boolean transacted)

Specifies whether to use transacted mode. The option is a: <code>boolean</code> type. Default: false Group: transaction

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transacted(String transacted)

Specifies whether to use transacted mode. The option will be converted to a <code>boolean</code> type. Default: false Group: transaction

Parameters:

transacted - the value to set

Returns:

the dsl builder

transactionBatchCount

@Deprecated
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionBatchCount(int transactionBatchCount)

Deprecated.

If transacted sets the number of messages to process before committing a transaction. The option is a: <code>int</code> type. Default: -1 Group: transaction

Parameters:

transactionBatchCount - the value to set

Returns:

the dsl builder

transactionBatchCount

@Deprecated
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionBatchCount(String transactionBatchCount)

Deprecated.

If transacted sets the number of messages to process before committing a transaction. The option will be converted to a <code>int</code> type. Default: -1 Group: transaction

Parameters:

transactionBatchCount - the value to set

Returns:

the dsl builder

transactionBatchTimeout

@Deprecated
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionBatchTimeout(long transactionBatchTimeout)

Deprecated.

Sets timeout (in millis) for batch transactions, the value should be 1000 or higher. The option is a: <code>long</code> type. Default: 5s Group: transaction

Parameters:

transactionBatchTimeout - the value to set

Returns:

the dsl builder

transactionBatchTimeout

@Deprecated
default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionBatchTimeout(String transactionBatchTimeout)

Deprecated.

Sets timeout (in millis) for batch transactions, the value should be 1000 or higher. The option will be converted to a <code>long</code> type. Default: 5s Group: transaction

Parameters:

transactionBatchTimeout - the value to set

Returns:

the dsl builder

transactionCommitStrategy

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionCommitStrategy(Object transactionCommitStrategy)

Sets the commit strategy. The option is a: <code>org.apache.camel.component.sjms.TransactionCommitStrategy</code> type. Group: transaction

Parameters:

transactionCommitStrategy - the value to set

Returns:

the dsl builder

transactionCommitStrategy

default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder transactionCommitStrategy(String transactionCommitStrategy)

Sets the commit strategy. The option will be converted to a <code>org.apache.camel.component.sjms.TransactionCommitStrategy</code> type. Group: transaction

Parameters:

transactionCommitStrategy - the value to set

Returns:

the dsl builder