Interface SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
SjmsEndpointBuilderFactory.AdvancedSjmsEndpointBuilder
- Enclosing interface:
- SjmsEndpointBuilderFactory
public static interface SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Simple JMS component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
allowNullBody(boolean allowNullBody)
Whether to allow sending messages with no body.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
allowNullBody(String allowNullBody)
Whether to allow sending messages with no body.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
asyncStartListener(boolean asyncStartListener)
Whether to startup the consumer message listener asynchronously, when starting a route.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
asyncStartListener(String asyncStartListener)
Whether to startup the consumer message listener asynchronously, when starting a route.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
asyncStopListener(boolean asyncStopListener)
Whether to stop the consumer message listener asynchronously, when stopping a route.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
asyncStopListener(String asyncStopListener)
Whether to stop the consumer message listener asynchronously, when stopping a route.default SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder
basic()
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
basicPropertyBinding(boolean basicPropertyBinding)
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
basicPropertyBinding(String basicPropertyBinding)
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionCount(Integer connectionCount)
The maximum number of connections available to this endpoint.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionCount(String connectionCount)
The maximum number of connections available to this endpoint.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionFactory(Object connectionFactory)
Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionFactory(String connectionFactory)
Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionResource(Object connectionResource)
Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
connectionResource(String connectionResource)
Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
destinationCreationStrategy(Object destinationCreationStrategy)
To use a custom DestinationCreationStrategy.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
destinationCreationStrategy(String destinationCreationStrategy)
To use a custom DestinationCreationStrategy.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
exceptionListener(Object exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
exceptionListener(String exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
includeAllJMSXProperties(boolean includeAllJMSXProperties)
Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
includeAllJMSXProperties(String includeAllJMSXProperties)
Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
jmsKeyFormatStrategy(Object jmsKeyFormatStrategy)
Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
jmsKeyFormatStrategy(String jmsKeyFormatStrategy)
Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
prefillPool(boolean prefillPool)
Whether to prefill the producer connection pool on startup, or create connections lazy when needed.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
prefillPool(String prefillPool)
Whether to prefill the producer connection pool on startup, or create connections lazy when needed.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
responseTimeOut(long responseTimeOut)
Sets the amount of time we should wait before timing out a InOut response.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
responseTimeOut(String responseTimeOut)
Sets the amount of time we should wait before timing out a InOut response.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
sharedJMSSession(boolean sharedJMSSession)
Specifies whether to share JMS session with other SJMS endpoints.default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder
sharedJMSSession(String sharedJMSSession)
Specifies whether to share JMS session with other SJMS endpoints.
-
-
-
Method Detail
-
basic
default SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder basic()
-
allowNullBody
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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: producer (advanced)
-
allowNullBody
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aboolean
type. Default: true Group: producer (advanced)
-
prefillPool
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder prefillPool(boolean prefillPool)
Whether to prefill the producer connection pool on startup, or create connections lazy when needed. The option is a:boolean
type. Default: true Group: producer (advanced)
-
prefillPool
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder prefillPool(String prefillPool)
Whether to prefill the producer connection pool on startup, or create connections lazy when needed. The option will be converted to aboolean
type. Default: true Group: producer (advanced)
-
responseTimeOut
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder responseTimeOut(long responseTimeOut)
Sets the amount of time we should wait before timing out a InOut response. The option is a:long
type. Default: 5s Group: producer (advanced)
-
responseTimeOut
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder responseTimeOut(String responseTimeOut)
Sets the amount of time we should wait before timing out a InOut response. The option will be converted to along
type. Default: 5s Group: producer (advanced)
-
asyncStartListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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:boolean
type. Default: false Group: advanced
-
asyncStartListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aboolean
type. Default: false Group: advanced
-
asyncStopListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder asyncStopListener(boolean asyncStopListener)
Whether to stop the consumer message listener asynchronously, when stopping a route. The option is a:boolean
type. Default: false Group: advanced
-
asyncStopListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder asyncStopListener(String asyncStopListener)
Whether to stop the consumer message listener asynchronously, when stopping a route. The option will be converted to aboolean
type. Default: false Group: advanced
-
basicPropertyBinding
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder basicPropertyBinding(boolean basicPropertyBinding)
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a:boolean
type. Default: false Group: advanced
-
basicPropertyBinding
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder basicPropertyBinding(String basicPropertyBinding)
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to aboolean
type. Default: false Group: advanced
-
connectionCount
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder connectionCount(Integer connectionCount)
The maximum number of connections available to this endpoint. The option is a:java.lang.Integer
type. Group: advanced
-
connectionCount
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder connectionCount(String connectionCount)
The maximum number of connections available to this endpoint. The option will be converted to ajava.lang.Integer
type. Group: advanced
-
connectionFactory
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder connectionFactory(Object connectionFactory)
Initializes the connectionFactory for the endpoint, which takes precedence over the component's connectionFactory, if any. The option is a:javax.jms.ConnectionFactory
type. Group: advanced
-
connectionFactory
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 ajavax.jms.ConnectionFactory
type. Group: advanced
-
connectionResource
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder connectionResource(Object connectionResource)
Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any. The option is a:org.apache.camel.component.sjms.jms.ConnectionResource
type. Group: advanced
-
connectionResource
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aorg.apache.camel.component.sjms.jms.ConnectionResource
type. Group: advanced
-
destinationCreationStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder destinationCreationStrategy(Object destinationCreationStrategy)
To use a custom DestinationCreationStrategy. The option is a:org.apache.camel.component.sjms.jms.DestinationCreationStrategy
type. Group: advanced
-
destinationCreationStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder destinationCreationStrategy(String destinationCreationStrategy)
To use a custom DestinationCreationStrategy. The option will be converted to aorg.apache.camel.component.sjms.jms.DestinationCreationStrategy
type. Group: advanced
-
exceptionListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder exceptionListener(Object exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a:javax.jms.ExceptionListener
type. Group: advanced
-
exceptionListener
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder exceptionListener(String exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option will be converted to ajavax.jms.ExceptionListener
type. Group: advanced
-
headerFilterStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a:org.apache.camel.spi.HeaderFilterStrategy
type. Group: advanced
-
headerFilterStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to aorg.apache.camel.spi.HeaderFilterStrategy
type. Group: advanced
-
includeAllJMSXProperties
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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: advanced
-
includeAllJMSXProperties
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aboolean
type. Default: false Group: advanced
-
jmsKeyFormatStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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:org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy
type. Group: advanced
-
jmsKeyFormatStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aorg.apache.camel.component.sjms.jms.JmsKeyFormatStrategy
type. Group: advanced
-
mapJmsMessage
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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: advanced
-
mapJmsMessage
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aboolean
type. Default: true Group: advanced
-
messageCreatedStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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:org.apache.camel.component.sjms.jms.MessageCreatedStrategy
type. Group: advanced
-
messageCreatedStrategy
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aorg.apache.camel.component.sjms.jms.MessageCreatedStrategy
type. Group: advanced
-
sharedJMSSession
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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:boolean
type. Default: true Group: transaction (advanced)
-
sharedJMSSession
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 aboolean
type. Default: true Group: transaction (advanced)
-
-