Package org.apache.camel.builder.endpoint.dsl

Interface SjmsEndpointBuilderFactory.SjmsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder, SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Enclosing interface:

SjmsEndpointBuilderFactory

public static interface SjmsEndpointBuilderFactory.SjmsEndpointBuilder
extends SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder, SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Builder for endpoint for the Simple JMS component.

Method Summary

Modifier and Type	Method	Description
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	acknowledgementMode(String acknowledgementMode)	The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	acknowledgementMode(org.apache.camel.component.sjms.jms.SessionAcknowledgementType acknowledgementMode)	The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointBuilder	advanced()
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)	The connection factory to be use.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	connectionFactory(String connectionFactory)	The connection factory to be use.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	disableReplyTo(boolean disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	disableReplyTo(String disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	replyTo(String replyTo)	Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup)	Specifies whether to test the connection on startup.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup)	Specifies whether to test the connection on startup.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	transacted(boolean transacted)	Specifies whether to use transacted mode.
default SjmsEndpointBuilderFactory.SjmsEndpointBuilder	transacted(String transacted)	Specifies whether to use transacted mode.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

asyncConsumer, asyncConsumer, autoStartup, autoStartup, clientId, concurrentConsumers, concurrentConsumers, durableSubscriptionName, replyToDeliveryPersistent, replyToDeliveryPersistent

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

deliveryMode, deliveryMode, deliveryPersistent, deliveryPersistent, priority, priority, replyToConcurrentConsumers, replyToConcurrentConsumers, replyToOverride, replyToType, replyToType, requestTimeout, requestTimeout, timeToLive, timeToLive

Method Details

advanced

default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointBuilder advanced()

Specified by:

advanced in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

advanced in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

acknowledgementMode

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder acknowledgementMode(org.apache.camel.component.sjms.jms.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

Specified by:

acknowledgementMode in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

acknowledgementMode in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

acknowledgementMode

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

Specified by:

acknowledgementMode in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

acknowledgementMode in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

connectionFactory

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)

The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option is a: <code>jakarta.jms.ConnectionFactory</code> type. Group: common

Specified by:

connectionFactory in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

connectionFactory in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder connectionFactory(String connectionFactory)

The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option will be converted to a <code>jakarta.jms.ConnectionFactory</code> type. Group: common

Specified by:

connectionFactory in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

connectionFactory in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

disableReplyTo

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder disableReplyTo(boolean disableReplyTo)

Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

disableReplyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

disableReplyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder disableReplyTo(String disableReplyTo)

Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

disableReplyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

disableReplyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

replyTo

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder replyTo(String replyTo)

Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer). The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

replyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

replyTo in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

replyTo - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder testConnectionOnStartup(boolean testConnectionOnStartup)

Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

testConnectionOnStartup in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder testConnectionOnStartup(String testConnectionOnStartup)

Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

testConnectionOnStartup in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

transacted

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder transacted(boolean transacted)

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

Specified by:

transacted in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

transacted in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default SjmsEndpointBuilderFactory.SjmsEndpointBuilder transacted(String transacted)

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

Specified by:

transacted in interface SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder

Specified by:

transacted in interface SjmsEndpointBuilderFactory.SjmsEndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder