org.apache.camel.builder.endpoint.dsl

Interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

FileEndpointBuilderFactory.FileEndpointBuilder

Enclosing interface:

FileEndpointBuilderFactory

public static interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the File component.

Method Summary

Modifier and Type	Method and Description
default FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder	advanced()
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	antExclude(String antExclude) Ant style filter exclusion.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	antFilterCaseSensitive(boolean antFilterCaseSensitive) Sets case sensitive flag on ant filter.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	antFilterCaseSensitive(String antFilterCaseSensitive) Sets case sensitive flag on ant filter.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	antInclude(String antInclude) Ant style filter inclusion.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder	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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder	charset(String charset) This option is used to specify the encoding of the file.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	delete(boolean delete) If true, the file will be deleted after it is processed successfully.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	delete(String delete) If true, the file will be deleted after it is processed successfully.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	doneFileName(String doneFileName) Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	eagerMaxMessagesPerPoll(boolean eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	eagerMaxMessagesPerPoll(String eagerMaxMessagesPerPoll) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	exclude(String exclude) Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	exclusiveReadLockStrategy(Object exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	exclusiveReadLockStrategy(String exclusiveReadLockStrategy) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	fileName(org.apache.camel.Expression fileName) Use Expression such as File Language to dynamically set the filename.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	fileName(String fileName) Use Expression such as File Language to dynamically set the filename.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filter(Object filter) Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filter(String filter) Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filterDirectory(org.apache.camel.Predicate filterDirectory) Filters the directory based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filterDirectory(String filterDirectory) Filters the directory based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filterFile(org.apache.camel.Predicate filterFile) Filters the file based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	filterFile(String filterFile) Filters the file based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	greedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	greedy(String greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotent(Boolean idempotent) Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotent(String idempotent) Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotentKey(org.apache.camel.Expression idempotentKey) To use a custom idempotent key.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotentKey(String idempotentKey) To use a custom idempotent key.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	idempotentRepository(String idempotentRepository) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	include(String include) Is used to include files, if filename matches the regex pattern (matching is case in-sensitive).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	maxDepth(int maxDepth) The maximum depth to traverse when recursively processing a directory.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	maxDepth(String maxDepth) The maximum depth to traverse when recursively processing a directory.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	maxMessagesPerPoll(int maxMessagesPerPoll) To define a maximum messages to gather per poll.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	maxMessagesPerPoll(String maxMessagesPerPoll) To define a maximum messages to gather per poll.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	minDepth(int minDepth) The minimum depth to start processing when recursively processing a directory.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	minDepth(String minDepth) The minimum depth to start processing when recursively processing a directory.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	move(org.apache.camel.Expression move) Expression (such as Simple Language) used to dynamically set the filename when moving it after processing.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	move(String move) Expression (such as Simple Language) used to dynamically set the filename when moving it after processing.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	moveFailed(org.apache.camel.Expression moveFailed) Sets the move failure expression based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	moveFailed(String moveFailed) Sets the move failure expression based on Simple language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	noop(boolean noop) If true, the file is not moved or deleted in any way.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	noop(String noop) If true, the file is not moved or deleted in any way.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	preMove(org.apache.camel.Expression preMove) Expression (such as File Language) used to dynamically set the filename when moving it before processing.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	preMove(String preMove) Expression (such as File Language) used to dynamically set the filename when moving it before processing.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	preSort(boolean preSort) When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	preSort(String preSort) When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLock(String readLock) Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockCheckInterval(long readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockCheckInterval(String readLockCheckInterval) Interval in millis for the read-lock, if supported by the read lock.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockDeleteOrphanLockFiles(boolean readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockDeleteOrphanLockFiles(String readLockDeleteOrphanLockFiles) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseAsync(boolean readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseAsync(String readLockIdempotentReleaseAsync) Whether the delayed release task should be synchronous or asynchronous.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseAsyncPoolSize(int readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseAsyncPoolSize(String readLockIdempotentReleaseAsyncPoolSize) The number of threads in the scheduled thread pool when using asynchronous release tasks.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseDelay(int readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseDelay(String readLockIdempotentReleaseDelay) Whether to delay the release task for a period of millis.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseExecutorService(ScheduledExecutorService readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockIdempotentReleaseExecutorService(String readLockIdempotentReleaseExecutorService) To use a custom and shared thread pool for asynchronous release tasks.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockLoggingLevel(org.apache.camel.LoggingLevel readLockLoggingLevel) Logging level used when a read lock could not be acquired.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockLoggingLevel(String readLockLoggingLevel) Logging level used when a read lock could not be acquired.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMarkerFile(boolean readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMarkerFile(String readLockMarkerFile) Whether to use marker file with the changed, rename, or exclusive read lock types.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMinAge(long readLockMinAge) This option is applied only for readLock=changed.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMinAge(String readLockMinAge) This option is applied only for readLock=changed.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMinLength(long readLockMinLength) This option is applied only for readLock=changed.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockMinLength(String readLockMinLength) This option is applied only for readLock=changed.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockRemoveOnCommit(boolean readLockRemoveOnCommit) This option is applied only for readLock=idempotent.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockRemoveOnCommit(String readLockRemoveOnCommit) This option is applied only for readLock=idempotent.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockRemoveOnRollback(boolean readLockRemoveOnRollback) This option is applied only for readLock=idempotent.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockRemoveOnRollback(String readLockRemoveOnRollback) This option is applied only for readLock=idempotent.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockTimeout(long readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	readLockTimeout(String readLockTimeout) Optional timeout in millis for the read-lock, if supported by the read-lock.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	recursive(boolean recursive) If a directory, will look for files in all the sub-directories as well.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	recursive(String recursive) If a directory, will look for files in all the sub-directories as well.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder	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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder	shuffle(boolean shuffle) To shuffle the list of files (sort in random order).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	shuffle(String shuffle) To shuffle the list of files (sort in random order).
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	sortBy(Comparator<org.apache.camel.Exchange> sortBy) Built-in sort by using the File Language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	sortBy(String sortBy) Built-in sort by using the File Language.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	sorter(Comparator<Object> sorter) Pluggable sorter as a java.util.Comparator class.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	sorter(String sorter) Pluggable sorter as a java.util.Comparator class.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default FileEndpointBuilderFactory.FileEndpointConsumerBuilder	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 FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder advanced()

charset

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder charset(String charset)

This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. The option is a: java.lang.String type. Group: common

doneFileName

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder doneFileName(String doneFileName)

Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. The option is a: java.lang.String type. Group: common

fileName

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder fileName(org.apache.camel.Expression fileName)

Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option is a: org.apache.camel.Expression type. Group: common

fileName

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder fileName(String fileName)

Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option will be converted to a org.apache.camel.Expression type. Group: common

bridgeErrorHandler

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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

delete

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder delete(boolean delete)

If true, the file will be deleted after it is processed successfully. The option is a: boolean type. Default: false Group: consumer

delete

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder delete(String delete)

If true, the file will be deleted after it is processed successfully. The option will be converted to a boolean type. Default: false Group: consumer

moveFailed

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder moveFailed(org.apache.camel.Expression moveFailed)

Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. The option is a: org.apache.camel.Expression type. Group: consumer

moveFailed

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder moveFailed(String moveFailed)

Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. The option will be converted to a org.apache.camel.Expression type. Group: consumer

noop

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder noop(boolean noop)

If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again. The option is a: boolean type. Default: false Group: consumer

noop

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder noop(String noop)

If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again. The option will be converted to a boolean type. Default: false Group: consumer

preMove

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder preMove(org.apache.camel.Expression preMove)

Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. The option is a: org.apache.camel.Expression type. Group: consumer

preMove

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder preMove(String preMove)

Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. The option will be converted to a org.apache.camel.Expression type. Group: consumer

preSort

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder preSort(boolean preSort)

When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled. The option is a: boolean type. Default: false Group: consumer

preSort

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder preSort(String preSort)

When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled. The option will be converted to a boolean type. Default: false Group: consumer

recursive

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder recursive(boolean recursive)

If a directory, will look for files in all the sub-directories as well. The option is a: boolean type. Default: false Group: consumer

recursive

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder recursive(String recursive)

If a directory, will look for files in all the sub-directories as well. The option will be converted to a boolean type. Default: false Group: consumer

sendEmptyMessageWhenIdle

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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

antExclude

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder antExclude(String antExclude)

Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. The option is a: java.lang.String type. Group: filter

antFilterCaseSensitive

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder antFilterCaseSensitive(boolean antFilterCaseSensitive)

Sets case sensitive flag on ant filter. The option is a: boolean type. Default: true Group: filter

antFilterCaseSensitive

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder antFilterCaseSensitive(String antFilterCaseSensitive)

Sets case sensitive flag on ant filter. The option will be converted to a boolean type. Default: true Group: filter

antInclude

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder antInclude(String antInclude)

Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. The option is a: java.lang.String type. Group: filter

eagerMaxMessagesPerPoll

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder eagerMaxMessagesPerPoll(boolean eagerMaxMessagesPerPoll)

Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. The option is a: boolean type. Default: true Group: filter

eagerMaxMessagesPerPoll

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder eagerMaxMessagesPerPoll(String eagerMaxMessagesPerPoll)

Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. The option will be converted to a boolean type. Default: true Group: filter

exclude

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder exclude(String exclude)

Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. The option is a: java.lang.String type. Group: filter

filter

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filter(Object filter)

Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. The option is a: org.apache.camel.component.file.GenericFileFilter<java.io.File> type. Group: filter

filter

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filter(String filter)

Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. The option will be converted to a org.apache.camel.component.file.GenericFileFilter<java.io.File> type. Group: filter

filterDirectory

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filterDirectory(org.apache.camel.Predicate filterDirectory)

Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}. The option is a: org.apache.camel.Predicate type. Group: filter

filterDirectory

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filterDirectory(String filterDirectory)

Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}. The option will be converted to a org.apache.camel.Predicate type. Group: filter

filterFile

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filterFile(org.apache.camel.Predicate filterFile)

Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000. The option is a: org.apache.camel.Predicate type. Group: filter

filterFile

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder filterFile(String filterFile)

Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000. The option will be converted to a org.apache.camel.Predicate type. Group: filter

idempotent

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotent(Boolean idempotent)

Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. The option is a: java.lang.Boolean type. Default: false Group: filter

idempotent

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotent(String idempotent)

Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. The option will be converted to a java.lang.Boolean type. Default: false Group: filter

idempotentKey

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotentKey(org.apache.camel.Expression idempotentKey)

To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}. The option is a: org.apache.camel.Expression type. Group: filter

idempotentKey

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotentKey(String idempotentKey)

To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}. The option will be converted to a org.apache.camel.Expression type. Group: filter

idempotentRepository

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository)

A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. The option is a: org.apache.camel.spi.IdempotentRepository type. Group: filter

idempotentRepository

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder idempotentRepository(String idempotentRepository)

A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. The option will be converted to a org.apache.camel.spi.IdempotentRepository type. Group: filter

include

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder include(String include)

Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. The option is a: java.lang.String type. Group: filter

maxDepth

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder maxDepth(int maxDepth)

The maximum depth to traverse when recursively processing a directory. The option is a: int type. Default: 2147483647 Group: filter

maxDepth

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder maxDepth(String maxDepth)

The maximum depth to traverse when recursively processing a directory. The option will be converted to a int type. Default: 2147483647 Group: filter

maxMessagesPerPoll

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)

To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. The option is a: int type. Group: filter

maxMessagesPerPoll

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)

To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. The option will be converted to a int type. Group: filter

minDepth

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder minDepth(int minDepth)

The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. The option is a: int type. Group: filter

minDepth

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder minDepth(String minDepth)

The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. The option will be converted to a int type. Group: filter

move

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder move(org.apache.camel.Expression move)

Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. The option is a: org.apache.camel.Expression type. Group: filter

move

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder move(String move)

Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. The option will be converted to a org.apache.camel.Expression type. Group: filter

exclusiveReadLockStrategy

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder exclusiveReadLockStrategy(Object exclusiveReadLockStrategy)

Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. The option is a: org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<java.io.File> type. Group: lock

exclusiveReadLockStrategy

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder exclusiveReadLockStrategy(String exclusiveReadLockStrategy)

Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. The option will be converted to a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<java.io.File> type. Group: lock

readLock

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLock(String readLock)

Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan. The option is a: java.lang.String type. Default: none Group: lock

readLockCheckInterval

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockCheckInterval(long readLockCheckInterval)

Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option is a: long type. Default: 1000 Group: lock

readLockCheckInterval

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockCheckInterval(String readLockCheckInterval)

Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option will be converted to a long type. Default: 1000 Group: lock

readLockDeleteOrphanLockFiles

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockDeleteOrphanLockFiles(boolean readLockDeleteOrphanLockFiles)

Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory. The option is a: boolean type. Default: true Group: lock

readLockDeleteOrphanLockFiles

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockDeleteOrphanLockFiles(String readLockDeleteOrphanLockFiles)

Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory. The option will be converted to a boolean type. Default: true Group: lock

readLockIdempotentReleaseAsync

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseAsync(boolean readLockIdempotentReleaseAsync)

Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option. The option is a: boolean type. Default: false Group: lock

readLockIdempotentReleaseAsync

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseAsync(String readLockIdempotentReleaseAsync)

Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a boolean type. Default: false Group: lock

readLockIdempotentReleaseAsyncPoolSize

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseAsyncPoolSize(int readLockIdempotentReleaseAsyncPoolSize)

The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option. The option is a: int type. Group: lock

readLockIdempotentReleaseAsyncPoolSize

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseAsyncPoolSize(String readLockIdempotentReleaseAsyncPoolSize)

The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a int type. Group: lock

readLockIdempotentReleaseDelay

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseDelay(int readLockIdempotentReleaseDelay)

Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true. The option is a: int type. Group: lock

readLockIdempotentReleaseDelay

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseDelay(String readLockIdempotentReleaseDelay)

Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true. The option will be converted to a int type. Group: lock

readLockIdempotentReleaseExecutorService

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseExecutorService(ScheduledExecutorService readLockIdempotentReleaseExecutorService)

To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option. The option is a: java.util.concurrent.ScheduledExecutorService type. Group: lock

readLockIdempotentReleaseExecutorService

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockIdempotentReleaseExecutorService(String readLockIdempotentReleaseExecutorService)

To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a java.util.concurrent.ScheduledExecutorService type. Group: lock

readLockLoggingLevel

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockLoggingLevel(org.apache.camel.LoggingLevel readLockLoggingLevel)

Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename. The option is a: org.apache.camel.LoggingLevel type. Default: DEBUG Group: lock

readLockLoggingLevel

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockLoggingLevel(String readLockLoggingLevel)

Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename. The option will be converted to a org.apache.camel.LoggingLevel type. Default: DEBUG Group: lock

readLockMarkerFile

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMarkerFile(boolean readLockMarkerFile)

Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. The option is a: boolean type. Default: true Group: lock

readLockMarkerFile

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMarkerFile(String readLockMarkerFile)

Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. The option will be converted to a boolean type. Default: true Group: lock

readLockMinAge

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMinAge(long readLockMinAge)

This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. The option is a: long type. Default: 0 Group: lock

readLockMinAge

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMinAge(String readLockMinAge)

This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. The option will be converted to a long type. Default: 0 Group: lock

readLockMinLength

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMinLength(long readLockMinLength)

This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. The option is a: long type. Default: 1 Group: lock

readLockMinLength

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockMinLength(String readLockMinLength)

This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. The option will be converted to a long type. Default: 1 Group: lock

readLockRemoveOnCommit

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockRemoveOnCommit(boolean readLockRemoveOnCommit)

This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option. The option is a: boolean type. Default: false Group: lock

readLockRemoveOnCommit

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockRemoveOnCommit(String readLockRemoveOnCommit)

This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option. The option will be converted to a boolean type. Default: false Group: lock

readLockRemoveOnRollback

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockRemoveOnRollback(boolean readLockRemoveOnRollback)

This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit). The option is a: boolean type. Default: true Group: lock

readLockRemoveOnRollback

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockRemoveOnRollback(String readLockRemoveOnRollback)

This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit). The option will be converted to a boolean type. Default: true Group: lock

readLockTimeout

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockTimeout(long readLockTimeout)

Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option is a: long type. Default: 10000 Group: lock

readLockTimeout

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder readLockTimeout(String readLockTimeout)

Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. The option will be converted to a long type. Default: 10000 Group: lock

backoffErrorThreshold

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder delay(long delay)

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

delay

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder delay(String delay)

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

greedy

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder initialDelay(long initialDelay)

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

initialDelay

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder initialDelay(String initialDelay)

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

repeatCount

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder startScheduler(boolean startScheduler)

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

startScheduler

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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 FileEndpointBuilderFactory.FileEndpointConsumerBuilder 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

shuffle

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder shuffle(boolean shuffle)

To shuffle the list of files (sort in random order). The option is a: boolean type. Default: false Group: sort

shuffle

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder shuffle(String shuffle)

To shuffle the list of files (sort in random order). The option will be converted to a boolean type. Default: false Group: sort

sortBy

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder sortBy(Comparator<org.apache.camel.Exchange> sortBy)

Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. The option is a: java.util.Comparator<org.apache.camel.Exchange> type. Group: sort

sortBy

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder sortBy(String sortBy)

Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. The option will be converted to a java.util.Comparator<org.apache.camel.Exchange> type. Group: sort

sorter

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder sorter(Comparator<Object> sorter)

Pluggable sorter as a java.util.Comparator class. The option is a: java.util.Comparator<org.apache.camel.component.file.GenericFile<java.io.File>> type. Group: sort

sorter

default FileEndpointBuilderFactory.FileEndpointConsumerBuilder sorter(String sorter)

Pluggable sorter as a java.util.Comparator class. The option will be converted to a java.util.Comparator<org.apache.camel.component.file.GenericFile<java.io.File>> type. Group: sort