Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.sjms2.Sjms2Component>

All Known Implementing Classes:

Sjms2ComponentBuilderFactory.Sjms2ComponentBuilderImpl

Enclosing interface:

Sjms2ComponentBuilderFactory
```
public static interface Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder
extends ComponentBuilder<org.apache.camel.component.sjms2.Sjms2Component>
```
Builder for the Simple JMS2 component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`connectionCount(Integer connectionCount)` The maximum number of connections available to endpoints started under this component.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`connectionFactory(javax.jms.ConnectionFactory connectionFactory)` A ConnectionFactory is required to enable the SjmsComponent.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`connectionPassword(String connectionPassword)` The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`connectionUsername(String connectionUsername)` The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`destinationCreationStrategy(org.apache.camel.component.sjms.jms.DestinationCreationStrategy destinationCreationStrategy)` To use a custom DestinationCreationStrategy.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`reconnectBackOff(long reconnectBackOff)` Backoff in millis on consumer pool reconnection attempts.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`reconnectOnError(boolean reconnectOnError)` Try to apply reconnection logic on consumer pool.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`timedTaskManager(org.apache.camel.component.sjms.taskmanager.TimedTaskManager timedTaskManager)` To use a custom TimedTaskManager.
`default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder`	`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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder connectionCount(Integer connectionCount)
```
    The maximum number of connections available to endpoints started under this component. The option is a: java.lang.Integer type. Default: 1 Group: common
  - bridgeErrorHandler
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: boolean type. Default: false Group: consumer
  - reconnectBackOff
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder reconnectBackOff(long reconnectBackOff)
```
    Backoff in millis on consumer pool reconnection attempts. The option is a: long type. Default: 5000 Group: consumer
  - reconnectOnError
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder reconnectOnError(boolean reconnectOnError)
```
    Try to apply reconnection logic on consumer pool. The option is a: boolean type. Default: true Group: consumer
  - lazyStartProducer
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - connectionClientId
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: java.lang.String type. Group: advanced
  - connectionFactory
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: javax.jms.ConnectionFactory type. Group: advanced
  - connectionMaxWait
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: long type. Default: 5000 Group: advanced
  - connectionResource
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: org.apache.camel.component.sjms.jms.ConnectionResource type. Group: advanced
  - connectionTestOnBorrow
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: boolean type. Default: true Group: advanced
  - destinationCreationStrategy
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder destinationCreationStrategy(org.apache.camel.component.sjms.jms.DestinationCreationStrategy destinationCreationStrategy)
```
    To use a custom DestinationCreationStrategy. The option is a: org.apache.camel.component.sjms.jms.DestinationCreationStrategy type. Group: advanced
  - jmsKeyFormatStrategy
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy type. Group: advanced
  - messageCreatedStrategy
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: org.apache.camel.component.sjms.jms.MessageCreatedStrategy type. Group: advanced
  - timedTaskManager
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder timedTaskManager(org.apache.camel.component.sjms.taskmanager.TimedTaskManager timedTaskManager)
```
    To use a custom TimedTaskManager. The option is a: org.apache.camel.component.sjms.taskmanager.TimedTaskManager type. Group: advanced
  - headerFilterStrategy
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter
  - connectionPassword
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: java.lang.String type. Group: security
  - connectionUsername
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: java.lang.String type. Group: security
  - transactionCommitStrategy
```
default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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: org.apache.camel.component.sjms.TransactionCommitStrategy type. Group: transaction

Interface Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder

Method Summary

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

Method Detail

connectionCount

bridgeErrorHandler

reconnectBackOff

reconnectOnError

lazyStartProducer

basicPropertyBinding

connectionClientId

connectionFactory

connectionMaxWait

connectionResource

connectionTestOnBorrow

destinationCreationStrategy

jmsKeyFormatStrategy

messageCreatedStrategy

timedTaskManager

headerFilterStrategy

connectionPassword

connectionUsername

transactionCommitStrategy