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 TypeMethodDescriptionautowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.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.connectionFactory
(jakarta.jms.ConnectionFactory connectionFactory) The connection factory to be use.destinationCreationStrategy
(org.apache.camel.component.sjms.jms.DestinationCreationStrategy destinationCreationStrategy) To use a custom DestinationCreationStrategy.exceptionListener
(jakarta.jms.ExceptionListener exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.headerFilterStrategy
(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.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.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).messageCreatedStrategy
(org.apache.camel.component.sjms.jms.MessageCreatedStrategy messageCreatedStrategy) To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.recoveryInterval
(long recoveryInterval) Specifies the interval between recovery attempts, i.e.replyToOnTimeoutMaxConcurrentConsumers
(int replyToOnTimeoutMaxConcurrentConsumers) Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.requestTimeoutCheckerInterval
(long requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
connectionFactory
default SjmsComponentBuilderFactory.SjmsComponentBuilder 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- 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
-
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
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
-
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
-
exceptionListener
default SjmsComponentBuilderFactory.SjmsComponentBuilder exceptionListener(jakarta.jms.ExceptionListener exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: <code>jakarta.jms.ExceptionListener</code> type. Group: advanced- Parameters:
exceptionListener
- 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 jakarta.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
-
recoveryInterval
Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. The option is a: <code>long</code> type. Default: 5000 Group: advanced- Parameters:
recoveryInterval
- the value to set- Returns:
- the dsl builder
-
replyToOnTimeoutMaxConcurrentConsumers
default SjmsComponentBuilderFactory.SjmsComponentBuilder replyToOnTimeoutMaxConcurrentConsumers(int replyToOnTimeoutMaxConcurrentConsumers) Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. The option is a: <code>int</code> type. Default: 1 Group: advanced- Parameters:
replyToOnTimeoutMaxConcurrentConsumers
- the value to set- Returns:
- the dsl builder
-
requestTimeoutCheckerInterval
default SjmsComponentBuilderFactory.SjmsComponentBuilder requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout. The option is a: <code>long</code> type. Default: 1000 Group: advanced- Parameters:
requestTimeoutCheckerInterval
- 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
-