org.apache.camel.builder.endpoint.dsl

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

Modifier and Type	Method and 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	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(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder	headerFilterStrategy(String 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.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

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: <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

allowNullBody - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

allowNullBody - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

prefillPool - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

prefillPool - the value to set

Returns:

the dsl builder

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: <code>long</code> type. Default: 5s Group: producer (advanced)

Parameters:

responseTimeOut - the value to set

Returns:

the dsl builder

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 a <code>long</code> type. Default: 5s Group: producer (advanced)

Parameters:

responseTimeOut - the value to set

Returns:

the dsl builder

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

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

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

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStopListener

default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 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: <code>javax.jms.ConnectionFactory</code> type. Group: advanced

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

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 a <code>javax.jms.ConnectionFactory</code> type. Group: advanced

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.component.sjms.jms.ConnectionResource</code> type. Group: advanced

Parameters:

connectionResource - the value to set

Returns:

the dsl builder

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 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 SjmsEndpointBuilderFactory.AdvancedSjmsEndpointProducerBuilder 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 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 a <code>javax.jms.ExceptionListener</code> type. Group: advanced

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

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 a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

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

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

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

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy</code> type. Group: advanced

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

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

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

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

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.component.sjms.jms.MessageCreatedStrategy</code> type. Group: advanced

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

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 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 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: <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

sharedJMSSession - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

sharedJMSSession - the value to set

Returns:

the dsl builder