Interface Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder

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 Details

    • connectionFactory

      default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 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: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder
    • autowiredEnabled

      default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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
    • destinationCreationStrategy

      default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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 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: <code>org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy</code> type. Group: advanced
      Parameters:
      jmsKeyFormatStrategy - the value to set
      Returns:
      the dsl builder
    • 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 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

      default Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder recoveryInterval(long 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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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 Sjms2ComponentBuilderFactory.Sjms2ComponentBuilder 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 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: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder