Package org.apache.camel.builder.endpoint.dsl

Interface SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
SjmsEndpointBuilderFactory.AdvancedSjmsEndpointBuilder
Enclosing interface:
SjmsEndpointBuilderFactory
public static interface SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Simple JMS component.

  • Method Details

    • basic

      default SjmsEndpointBuilderFactory.SjmsEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • eagerLoadingOfProperties

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder eagerLoadingOfProperties(boolean eagerLoadingOfProperties)
      Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      eagerLoadingOfProperties - the value to set
      Returns:
      the dsl builder

    • eagerLoadingOfProperties

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder eagerLoadingOfProperties(String eagerLoadingOfProperties)
      Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties. See also the option eagerPoisonBody. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      eagerLoadingOfProperties - the value to set
      Returns:
      the dsl builder

    • eagerPoisonBody

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder eagerPoisonBody(String eagerPoisonBody)
      If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties. The option is a: java.lang.String type. Default: Poison JMS message due to ${exception.message} Group: consumer (advanced)
      Parameters:
      eagerPoisonBody - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • messageSelector

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder messageSelector(String messageSelector)
      Sets the JMS Message selector syntax. The option is a: java.lang.String type. Group: consumer (advanced)
      Parameters:
      messageSelector - the value to set
      Returns:
      the dsl builder

    • replyToSameDestinationAllowed

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder replyToSameDestinationAllowed(boolean replyToSameDestinationAllowed)
      Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      replyToSameDestinationAllowed - the value to set
      Returns:
      the dsl builder

    • replyToSameDestinationAllowed

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder replyToSameDestinationAllowed(String replyToSameDestinationAllowed)
      Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      replyToSameDestinationAllowed - the value to set
      Returns:
      the dsl builder

    • asyncStartListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder asyncStartListener(boolean asyncStartListener)
      Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      asyncStartListener - the value to set
      Returns:
      the dsl builder

    • asyncStartListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder asyncStartListener(String asyncStartListener)
      Whether to startup the consumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or fail over. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      asyncStartListener - the value to set
      Returns:
      the dsl builder

    • asyncStopListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder asyncStopListener(boolean asyncStopListener)
      Whether to stop the consumer message listener asynchronously, when stopping a route. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      asyncStopListener - the value to set
      Returns:
      the dsl builder

    • asyncStopListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder asyncStopListener(String asyncStopListener)
      Whether to stop the consumer message listener asynchronously, when stopping a route. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      asyncStopListener - the value to set
      Returns:
      the dsl builder

    • destinationCreationStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder 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
      Parameters:
      destinationCreationStrategy - the value to set
      Returns:
      the dsl builder

    • destinationCreationStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder destinationCreationStrategy(String destinationCreationStrategy)
      To use a custom DestinationCreationStrategy. The option will be converted to a org.apache.camel.component.sjms.jms.DestinationCreationStrategy type. Group: advanced
      Parameters:
      destinationCreationStrategy - the value to set
      Returns:
      the dsl builder

    • exceptionListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exceptionListener(jakarta.jms.ExceptionListener exceptionListener)
      Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: jakarta.jms.ExceptionListener type. Group: advanced
      Parameters:
      exceptionListener - the value to set
      Returns:
      the dsl builder

    • exceptionListener

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder exceptionListener(String exceptionListener)
      Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option will be converted to a jakarta.jms.ExceptionListener type. Group: advanced
      Parameters:
      exceptionListener - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • includeAllJMSXProperties

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder includeAllJMSXProperties(boolean includeAllJMSXProperties)
      Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      includeAllJMSXProperties - the value to set
      Returns:
      the dsl builder

    • includeAllJMSXProperties

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder includeAllJMSXProperties(String includeAllJMSXProperties)
      Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      includeAllJMSXProperties - the value to set
      Returns:
      the dsl builder

    • jmsKeyFormatStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder 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 two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. 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
      Parameters:
      jmsKeyFormatStrategy - the value to set
      Returns:
      the dsl builder

    • jmsKeyFormatStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder jmsKeyFormatStrategy(String jmsKeyFormatStrategy)
      Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. 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 will be converted to a org.apache.camel.component.sjms.jms.JmsKeyFormatStrategy type. Group: advanced
      Parameters:
      jmsKeyFormatStrategy - the value to set
      Returns:
      the dsl builder

    • mapJmsMessage

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder mapJmsMessage(boolean mapJmsMessage)
      Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details. The option is a: boolean type. Default: true Group: advanced
      Parameters:
      mapJmsMessage - the value to set
      Returns:
      the dsl builder

    • mapJmsMessage

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder mapJmsMessage(String mapJmsMessage)
      Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. See section about how mapping works below for more details. The option will be converted to a boolean type. Default: true Group: advanced
      Parameters:
      mapJmsMessage - the value to set
      Returns:
      the dsl builder

    • messageCreatedStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder 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: org.apache.camel.component.sjms.jms.MessageCreatedStrategy type. Group: advanced
      Parameters:
      messageCreatedStrategy - the value to set
      Returns:
      the dsl builder

    • messageCreatedStrategy

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder messageCreatedStrategy(String 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 will be converted to a org.apache.camel.component.sjms.jms.MessageCreatedStrategy type. Group: advanced
      Parameters:
      messageCreatedStrategy - the value to set
      Returns:
      the dsl builder

    • recoveryInterval

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder 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: long type. Default: 5000 Group: advanced
      Parameters:
      recoveryInterval - the value to set
      Returns:
      the dsl builder

    • recoveryInterval

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder recoveryInterval(String 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 will be converted to a long type. Default: 5000 Group: advanced
      Parameters:
      recoveryInterval - the value to set
      Returns:
      the dsl builder

    • synchronous

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder synchronous(boolean synchronous)
      Sets whether synchronous processing should be strictly used. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder

    • synchronous

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder synchronous(String synchronous)
      Sets whether synchronous processing should be strictly used. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder

    • transferException

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder transferException(boolean transferException)
      If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • transferException

      default SjmsEndpointBuilderFactory.AdvancedSjmsEndpointConsumerBuilder transferException(String transferException)
      If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder