org.apache.camel.builder.endpoint.dsl

Interface Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointBuilder

Enclosing interface:

Sjms2EndpointBuilderFactory

public static interface Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the Simple JMS2 component.

Method Summary

Modifier and Type	Method and Description
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	asyncStartListener(boolean asyncStartListener) Whether to startup the consumer message listener asynchronously, when starting a route.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	asyncStartListener(String asyncStartListener) Whether to startup the consumer message listener asynchronously, when starting a route.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	asyncStopListener(boolean asyncStopListener) Whether to stop the consumer message listener asynchronously, when stopping a route.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	asyncStopListener(String asyncStopListener) Whether to stop the consumer message listener asynchronously, when stopping a route.
default Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder	basic()
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionCount(Integer connectionCount) The maximum number of connections available to this endpoint.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionCount(String connectionCount) The maximum number of connections available to this endpoint.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionFactory(Object connectionFactory) Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionFactory(String connectionFactory) Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionResource(Object connectionResource) Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	connectionResource(String connectionResource) Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	destinationCreationStrategy(Object destinationCreationStrategy) To use a custom DestinationCreationStrategy.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	destinationCreationStrategy(String destinationCreationStrategy) To use a custom DestinationCreationStrategy.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exceptionListener(Object exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exceptionListener(String exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	includeAllJMSXProperties(boolean includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	includeAllJMSXProperties(String includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	jmsKeyFormatStrategy(Object jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	jmsKeyFormatStrategy(String jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	messageSelector(String messageSelector) Sets the JMS Message selector syntax.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	sharedJMSSession(boolean sharedJMSSession) Specifies whether to share JMS session with other SJMS endpoints.
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder	sharedJMSSession(String sharedJMSSession) Specifies whether to share JMS session with other SJMS endpoints.

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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder basic()

exceptionHandler

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

messageSelector

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder messageSelector(String messageSelector)

Sets the JMS Message selector syntax. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)

Parameters:

messageSelector - the value to set

Returns:

the dsl builder

asyncStartListener

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

asyncStopListener

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder asyncStopListener(boolean asyncStopListener)

Whether to stop the consumer message listener asynchronously, when stopping a route. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

asyncStopListener

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder asyncStopListener(String asyncStopListener)

Whether to stop the consumer message listener asynchronously, when stopping a route. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

connectionCount

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionCount(Integer connectionCount)

The maximum number of connections available to this endpoint. The option is a: <code>java.lang.Integer</code> type. Group: advanced

Parameters:

connectionCount - the value to set

Returns:

the dsl builder

connectionCount

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionCount(String connectionCount)

The maximum number of connections available to this endpoint. The option will be converted to a <code>java.lang.Integer</code> type. Group: advanced

Parameters:

connectionCount - the value to set

Returns:

the dsl builder

connectionFactory

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionFactory(Object connectionFactory)

Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any. The option is a: <code>javax.jms.ConnectionFactory</code> type. Group: advanced

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionFactory(String connectionFactory)

Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any. The option will be converted to a <code>javax.jms.ConnectionFactory</code> type. Group: advanced

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionResource

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionResource(Object connectionResource)

Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any. The option is a: <code>org.apache.camel.component.sjms.jms.ConnectionResource</code> type. Group: advanced

Parameters:

connectionResource - the value to set

Returns:

the dsl builder

connectionResource

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionResource(String connectionResource)

Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any. The option will be converted to a <code>org.apache.camel.component.sjms.jms.ConnectionResource</code> type. Group: advanced

Parameters:

connectionResource - the value to set

Returns:

the dsl builder

destinationCreationStrategy

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder destinationCreationStrategy(Object destinationCreationStrategy)

To use a custom DestinationCreationStrategy. The option is a: <code>org.apache.camel.component.sjms.jms.DestinationCreationStrategy</code> type. Group: advanced

Parameters:

destinationCreationStrategy - the value to set

Returns:

the dsl builder

destinationCreationStrategy

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder destinationCreationStrategy(String destinationCreationStrategy)

To use a custom DestinationCreationStrategy. The option will be converted to a <code>org.apache.camel.component.sjms.jms.DestinationCreationStrategy</code> type. Group: advanced

Parameters:

destinationCreationStrategy - the value to set

Returns:

the dsl builder

exceptionListener

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder exceptionListener(Object exceptionListener)

Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: <code>javax.jms.ExceptionListener</code> type. Group: advanced

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

exceptionListener

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder exceptionListener(String exceptionListener)

Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option will be converted to a <code>javax.jms.ExceptionListener</code> type. Group: advanced

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

headerFilterStrategy

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

includeAllJMSXProperties

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

includeAllJMSXProperties

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: advanced

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

mapJmsMessage

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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: <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

mapJmsMessage

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

sharedJMSSession

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder sharedJMSSession(boolean sharedJMSSession)

Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers, use jms component to leverage XA transaction. The option is a: <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

sharedJMSSession - the value to set

Returns:

the dsl builder

sharedJMSSession

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder sharedJMSSession(String sharedJMSSession)

Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers, use jms component to leverage XA transaction. The option will be converted to a <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

sharedJMSSession - the value to set

Returns:

the dsl builder