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

Interface IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    IronMQEndpointBuilderFactory.IronMQEndpointBuilder
    Enclosing interface:
    IronMQEndpointBuilderFactory
    public static interface IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the IronMQ component.

    • Method Detail

      • ironMQCloud

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder ironMQCloud​(String ironMQCloud)
        IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU). The option is a: <code>java.lang.String</code> type. Default: https://mq-aws-us-east-1-1.iron.io Group: common
        Parameters:
        ironMQCloud - the value to set
        Returns:
        the dsl builder

      • preserveHeaders

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder preserveHeaders​(boolean preserveHeaders)
        Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        preserveHeaders - the value to set
        Returns:
        the dsl builder

      • preserveHeaders

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder preserveHeaders​(String preserveHeaders)
        Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        preserveHeaders - the value to set
        Returns:
        the dsl builder

      • batchDelete

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder batchDelete​(boolean batchDelete)
        Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        batchDelete - the value to set
        Returns:
        the dsl builder

      • batchDelete

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder batchDelete​(String batchDelete)
        Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        batchDelete - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder concurrentConsumers​(int concurrentConsumers)
        The number of concurrent consumers. The option is a: <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        concurrentConsumers - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder concurrentConsumers​(String concurrentConsumers)
        The number of concurrent consumers. 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

      • maxMessagesPerPoll

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder maxMessagesPerPoll​(int maxMessagesPerPoll)
        Number of messages to poll pr. call. Maximum is 100. The option is a: <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        maxMessagesPerPoll - the value to set
        Returns:
        the dsl builder

      • maxMessagesPerPoll

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder maxMessagesPerPoll​(String maxMessagesPerPoll)
        Number of messages to poll pr. call. Maximum is 100. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        maxMessagesPerPoll - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder sendEmptyMessageWhenIdle​(boolean sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder sendEmptyMessageWhenIdle​(String sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • timeout

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder timeout​(int timeout)
        After timeout (in seconds), item will be placed back onto the queue. The option is a: <code>int</code> type. Default: 60 Group: consumer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • timeout

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder timeout​(String timeout)
        After timeout (in seconds), item will be placed back onto the queue. The option will be converted to a <code>int</code> type. Default: 60 Group: consumer
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • wait

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder wait​(int wait)
        Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30. The option is a: <code>int</code> type. Group: consumer
        Parameters:
        wait - the value to set
        Returns:
        the dsl builder

      • wait

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder wait​(String wait)
        Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        wait - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffErrorThreshold​(int backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffErrorThreshold​(String backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffIdleThreshold​(String backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffMultiplier​(int backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffMultiplier​(String backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • greedy

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder greedy​(boolean greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • greedy

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder greedy​(String greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder initialDelay​(long initialDelay)
        Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder initialDelay​(String initialDelay)
        Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder repeatCount​(long repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder repeatCount​(String repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder runLoggingLevel​(org.apache.camel.LoggingLevel runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder runLoggingLevel​(String runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduledExecutorService​(ScheduledExecutorService scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduledExecutorService​(String scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduler​(Object scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • scheduler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduler​(String scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • schedulerProperties

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder schedulerProperties​(String key,
                                                                                       Object value)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • schedulerProperties

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • startScheduler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder startScheduler​(boolean startScheduler)
        Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • startScheduler

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder startScheduler​(String startScheduler)
        Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder timeUnit​(String timeUnit)
        Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder useFixedDelay​(String useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder