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

Interface Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder, Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Enclosing interface:

Sjms2EndpointBuilderFactory

public static interface Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder
extends Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder, Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Builder for endpoint for the Simple JMS2 component.

Method Summary

Modifier and Type	Method	Description
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	acknowledgementMode(String acknowledgementMode)	The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	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 Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointBuilder	advanced()
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)	The connection factory to be use.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	connectionFactory(String connectionFactory)	The connection factory to be use.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	disableReplyTo(boolean disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	disableReplyTo(String disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	replyTo(String replyTo)	Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup)	Specifies whether to test the connection on startup.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup)	Specifies whether to test the connection on startup.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	transacted(boolean transacted)	Specifies whether to use transacted mode.
default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder	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.Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

asyncConsumer, asyncConsumer, autoStartup, autoStartup, clientId, concurrentConsumers, concurrentConsumers, durable, durable, durableSubscriptionName, replyToDeliveryPersistent, replyToDeliveryPersistent, shared, shared, subscriptionId

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

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

Method Details

advanced

default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointBuilder advanced()

Specified by:

advanced in interface Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

advanced in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

acknowledgementMode

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

acknowledgementMode in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

acknowledgementMode

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

acknowledgementMode in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

acknowledgementMode - the value to set

Returns:

the dsl builder

connectionFactory

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

connectionFactory in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

connectionFactory in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

disableReplyTo

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

disableReplyTo in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

disableReplyTo in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

replyTo

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

replyTo in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

replyTo - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

transacted

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

transacted in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder 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 Sjms2EndpointBuilderFactory.Sjms2EndpointConsumerBuilder

Specified by:

transacted in interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder