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

Interface Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointBuilder
    Enclosing interface:
    Sjms2EndpointBuilderFactory
    public static interface Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the Simple JMS2 component.

    • Method Detail

      • exceptionHandler

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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)

      • exceptionHandler

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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)

      • asyncStartListener

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 failover. 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

      • asyncStartListener

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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 failover. 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

      • basicPropertyBinding

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder basicPropertyBinding​(boolean basicPropertyBinding)
        Whether the endpoint 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

      • basicPropertyBinding

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder basicPropertyBinding​(String basicPropertyBinding)
        Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced

      • connectionResource

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionResource​(Object connectionResource)
        Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any. The option is a: org.apache.camel.component.sjms.jms.ConnectionResource type. Group: advanced

      • connectionResource

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder connectionResource​(String connectionResource)
        Initializes the connectionResource for the endpoint, which takes precedence over the component's connectionResource, if any. The option will be converted to a org.apache.camel.component.sjms.jms.ConnectionResource type. Group: advanced

      • headerFilterStrategy

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

      • includeAllJMSXProperties

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

      • includeAllJMSXProperties

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

      • jmsKeyFormatStrategy

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder jmsKeyFormatStrategy​(Object 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

      • jmsKeyFormatStrategy

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder 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

      • mapJmsMessage

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder mapJmsMessage​(boolean mapJmsMessage)
        Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.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

      • mapJmsMessage

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder mapJmsMessage​(String mapJmsMessage)
        Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.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

      • messageCreatedStrategy

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder messageCreatedStrategy​(Object 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

      • messageCreatedStrategy

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder messageCreatedStrategy​(String 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 will be converted to a org.apache.camel.component.sjms.jms.MessageCreatedStrategy type. Group: advanced

      • sharedJMSSession

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder sharedJMSSession​(boolean sharedJMSSession)
        Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers, use jms component to leverage XA transaction. The option is a: boolean type. Default: true Group: transaction (advanced)

      • sharedJMSSession

        default Sjms2EndpointBuilderFactory.AdvancedSjms2EndpointConsumerBuilder sharedJMSSession​(String sharedJMSSession)
        Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers, use jms component to leverage XA transaction. The option will be converted to a boolean type. Default: true Group: transaction (advanced)