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

Interface FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    FlatpackEndpointBuilderFactory.FlatpackEndpointBuilder
    Enclosing interface:
    FlatpackEndpointBuilderFactory
    public static interface FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Flatpack component.

    • Method Detail

      • allowShortLines

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder allowShortLines​(boolean allowShortLines)
        Allows for lines to be shorter than expected and ignores the extra characters. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        allowShortLines - the value to set
        Returns:
        the dsl builder

      • allowShortLines

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder allowShortLines​(String allowShortLines)
        Allows for lines to be shorter than expected and ignores the extra characters. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        allowShortLines - the value to set
        Returns:
        the dsl builder

      • ignoreExtraColumns

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreExtraColumns​(boolean ignoreExtraColumns)
        Allows for lines to be longer than expected and ignores the extra characters. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        ignoreExtraColumns - the value to set
        Returns:
        the dsl builder

      • ignoreExtraColumns

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreExtraColumns​(String ignoreExtraColumns)
        Allows for lines to be longer than expected and ignores the extra characters. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        ignoreExtraColumns - the value to set
        Returns:
        the dsl builder

      • ignoreFirstRecord

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreFirstRecord​(boolean ignoreFirstRecord)
        Whether the first line is ignored for delimited files (for the column headers). The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        ignoreFirstRecord - the value to set
        Returns:
        the dsl builder

      • ignoreFirstRecord

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreFirstRecord​(String ignoreFirstRecord)
        Whether the first line is ignored for delimited files (for the column headers). The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        ignoreFirstRecord - the value to set
        Returns:
        the dsl builder

      • splitRows

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder splitRows​(boolean splitRows)
        Sets the Component to send each row as a separate exchange once parsed. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        splitRows - the value to set
        Returns:
        the dsl builder

      • splitRows

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder splitRows​(String splitRows)
        Sets the Component to send each row as a separate exchange once parsed. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        splitRows - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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

      • sendEmptyMessageWhenIdle

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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

      • backoffErrorThreshold

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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

      • repeatCount

        default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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 FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder 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