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

Interface AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    AMQPEndpointBuilderFactory.AdvancedAMQPEndpointBuilder
    Enclosing interface:
    AMQPEndpointBuilderFactory
    public static interface AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Advanced builder for endpoint producers for the AMQP component.

    • Method Detail

      • allowAdditionalHeaders

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder allowAdditionalHeaders​(String allowAdditionalHeaders)
        This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example some message systems such as WMQ do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)
        Parameters:
        allowAdditionalHeaders - the value to set
        Returns:
        the dsl builder

      • allowNullBody

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder allowNullBody​(boolean allowNullBody)
        Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)
        Parameters:
        allowNullBody - the value to set
        Returns:
        the dsl builder

      • allowNullBody

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder allowNullBody​(String allowNullBody)
        Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option will be converted to a <code>boolean</code> type. Default: true Group: producer (advanced)
        Parameters:
        allowNullBody - the value to set
        Returns:
        the dsl builder

      • alwaysCopyMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder alwaysCopyMessage​(boolean alwaysCopyMessage)
        If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set). The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        alwaysCopyMessage - the value to set
        Returns:
        the dsl builder

      • alwaysCopyMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder alwaysCopyMessage​(String alwaysCopyMessage)
        If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set). The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        alwaysCopyMessage - the value to set
        Returns:
        the dsl builder

      • correlationProperty

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder correlationProperty​(String correlationProperty)
        When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)
        Parameters:
        correlationProperty - the value to set
        Returns:
        the dsl builder

      • disableTimeToLive

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder disableTimeToLive​(boolean disableTimeToLive)
        Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        disableTimeToLive - the value to set
        Returns:
        the dsl builder

      • disableTimeToLive

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder disableTimeToLive​(String disableTimeToLive)
        Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        disableTimeToLive - the value to set
        Returns:
        the dsl builder

      • forceSendOriginalMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder forceSendOriginalMessage​(boolean forceSendOriginalMessage)
        When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        forceSendOriginalMessage - the value to set
        Returns:
        the dsl builder

      • forceSendOriginalMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder forceSendOriginalMessage​(String forceSendOriginalMessage)
        When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        forceSendOriginalMessage - the value to set
        Returns:
        the dsl builder

      • includeSentJMSMessageID

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder includeSentJMSMessageID​(boolean includeSentJMSMessageID)
        Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        includeSentJMSMessageID - the value to set
        Returns:
        the dsl builder

      • includeSentJMSMessageID

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder includeSentJMSMessageID​(String includeSentJMSMessageID)
        Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        includeSentJMSMessageID - the value to set
        Returns:
        the dsl builder

      • replyToCacheLevelName

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder replyToCacheLevelName​(String replyToCacheLevelName)
        Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)
        Parameters:
        replyToCacheLevelName - the value to set
        Returns:
        the dsl builder

      • replyToDestinationSelectorName

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder replyToDestinationSelectorName​(String replyToDestinationSelectorName)
        Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue). The option is a: <code>java.lang.String</code> type. Group: producer (advanced)
        Parameters:
        replyToDestinationSelectorName - the value to set
        Returns:
        the dsl builder

      • streamMessageTypeEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder streamMessageTypeEnabled​(boolean streamMessageTypeEnabled)
        Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        streamMessageTypeEnabled - the value to set
        Returns:
        the dsl builder

      • streamMessageTypeEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder streamMessageTypeEnabled​(String streamMessageTypeEnabled)
        Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)
        Parameters:
        streamMessageTypeEnabled - the value to set
        Returns:
        the dsl builder

      • allowSerializedHeaders

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder allowSerializedHeaders​(boolean allowSerializedHeaders)
        Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        allowSerializedHeaders - the value to set
        Returns:
        the dsl builder

      • allowSerializedHeaders

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder allowSerializedHeaders​(String allowSerializedHeaders)
        Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        allowSerializedHeaders - the value to set
        Returns:
        the dsl builder

      • artemisStreamingEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder artemisStreamingEnabled​(boolean artemisStreamingEnabled)
        Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        artemisStreamingEnabled - the value to set
        Returns:
        the dsl builder

      • artemisStreamingEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder artemisStreamingEnabled​(String artemisStreamingEnabled)
        Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        artemisStreamingEnabled - the value to set
        Returns:
        the dsl builder

      • asyncStartListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder asyncStartListener​(boolean asyncStartListener)
        Whether to startup the JmsConsumer 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: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        asyncStartListener - the value to set
        Returns:
        the dsl builder

      • asyncStartListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder asyncStartListener​(String asyncStartListener)
        Whether to startup the JmsConsumer 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 <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        asyncStartListener - the value to set
        Returns:
        the dsl builder

      • asyncStopListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder asyncStopListener​(boolean asyncStopListener)
        Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        asyncStopListener - the value to set
        Returns:
        the dsl builder

      • asyncStopListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder asyncStopListener​(String asyncStopListener)
        Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        asyncStopListener - the value to set
        Returns:
        the dsl builder

      • destinationResolver

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder destinationResolver​(Object destinationResolver)
        A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry). The option is a: <code>org.springframework.jms.support.destination.DestinationResolver</code> type. Group: advanced
        Parameters:
        destinationResolver - the value to set
        Returns:
        the dsl builder

      • destinationResolver

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder destinationResolver​(String destinationResolver)
        A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry). The option will be converted to a <code>org.springframework.jms.support.destination.DestinationResolver</code> type. Group: advanced
        Parameters:
        destinationResolver - the value to set
        Returns:
        the dsl builder

      • errorHandler

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder errorHandler​(Object errorHandler)
        Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler. The option is a: <code>org.springframework.util.ErrorHandler</code> type. Group: advanced
        Parameters:
        errorHandler - the value to set
        Returns:
        the dsl builder

      • errorHandler

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder errorHandler​(String errorHandler)
        Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler. The option will be converted to a <code>org.springframework.util.ErrorHandler</code> type. Group: advanced
        Parameters:
        errorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder exceptionListener​(Object exceptionListener)
        Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: <code>javax.jms.ExceptionListener</code> type. Group: advanced
        Parameters:
        exceptionListener - the value to set
        Returns:
        the dsl builder

      • exceptionListener

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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 <code>javax.jms.ExceptionListener</code> type. Group: advanced
        Parameters:
        exceptionListener - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

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

      • headerFilterStrategy

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

      • idleConsumerLimit

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder idleConsumerLimit​(int idleConsumerLimit)
        Specify the limit for the number of consumers that are allowed to be idle at any given time. The option is a: <code>int</code> type. Default: 1 Group: advanced
        Parameters:
        idleConsumerLimit - the value to set
        Returns:
        the dsl builder

      • idleConsumerLimit

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder idleConsumerLimit​(String idleConsumerLimit)
        Specify the limit for the number of consumers that are allowed to be idle at any given time. The option will be converted to a <code>int</code> type. Default: 1 Group: advanced
        Parameters:
        idleConsumerLimit - the value to set
        Returns:
        the dsl builder

      • idleTaskExecutionLimit

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder idleTaskExecutionLimit​(int idleTaskExecutionLimit)
        Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring. The option is a: <code>int</code> type. Default: 1 Group: advanced
        Parameters:
        idleTaskExecutionLimit - the value to set
        Returns:
        the dsl builder

      • idleTaskExecutionLimit

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder idleTaskExecutionLimit​(String idleTaskExecutionLimit)
        Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring. The option will be converted to a <code>int</code> type. Default: 1 Group: advanced
        Parameters:
        idleTaskExecutionLimit - the value to set
        Returns:
        the dsl builder

      • includeAllJMSXProperties

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        includeAllJMSXProperties - the value to set
        Returns:
        the dsl builder

      • includeAllJMSXProperties

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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 <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        includeAllJMSXProperties - the value to set
        Returns:
        the dsl builder

      • jmsKeyFormatStrategy

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

      • jmsKeyFormatStrategy

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

      • mapJmsMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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. The option is a: <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        mapJmsMessage - the value to set
        Returns:
        the dsl builder

      • mapJmsMessage

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        mapJmsMessage - the value to set
        Returns:
        the dsl builder

      • maxMessagesPerTask

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder maxMessagesPerTask​(int maxMessagesPerTask)
        The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required. The option is a: <code>int</code> type. Default: -1 Group: advanced
        Parameters:
        maxMessagesPerTask - the value to set
        Returns:
        the dsl builder

      • maxMessagesPerTask

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder maxMessagesPerTask​(String maxMessagesPerTask)
        The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required. The option will be converted to a <code>int</code> type. Default: -1 Group: advanced
        Parameters:
        maxMessagesPerTask - the value to set
        Returns:
        the dsl builder

      • messageConverter

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageConverter​(Object messageConverter)
        To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. The option is a: <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced
        Parameters:
        messageConverter - the value to set
        Returns:
        the dsl builder

      • messageConverter

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageConverter​(String messageConverter)
        To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. The option will be converted to a <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced
        Parameters:
        messageConverter - the value to set
        Returns:
        the dsl builder

      • messageCreatedStrategy

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

      • messageCreatedStrategy

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

      • messageIdEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageIdEnabled​(boolean messageIdEnabled)
        When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value. The option is a: <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        messageIdEnabled - the value to set
        Returns:
        the dsl builder

      • messageIdEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageIdEnabled​(String messageIdEnabled)
        When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        messageIdEnabled - the value to set
        Returns:
        the dsl builder

      • messageListenerContainerFactory

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageListenerContainerFactory​(Object messageListenerContainerFactory)
        Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom. The option is a: <code>org.apache.camel.component.jms.MessageListenerContainerFactory</code> type. Group: advanced
        Parameters:
        messageListenerContainerFactory - the value to set
        Returns:
        the dsl builder

      • messageListenerContainerFactory

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageListenerContainerFactory​(String messageListenerContainerFactory)
        Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom. The option will be converted to a <code>org.apache.camel.component.jms.MessageListenerContainerFactory</code> type. Group: advanced
        Parameters:
        messageListenerContainerFactory - the value to set
        Returns:
        the dsl builder

      • messageTimestampEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageTimestampEnabled​(boolean messageTimestampEnabled)
        Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value. The option is a: <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        messageTimestampEnabled - the value to set
        Returns:
        the dsl builder

      • messageTimestampEnabled

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder messageTimestampEnabled​(String messageTimestampEnabled)
        Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced
        Parameters:
        messageTimestampEnabled - the value to set
        Returns:
        the dsl builder

      • pubSubNoLocal

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder pubSubNoLocal​(boolean pubSubNoLocal)
        Specifies whether to inhibit the delivery of messages published by its own connection. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        pubSubNoLocal - the value to set
        Returns:
        the dsl builder

      • pubSubNoLocal

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder pubSubNoLocal​(String pubSubNoLocal)
        Specifies whether to inhibit the delivery of messages published by its own connection. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        pubSubNoLocal - the value to set
        Returns:
        the dsl builder

      • receiveTimeout

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder receiveTimeout​(long receiveTimeout)
        The timeout for receiving messages (in milliseconds). The option is a: <code>long</code> type. Default: 1000 Group: advanced
        Parameters:
        receiveTimeout - the value to set
        Returns:
        the dsl builder

      • receiveTimeout

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder receiveTimeout​(String receiveTimeout)
        The timeout for receiving messages (in milliseconds). The option will be converted to a <code>long</code> type. Default: 1000 Group: advanced
        Parameters:
        receiveTimeout - the value to set
        Returns:
        the dsl builder

      • recoveryInterval

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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

      • recoveryInterval

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

      • requestTimeoutCheckerInterval

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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

      • requestTimeoutCheckerInterval

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder requestTimeoutCheckerInterval​(String 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 will be converted to a <code>long</code> type. Default: 1000 Group: advanced
        Parameters:
        requestTimeoutCheckerInterval - the value to set
        Returns:
        the dsl builder

      • synchronous

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder synchronous​(boolean synchronous)
        Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder

      • synchronous

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder synchronous​(String synchronous)
        Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder

      • transferException

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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 javax.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: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        transferException - the value to set
        Returns:
        the dsl builder

      • transferException

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder 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 javax.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 <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        transferException - the value to set
        Returns:
        the dsl builder

      • transferExchange

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transferExchange​(boolean transferExchange)
        You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        transferExchange - the value to set
        Returns:
        the dsl builder

      • transferExchange

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transferExchange​(String transferExchange)
        You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload. Use this with caution as the data is using Java Object serialization and requires the receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        transferExchange - the value to set
        Returns:
        the dsl builder

      • useMessageIDAsCorrelationID

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder useMessageIDAsCorrelationID​(boolean useMessageIDAsCorrelationID)
        Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        useMessageIDAsCorrelationID - the value to set
        Returns:
        the dsl builder

      • useMessageIDAsCorrelationID

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder useMessageIDAsCorrelationID​(String useMessageIDAsCorrelationID)
        Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        useMessageIDAsCorrelationID - the value to set
        Returns:
        the dsl builder

      • waitForProvisionCorrelationToBeUpdatedCounter

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder waitForProvisionCorrelationToBeUpdatedCounter​(int waitForProvisionCorrelationToBeUpdatedCounter)
        Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. The option is a: <code>int</code> type. Default: 50 Group: advanced
        Parameters:
        waitForProvisionCorrelationToBeUpdatedCounter - the value to set
        Returns:
        the dsl builder

      • waitForProvisionCorrelationToBeUpdatedCounter

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder waitForProvisionCorrelationToBeUpdatedCounter​(String waitForProvisionCorrelationToBeUpdatedCounter)
        Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. The option will be converted to a <code>int</code> type. Default: 50 Group: advanced
        Parameters:
        waitForProvisionCorrelationToBeUpdatedCounter - the value to set
        Returns:
        the dsl builder

      • waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder waitForProvisionCorrelationToBeUpdatedThreadSleepingTime​(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)
        Interval in millis to sleep each time while waiting for provisional correlation id to be updated. The option is a: <code>long</code> type. Default: 100 Group: advanced
        Parameters:
        waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set
        Returns:
        the dsl builder

      • waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder waitForProvisionCorrelationToBeUpdatedThreadSleepingTime​(String waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)
        Interval in millis to sleep each time while waiting for provisional correlation id to be updated. The option will be converted to a <code>long</code> type. Default: 100 Group: advanced
        Parameters:
        waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set
        Returns:
        the dsl builder

      • lazyCreateTransactionManager

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder lazyCreateTransactionManager​(boolean lazyCreateTransactionManager)
        If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. The option is a: <code>boolean</code> type. Default: true Group: transaction (advanced)
        Parameters:
        lazyCreateTransactionManager - the value to set
        Returns:
        the dsl builder

      • lazyCreateTransactionManager

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder lazyCreateTransactionManager​(String lazyCreateTransactionManager)
        If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. The option will be converted to a <code>boolean</code> type. Default: true Group: transaction (advanced)
        Parameters:
        lazyCreateTransactionManager - the value to set
        Returns:
        the dsl builder

      • transactionManager

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transactionManager​(Object transactionManager)
        The Spring transaction manager to use. The option is a: <code>org.springframework.transaction.PlatformTransactionManager</code> type. Group: transaction (advanced)
        Parameters:
        transactionManager - the value to set
        Returns:
        the dsl builder

      • transactionManager

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transactionManager​(String transactionManager)
        The Spring transaction manager to use. The option will be converted to a <code>org.springframework.transaction.PlatformTransactionManager</code> type. Group: transaction (advanced)
        Parameters:
        transactionManager - the value to set
        Returns:
        the dsl builder

      • transactionTimeout

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transactionTimeout​(int transactionTimeout)
        The timeout value of the transaction (in seconds), if using transacted mode. The option is a: <code>int</code> type. Default: -1 Group: transaction (advanced)
        Parameters:
        transactionTimeout - the value to set
        Returns:
        the dsl builder

      • transactionTimeout

        default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointProducerBuilder transactionTimeout​(String transactionTimeout)
        The timeout value of the transaction (in seconds), if using transacted mode. The option will be converted to a <code>int</code> type. Default: -1 Group: transaction (advanced)
        Parameters:
        transactionTimeout - the value to set
        Returns:
        the dsl builder