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

Interface ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    ActiveMQEndpointBuilderFactory.ActiveMQEndpointBuilder
    Enclosing interface:
    ActiveMQEndpointBuilderFactory
    public static interface ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the ActiveMQ component.

    • Method Detail

      • clientId

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder clientId​(String clientId)
        Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        clientId - the value to set
        Returns:
        the dsl builder

      • connectionFactory

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder connectionFactory​(javax.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>javax.jms.ConnectionFactory</code> type. Group: common
        Parameters:
        connectionFactory - the value to set
        Returns:
        the dsl builder

      • connectionFactory

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder connectionFactory​(String connectionFactory)
        The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option will be converted to a <code>javax.jms.ConnectionFactory</code> type. Group: common
        Parameters:
        connectionFactory - the value to set
        Returns:
        the dsl builder

      • disableReplyTo

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder disableReplyTo​(boolean disableReplyTo)
        Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        disableReplyTo - the value to set
        Returns:
        the dsl builder

      • disableReplyTo

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder disableReplyTo​(String disableReplyTo)
        Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        disableReplyTo - the value to set
        Returns:
        the dsl builder

      • durableSubscriptionName

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder durableSubscriptionName​(String durableSubscriptionName)
        The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        durableSubscriptionName - the value to set
        Returns:
        the dsl builder

      • jmsMessageType

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder jmsMessageType​(org.apache.camel.component.jms.JmsMessageType jmsMessageType)
        Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. The option is a: <code>org.apache.camel.component.jms.JmsMessageType</code> type. Group: common
        Parameters:
        jmsMessageType - the value to set
        Returns:
        the dsl builder

      • jmsMessageType

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder jmsMessageType​(String jmsMessageType)
        Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. The option will be converted to a <code>org.apache.camel.component.jms.JmsMessageType</code> type. Group: common
        Parameters:
        jmsMessageType - the value to set
        Returns:
        the dsl builder

      • replyTo

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder replyTo​(String replyTo)
        Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer). The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        replyTo - the value to set
        Returns:
        the dsl builder

      • testConnectionOnStartup

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder testConnectionOnStartup​(boolean testConnectionOnStartup)
        Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        testConnectionOnStartup - the value to set
        Returns:
        the dsl builder

      • testConnectionOnStartup

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder testConnectionOnStartup​(String testConnectionOnStartup)
        Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        testConnectionOnStartup - the value to set
        Returns:
        the dsl builder

      • acknowledgementModeName

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder acknowledgementModeName​(String acknowledgementModeName)
        The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE. The option is a: <code>java.lang.String</code> type. Default: AUTO_ACKNOWLEDGE Group: consumer
        Parameters:
        acknowledgementModeName - the value to set
        Returns:
        the dsl builder

      • artemisConsumerPriority

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder artemisConsumerPriority​(int artemisConsumerPriority)
        Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer). The option is a: <code>int</code> type. Group: consumer
        Parameters:
        artemisConsumerPriority - the value to set
        Returns:
        the dsl builder

      • artemisConsumerPriority

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder artemisConsumerPriority​(String artemisConsumerPriority)
        Consumer priorities allow you to ensure that high priority consumers receive messages while they are active. Normally, active consumers connected to a queue receive messages from it in a round-robin fashion. When consumer priorities are in use, messages are delivered round-robin if multiple active consumers exist with the same high priority. Messages will only going to lower priority consumers when the high priority consumers do not have credit available to consume the message, or those high priority consumers have declined to accept the message (for instance because it does not meet the criteria of any selectors associated with the consumer). The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        artemisConsumerPriority - the value to set
        Returns:
        the dsl builder

      • asyncConsumer

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder asyncConsumer​(boolean asyncConsumer)
        Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions). The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        asyncConsumer - the value to set
        Returns:
        the dsl builder

      • asyncConsumer

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder asyncConsumer​(String asyncConsumer)
        Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions). The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        asyncConsumer - the value to set
        Returns:
        the dsl builder

      • autoStartup

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder autoStartup​(boolean autoStartup)
        Specifies whether the consumer container should auto-startup. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        autoStartup - the value to set
        Returns:
        the dsl builder

      • autoStartup

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder autoStartup​(String autoStartup)
        Specifies whether the consumer container should auto-startup. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        autoStartup - the value to set
        Returns:
        the dsl builder

      • cacheLevel

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder cacheLevel​(int cacheLevel)
        Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. The option is a: <code>int</code> type. Group: consumer
        Parameters:
        cacheLevel - the value to set
        Returns:
        the dsl builder

      • cacheLevel

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder cacheLevel​(String cacheLevel)
        Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        cacheLevel - the value to set
        Returns:
        the dsl builder

      • cacheLevelName

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder cacheLevelName​(String cacheLevelName)
        Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. The option is a: <code>java.lang.String</code> type. Default: CACHE_AUTO Group: consumer
        Parameters:
        cacheLevelName - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder concurrentConsumers​(int concurrentConsumers)
        Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option is a: <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        concurrentConsumers - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder concurrentConsumers​(String concurrentConsumers)
        Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        concurrentConsumers - the value to set
        Returns:
        the dsl builder

      • maxConcurrentConsumers

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder maxConcurrentConsumers​(int maxConcurrentConsumers)
        Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option is a: <code>int</code> type. Group: consumer
        Parameters:
        maxConcurrentConsumers - the value to set
        Returns:
        the dsl builder

      • maxConcurrentConsumers

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder maxConcurrentConsumers​(String maxConcurrentConsumers)
        Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        maxConcurrentConsumers - the value to set
        Returns:
        the dsl builder

      • replyToDeliveryPersistent

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder replyToDeliveryPersistent​(boolean replyToDeliveryPersistent)
        Specifies whether to use persistent delivery by default for replies. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        replyToDeliveryPersistent - the value to set
        Returns:
        the dsl builder

      • replyToDeliveryPersistent

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder replyToDeliveryPersistent​(String replyToDeliveryPersistent)
        Specifies whether to use persistent delivery by default for replies. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        replyToDeliveryPersistent - the value to set
        Returns:
        the dsl builder

      • subscriptionDurable

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder subscriptionDurable​(boolean subscriptionDurable)
        Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        subscriptionDurable - the value to set
        Returns:
        the dsl builder

      • subscriptionDurable

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder subscriptionDurable​(String subscriptionDurable)
        Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        subscriptionDurable - the value to set
        Returns:
        the dsl builder

      • subscriptionName

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder subscriptionName​(String subscriptionName)
        Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0). The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        subscriptionName - the value to set
        Returns:
        the dsl builder

      • subscriptionShared

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder subscriptionShared​(boolean subscriptionShared)
        Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        subscriptionShared - the value to set
        Returns:
        the dsl builder

      • subscriptionShared

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder subscriptionShared​(String subscriptionShared)
        Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        subscriptionShared - the value to set
        Returns:
        the dsl builder

      • errorHandlerLoggingLevel

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder errorHandlerLoggingLevel​(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)
        Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: logging
        Parameters:
        errorHandlerLoggingLevel - the value to set
        Returns:
        the dsl builder

      • errorHandlerLoggingLevel

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder errorHandlerLoggingLevel​(String errorHandlerLoggingLevel)
        Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: logging
        Parameters:
        errorHandlerLoggingLevel - the value to set
        Returns:
        the dsl builder

      • errorHandlerLogStackTrace

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder errorHandlerLogStackTrace​(boolean errorHandlerLogStackTrace)
        Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option is a: <code>boolean</code> type. Default: true Group: logging
        Parameters:
        errorHandlerLogStackTrace - the value to set
        Returns:
        the dsl builder

      • errorHandlerLogStackTrace

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder errorHandlerLogStackTrace​(String errorHandlerLogStackTrace)
        Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option will be converted to a <code>boolean</code> type. Default: true Group: logging
        Parameters:
        errorHandlerLogStackTrace - the value to set
        Returns:
        the dsl builder

      • password

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder password​(String password)
        Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        password - the value to set
        Returns:
        the dsl builder

      • username

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder username​(String username)
        Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        username - the value to set
        Returns:
        the dsl builder

      • transactedInOut

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder transactedInOut​(boolean transactedInOut)
        Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction. The option is a: <code>boolean</code> type. Default: false Group: transaction
        Parameters:
        transactedInOut - the value to set
        Returns:
        the dsl builder

      • transactedInOut

        default ActiveMQEndpointBuilderFactory.ActiveMQEndpointConsumerBuilder transactedInOut​(String transactedInOut)
        Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction. The option will be converted to a <code>boolean</code> type. Default: false Group: transaction
        Parameters:
        transactedInOut - the value to set
        Returns:
        the dsl builder