org.apache.camel.builder.component.dsl

Interface SjmsComponentBuilderFactory.SjmsComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.sjms.SjmsComponent>

All Known Implementing Classes:

SjmsComponentBuilderFactory.SjmsComponentBuilderImpl

Enclosing interface:

SjmsComponentBuilderFactory

public static interface SjmsComponentBuilderFactory.SjmsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.sjms.SjmsComponent>

Builder for the Simple JMS component.

Method Summary

Modifier and Type	Method and Description
default SjmsComponentBuilderFactory.SjmsComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionClientId(String connectionClientId) The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionCount(Integer connectionCount) The maximum number of connections available to endpoints started under this component.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionFactory(javax.jms.ConnectionFactory connectionFactory) A ConnectionFactory is required to enable the SjmsComponent.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionMaxWait(long connectionMaxWait) The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionPassword(String connectionPassword) The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionResource(org.apache.camel.component.sjms.jms.ConnectionResource connectionResource) A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionTestOnBorrow(boolean connectionTestOnBorrow) When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	connectionUsername(String connectionUsername) The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	destinationCreationStrategy(org.apache.camel.component.sjms.jms.DestinationCreationStrategy destinationCreationStrategy) To use a custom DestinationCreationStrategy.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	jmsKeyFormatStrategy(org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SjmsComponentBuilderFactory.SjmsComponentBuilder	messageCreatedStrategy(org.apache.camel.component.sjms.jms.MessageCreatedStrategy 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 SjmsComponentBuilderFactory.SjmsComponentBuilder	reconnectBackOff(long reconnectBackOff) Backoff in millis on consumer pool reconnection attempts.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	reconnectOnError(boolean reconnectOnError) Try to apply reconnection logic on consumer pool.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	timedTaskManager(org.apache.camel.component.sjms.taskmanager.TimedTaskManager timedTaskManager) To use a custom TimedTaskManager.
default SjmsComponentBuilderFactory.SjmsComponentBuilder	transactionCommitStrategy(org.apache.camel.component.sjms.TransactionCommitStrategy transactionCommitStrategy) To configure which kind of commit strategy to use.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

connectionCount

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionCount(Integer connectionCount)

The maximum number of connections available to endpoints started under this component. The option is a: <code>java.lang.Integer</code> type. Default: 1 Group: common

Parameters:

connectionCount - the value to set

Returns:

the dsl builder

connectionFactory

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionFactory(javax.jms.ConnectionFactory connectionFactory)

A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. The option is a: <code>javax.jms.ConnectionFactory</code> type. Group: common

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default SjmsComponentBuilderFactory.SjmsComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

reconnectBackOff

default SjmsComponentBuilderFactory.SjmsComponentBuilder reconnectBackOff(long reconnectBackOff)

Backoff in millis on consumer pool reconnection attempts. The option is a: <code>long</code> type. Default: 5000 Group: consumer

Parameters:

reconnectBackOff - the value to set

Returns:

the dsl builder

reconnectOnError

default SjmsComponentBuilderFactory.SjmsComponentBuilder reconnectOnError(boolean reconnectOnError)

Try to apply reconnection logic on consumer pool. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

reconnectOnError - the value to set

Returns:

the dsl builder

lazyStartProducer

default SjmsComponentBuilderFactory.SjmsComponentBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

autowiredEnabled

default SjmsComponentBuilderFactory.SjmsComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

connectionClientId

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionClientId(String connectionClientId)

The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. The option is a: <code>java.lang.String</code> type. Group: advanced

Parameters:

connectionClientId - the value to set

Returns:

the dsl builder

connectionMaxWait

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionMaxWait(long connectionMaxWait)

The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. The option is a: <code>long</code> type. Default: 5000 Group: advanced

Parameters:

connectionMaxWait - the value to set

Returns:

the dsl builder

connectionResource

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionResource(org.apache.camel.component.sjms.jms.ConnectionResource connectionResource)

A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. 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

connectionTestOnBorrow

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionTestOnBorrow(boolean connectionTestOnBorrow)

When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

connectionTestOnBorrow - the value to set

Returns:

the dsl builder

destinationCreationStrategy

default SjmsComponentBuilderFactory.SjmsComponentBuilder destinationCreationStrategy(org.apache.camel.component.sjms.jms.DestinationCreationStrategy 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

jmsKeyFormatStrategy

default SjmsComponentBuilderFactory.SjmsComponentBuilder jmsKeyFormatStrategy(org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy jmsKeyFormatStrategy)

Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). 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

messageCreatedStrategy

default SjmsComponentBuilderFactory.SjmsComponentBuilder messageCreatedStrategy(org.apache.camel.component.sjms.jms.MessageCreatedStrategy 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

timedTaskManager

default SjmsComponentBuilderFactory.SjmsComponentBuilder timedTaskManager(org.apache.camel.component.sjms.taskmanager.TimedTaskManager timedTaskManager)

To use a custom TimedTaskManager. The option is a: <code>org.apache.camel.component.sjms.taskmanager.TimedTaskManager</code> type. Group: advanced

Parameters:

timedTaskManager - the value to set

Returns:

the dsl builder

headerFilterStrategy

default SjmsComponentBuilderFactory.SjmsComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

connectionPassword

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionPassword(String connectionPassword)

The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

connectionPassword - the value to set

Returns:

the dsl builder

connectionUsername

default SjmsComponentBuilderFactory.SjmsComponentBuilder connectionUsername(String connectionUsername)

The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

connectionUsername - the value to set

Returns:

the dsl builder

transactionCommitStrategy

default SjmsComponentBuilderFactory.SjmsComponentBuilder transactionCommitStrategy(org.apache.camel.component.sjms.TransactionCommitStrategy transactionCommitStrategy)

To configure which kind of commit strategy to use. Camel provides two implementations out of the box, default and batch. The option is a: <code>org.apache.camel.component.sjms.TransactionCommitStrategy</code> type. Group: transaction

Parameters:

transactionCommitStrategy - the value to set

Returns:

the dsl builder