Interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
Sjms2EndpointBuilderFactory.Sjms2EndpointBuilder
- Enclosing interface:
- Sjms2EndpointBuilderFactory
public static interface Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Simple JMS2 component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
acknowledgementMode(String acknowledgementMode)
The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
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.AdvancedSjms2EndpointProducerBuilder
advanced()
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
connectionFactory(String connectionFactory)
The connection factory to be use.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
connectionFactory(javax.jms.ConnectionFactory connectionFactory)
The connection factory to be use.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
deliveryMode(Integer deliveryMode)
Specifies the delivery mode to be used.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
deliveryMode(String deliveryMode)
Specifies the delivery mode to be used.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
deliveryPersistent(boolean deliveryPersistent)
Specifies whether persistent delivery is used by default.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
deliveryPersistent(String deliveryPersistent)
Specifies whether persistent delivery is used by default.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
disableReplyTo(boolean disableReplyTo)
Specifies whether Camel ignores the JMSReplyTo header in messages.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
disableReplyTo(String disableReplyTo)
Specifies whether Camel ignores the JMSReplyTo header in messages.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
priority(int priority)
Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
priority(String priority)
Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyTo(String replyTo)
Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyToConcurrentConsumers(int replyToConcurrentConsumers)
Specifies the default number of concurrent consumers when doing request/reply over JMS.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyToConcurrentConsumers(String replyToConcurrentConsumers)
Specifies the default number of concurrent consumers when doing request/reply over JMS.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyToOverride(String replyToOverride)
Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyToType(String replyToType)
Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
replyToType(org.apache.camel.component.sjms.ReplyToType replyToType)
Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
requestTimeout(long requestTimeout)
The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
requestTimeout(String requestTimeout)
The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
testConnectionOnStartup(boolean testConnectionOnStartup)
Specifies whether to test the connection on startup.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
testConnectionOnStartup(String testConnectionOnStartup)
Specifies whether to test the connection on startup.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
timeToLive(long timeToLive)
When sending messages, specifies the time-to-live of the message (in milliseconds).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
timeToLive(String timeToLive)
When sending messages, specifies the time-to-live of the message (in milliseconds).default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
transacted(boolean transacted)
Specifies whether to use transacted mode.default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder
transacted(String transacted)
Specifies whether to use transacted mode.
-
-
-
Method Detail
-
advanced
default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointProducerBuilder advanced()
-
acknowledgementMode
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
acknowledgementMode
- the value to set- Returns:
- the dsl builder
-
acknowledgementMode
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
acknowledgementMode
- the value to set- Returns:
- the dsl builder
-
connectionFactory
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder connectionFactory(javax.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>javax.jms.ConnectionFactory</code> type. Group: common- Parameters:
connectionFactory
- the value to set- Returns:
- the dsl builder
-
connectionFactory
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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>javax.jms.ConnectionFactory</code> type. Group: common- Parameters:
connectionFactory
- the value to set- Returns:
- the dsl builder
-
disableReplyTo
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
disableReplyTo
- the value to set- Returns:
- the dsl builder
-
disableReplyTo
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
disableReplyTo
- the value to set- Returns:
- the dsl builder
-
replyTo
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
replyTo
- the value to set- Returns:
- the dsl builder
-
testConnectionOnStartup
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
testConnectionOnStartup
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder 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- Parameters:
testConnectionOnStartup
- the value to set- Returns:
- the dsl builder
-
deliveryMode
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder deliveryMode(Integer deliveryMode)
Specifies the delivery mode to be used. Possible values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
deliveryMode
- the value to set- Returns:
- the dsl builder
-
deliveryMode
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder deliveryMode(String deliveryMode)
Specifies the delivery mode to be used. Possible values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer- Parameters:
deliveryMode
- the value to set- Returns:
- the dsl builder
-
deliveryPersistent
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder deliveryPersistent(boolean deliveryPersistent)
Specifies whether persistent delivery is used by default. The option is a: <code>boolean</code> type. Default: true Group: producer- Parameters:
deliveryPersistent
- the value to set- Returns:
- the dsl builder
-
deliveryPersistent
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder deliveryPersistent(String deliveryPersistent)
Specifies whether persistent delivery is used by default. The option will be converted to a <code>boolean</code> type. Default: true Group: producer- Parameters:
deliveryPersistent
- the value to set- Returns:
- the dsl builder
-
priority
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder priority(int priority)
Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect. The option is a: <code>int</code> type. Default: 4 Group: producer- Parameters:
priority
- the value to set- Returns:
- the dsl builder
-
priority
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder priority(String priority)
Values greater than 1 specify the message priority when sending (where 1 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect. The option will be converted to a <code>int</code> type. Default: 4 Group: producer- Parameters:
priority
- the value to set- Returns:
- the dsl builder
-
replyToConcurrentConsumers
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder replyToConcurrentConsumers(int replyToConcurrentConsumers)
Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. The option is a: <code>int</code> type. Default: 1 Group: producer- Parameters:
replyToConcurrentConsumers
- the value to set- Returns:
- the dsl builder
-
replyToConcurrentConsumers
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder replyToConcurrentConsumers(String replyToConcurrentConsumers)
Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. The option will be converted to a <code>int</code> type. Default: 1 Group: producer- Parameters:
replyToConcurrentConsumers
- the value to set- Returns:
- the dsl builder
-
replyToOverride
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder replyToOverride(String replyToOverride)
Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
replyToOverride
- the value to set- Returns:
- the dsl builder
-
replyToType
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder replyToType(org.apache.camel.component.sjms.ReplyToType replyToType)
Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used. The option is a: <code>org.apache.camel.component.sjms.ReplyToType</code> type. Group: producer- Parameters:
replyToType
- the value to set- Returns:
- the dsl builder
-
replyToType
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder replyToType(String replyToType)
Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Exclusive is used. The option will be converted to a <code>org.apache.camel.component.sjms.ReplyToType</code> type. Group: producer- Parameters:
replyToType
- the value to set- Returns:
- the dsl builder
-
requestTimeout
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder requestTimeout(long requestTimeout)
The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option. The option is a: <code>long</code> type. Default: 20000 Group: producer- Parameters:
requestTimeout
- the value to set- Returns:
- the dsl builder
-
requestTimeout
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder requestTimeout(String requestTimeout)
The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option. The option will be converted to a <code>long</code> type. Default: 20000 Group: producer- Parameters:
requestTimeout
- the value to set- Returns:
- the dsl builder
-
timeToLive
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder timeToLive(long timeToLive)
When sending messages, specifies the time-to-live of the message (in milliseconds). The option is a: <code>long</code> type. Default: -1 Group: producer- Parameters:
timeToLive
- the value to set- Returns:
- the dsl builder
-
timeToLive
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder timeToLive(String timeToLive)
When sending messages, specifies the time-to-live of the message (in milliseconds). The option will be converted to a <code>long</code> type. Default: -1 Group: producer- Parameters:
timeToLive
- the value to set- Returns:
- the dsl builder
-
transacted
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder transacted(boolean transacted)
Specifies whether to use transacted mode. The option is a: <code>boolean</code> type. Default: false Group: transaction- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
transacted
default Sjms2EndpointBuilderFactory.Sjms2EndpointProducerBuilder transacted(String transacted)
Specifies whether to use transacted mode. The option will be converted to a <code>boolean</code> type. Default: false Group: transaction- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
-