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 Summary

Modifier and Type	Method and Description
default FlatpackEndpointBuilderFactory.AdvancedFlatpackEndpointConsumerBuilder	advanced()
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	allowShortLines(boolean allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	allowShortLines(String allowShortLines) Allows for lines to be shorter than expected and ignores the extra characters.
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.
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.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
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.
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.
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.
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.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	delimiter(char delimiter) The default character delimiter for delimited files.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	delimiter(String delimiter) The default character delimiter for delimited files.
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.
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.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	ignoreExtraColumns(boolean ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	ignoreExtraColumns(String ignoreExtraColumns) Allows for lines to be longer than expected and ignores the extra characters.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	ignoreFirstRecord(boolean ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers).
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	ignoreFirstRecord(String ignoreFirstRecord) Whether the first line is ignored for delimited files (for the column headers).
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
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.
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.
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.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	splitRows(boolean splitRows) Sets the Component to send each row as a separate exchange once parsed.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	splitRows(String splitRows) Sets the Component to send each row as a separate exchange once parsed.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	textQualifier(char textQualifier) The text qualifier for delimited files.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	textQualifier(String textQualifier) The text qualifier for delimited files.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder	useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default FlatpackEndpointBuilderFactory.AdvancedFlatpackEndpointConsumerBuilder advanced()

allowShortLines

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder allowShortLines(boolean allowShortLines)

Allows for lines to be shorter than expected and ignores the extra characters. The option is a: boolean type. Default: false Group: common

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 boolean type. Default: false Group: common

delimiter

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder delimiter(char delimiter)

The default character delimiter for delimited files. The option is a: char type. Default: , Group: common

delimiter

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder delimiter(String delimiter)

The default character delimiter for delimited files. The option will be converted to a char type. Default: , Group: common

ignoreExtraColumns

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreExtraColumns(boolean ignoreExtraColumns)

Allows for lines to be longer than expected and ignores the extra characters. The option is a: boolean type. Default: false Group: common

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 boolean type. Default: false Group: common

ignoreFirstRecord

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder ignoreFirstRecord(boolean ignoreFirstRecord)

Whether the first line is ignored for delimited files (for the column headers). The option is a: boolean type. Default: true Group: common

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 boolean type. Default: true Group: common

splitRows

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder splitRows(boolean splitRows)

Sets the Component to send each row as a separate exchange once parsed. The option is a: boolean type. Default: true Group: common

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 boolean type. Default: true Group: common

textQualifier

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder textQualifier(char textQualifier)

The text qualifier for delimited files. The option is a: char type. Group: common

textQualifier

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder textQualifier(String textQualifier)

The text qualifier for delimited files. The option will be converted to a char type. Group: common

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

delay

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder delay(long delay)

Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler

delay

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder delay(String delay)

Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler

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: boolean type. Default: false Group: scheduler

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 boolean type. Default: false Group: scheduler

initialDelay

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder initialDelay(long initialDelay)

Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler

initialDelay

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder initialDelay(String initialDelay)

Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler

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: long type. Default: 0 Group: scheduler

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 long type. Default: 0 Group: scheduler

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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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: java.lang.Object type. Default: none Group: scheduler

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 java.lang.Object type. Default: none Group: scheduler

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: java.util.Map<java.lang.String, java.lang.Object> 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

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: java.util.Map<java.lang.String, java.lang.Object> 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

startScheduler

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder startScheduler(boolean startScheduler)

Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler

startScheduler

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder startScheduler(String startScheduler)

Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler

timeUnit

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)

Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

timeUnit

default FlatpackEndpointBuilderFactory.FlatpackEndpointConsumerBuilder timeUnit(String timeUnit)

Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

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: boolean type. Default: true Group: scheduler

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 boolean type. Default: true Group: scheduler