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

Interface Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    Jt400EndpointBuilderFactory.Jt400EndpointBuilder
    Enclosing interface:
    Jt400EndpointBuilderFactory
    public static interface Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the JT400 component.

    • Method Detail

      • format

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder format​(String format)
        Sets the data format for sending messages. The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration$Format</code> type. Default: text Group: common
        Parameters:
        format - the value to set
        Returns:
        the dsl builder

      • guiAvailable

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder guiAvailable​(boolean guiAvailable)
        Sets whether IBM i prompting is enabled in the environment running Camel. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        guiAvailable - the value to set
        Returns:
        the dsl builder

      • guiAvailable

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder guiAvailable​(String guiAvailable)
        Sets whether IBM i prompting is enabled in the environment running Camel. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        guiAvailable - the value to set
        Returns:
        the dsl builder

      • keyed

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder keyed​(boolean keyed)
        Whether to use keyed or non-keyed data queues. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        keyed - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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

      • messageAction

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder messageAction​(Jt400EndpointBuilderFactory.MessageAction messageAction)
        Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME). The option is a: <code>org.apache.camel.component.jt400.Jt400Configuration$MessageAction</code> type. Default: OLD Group: consumer
        Parameters:
        messageAction - the value to set
        Returns:
        the dsl builder

      • messageAction

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder messageAction​(String messageAction)
        Action to be taken on messages when read from a message queue. Messages can be marked as old (OLD), removed from the queue (REMOVE), or neither (SAME). The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration$MessageAction</code> type. Default: OLD Group: consumer
        Parameters:
        messageAction - the value to set
        Returns:
        the dsl builder

      • readTimeout

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder readTimeout​(int readTimeout)
        Timeout in millis the consumer will wait while trying to read a new message of the data queue. The option is a: <code>int</code> type. Default: 30000 Group: consumer
        Parameters:
        readTimeout - the value to set
        Returns:
        the dsl builder

      • readTimeout

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder readTimeout​(String readTimeout)
        Timeout in millis the consumer will wait while trying to read a new message of the data queue. The option will be converted to a <code>int</code> type. Default: 30000 Group: consumer
        Parameters:
        readTimeout - the value to set
        Returns:
        the dsl builder

      • searchType

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder searchType​(String searchType)
        Search type such as EQ for equal etc. The option will be converted to a <code>org.apache.camel.component.jt400.Jt400Configuration$SearchType</code> type. Default: EQ Group: consumer
        Parameters:
        searchType - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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

      • sendingReply

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder sendingReply​(boolean sendingReply)
        If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        sendingReply - the value to set
        Returns:
        the dsl builder

      • sendingReply

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder sendingReply​(String sendingReply)
        If true, the consumer endpoint will set the Jt400Constants.MESSAGE_REPLYTO_KEY header of the camel message for any IBM i inquiry messages received. If that message is then routed to a producer endpoint, the action will not be processed as sending a message to the queue, but rather a reply to the specific inquiry message. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        sendingReply - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder timeUnit​(TimeUnit timeUnit)
        Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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 Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder 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

      • secured

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder secured​(boolean secured)
        Whether connections to IBM i are secured with SSL. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        secured - the value to set
        Returns:
        the dsl builder

      • secured

        default Jt400EndpointBuilderFactory.Jt400EndpointConsumerBuilder secured​(String secured)
        Whether connections to IBM i are secured with SSL. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        secured - the value to set
        Returns:
        the dsl builder