org.apache.camel.builder.endpoint.dsl

Interface FileEndpointBuilderFactory.FileEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FileEndpointBuilderFactory.FileEndpointConsumerBuilder, FileEndpointBuilderFactory.FileEndpointProducerBuilder

Enclosing interface:

FileEndpointBuilderFactory

public static interface FileEndpointBuilderFactory.FileEndpointBuilder
extends FileEndpointBuilderFactory.FileEndpointConsumerBuilder, FileEndpointBuilderFactory.FileEndpointProducerBuilder

Builder for endpoint for the File component.

Method Summary

Modifier and Type	Method and Description
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	advanced()
default FileEndpointBuilderFactory.FileEndpointBuilder	charset(String charset) This option is used to specify the encoding of the file.
default FileEndpointBuilderFactory.FileEndpointBuilder	doneFileName(String doneFileName) Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default FileEndpointBuilderFactory.FileEndpointBuilder	fileName(org.apache.camel.Expression fileName) Use Expression such as File Language to dynamically set the filename.
default FileEndpointBuilderFactory.FileEndpointBuilder	fileName(String fileName) Use Expression such as File Language to dynamically set the filename.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FileEndpointBuilderFactory.FileEndpointConsumerBuilder

antExclude, antFilterCaseSensitive, antFilterCaseSensitive, antInclude, backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, delete, delete, eagerMaxMessagesPerPoll, eagerMaxMessagesPerPoll, exclude, excludeExt, exclusiveReadLockStrategy, exclusiveReadLockStrategy, filter, filter, filterDirectory, filterDirectory, filterFile, filterFile, greedy, greedy, idempotent, idempotent, idempotentKey, idempotentKey, idempotentRepository, idempotentRepository, include, includeExt, initialDelay, initialDelay, maxDepth, maxDepth, maxMessagesPerPoll, maxMessagesPerPoll, minDepth, minDepth, move, move, moveFailed, moveFailed, noop, noop, preMove, preMove, preSort, preSort, readLock, readLockCheckInterval, readLockCheckInterval, readLockDeleteOrphanLockFiles, readLockDeleteOrphanLockFiles, readLockIdempotentReleaseAsync, readLockIdempotentReleaseAsync, readLockIdempotentReleaseAsyncPoolSize, readLockIdempotentReleaseAsyncPoolSize, readLockIdempotentReleaseDelay, readLockIdempotentReleaseDelay, readLockIdempotentReleaseExecutorService, readLockIdempotentReleaseExecutorService, readLockLoggingLevel, readLockLoggingLevel, readLockMarkerFile, readLockMarkerFile, readLockMinAge, readLockMinAge, readLockMinLength, readLockMinLength, readLockRemoveOnCommit, readLockRemoveOnCommit, readLockRemoveOnRollback, readLockRemoveOnRollback, readLockTimeout, readLockTimeout, recursive, recursive, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, shuffle, shuffle, sortBy, sortBy, sorter, sorter, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FileEndpointBuilderFactory.FileEndpointProducerBuilder

appendChars, fileExist, fileExist, flatten, flatten, jailStartingDirectory, jailStartingDirectory, lazyStartProducer, lazyStartProducer, moveExisting, moveExisting, tempFileName, tempFileName, tempPrefix

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder advanced()

Specified by:

advanced in interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

Specified by:

advanced in interface FileEndpointBuilderFactory.FileEndpointProducerBuilder

charset

default FileEndpointBuilderFactory.FileEndpointBuilder 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: <code>java.lang.String</code> type. Group: common

Specified by:

charset in interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

Specified by:

charset in interface FileEndpointBuilderFactory.FileEndpointProducerBuilder

Parameters:

charset - the value to set

Returns:

the dsl builder

doneFileName

default FileEndpointBuilderFactory.FileEndpointBuilder 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: <code>java.lang.String</code> type. Group: common

Specified by:

doneFileName in interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

Specified by:

doneFileName in interface FileEndpointBuilderFactory.FileEndpointProducerBuilder

Parameters:

doneFileName - the value to set

Returns:

the dsl builder

fileName

default FileEndpointBuilderFactory.FileEndpointBuilder 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: <code>org.apache.camel.Expression</code> type. Group: common

Specified by:

fileName in interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

Specified by:

fileName in interface FileEndpointBuilderFactory.FileEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder

fileName

default FileEndpointBuilderFactory.FileEndpointBuilder 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 <code>org.apache.camel.Expression</code> type. Group: common

Specified by:

fileName in interface FileEndpointBuilderFactory.FileEndpointConsumerBuilder

Specified by:

fileName in interface FileEndpointBuilderFactory.FileEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder