org.apache.camel.builder.endpoint.dsl

Interface FileEndpointBuilderFactory.AdvancedFileEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder, FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Enclosing interface:

FileEndpointBuilderFactory

public static interface FileEndpointBuilderFactory.AdvancedFileEndpointBuilder
extends FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder, FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Advanced builder for endpoint for the File component.

Method Summary

Modifier and Type	Method and Description
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	autoCreate(boolean autoCreate) Automatically create missing directories in the file's pathname.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	autoCreate(String autoCreate) Automatically create missing directories in the file's pathname.
default FileEndpointBuilderFactory.FileEndpointBuilder	basic()
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	bufferSize(int bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	bufferSize(String bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	copyAndDeleteOnRenameFail(boolean copyAndDeleteOnRenameFail) Whether to fallback and do a copy and delete file, in case the file could not be renamed directly.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	copyAndDeleteOnRenameFail(String copyAndDeleteOnRenameFail) Whether to fallback and do a copy and delete file, in case the file could not be renamed directly.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	renameUsingCopy(boolean renameUsingCopy) Perform rename operations using a copy and delete strategy.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	renameUsingCopy(String renameUsingCopy) Perform rename operations using a copy and delete strategy.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used.
default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used.

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

directoryMustExist, directoryMustExist, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, extendedAttributes, inProgressRepository, inProgressRepository, localWorkDirectory, onCompletionExceptionHandler, onCompletionExceptionHandler, pollStrategy, pollStrategy, probeContentType, probeContentType, processStrategy, processStrategy, startingDirectoryMustExist, startingDirectoryMustExist, startingDirectoryMustHaveAccess, startingDirectoryMustHaveAccess

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

allowNullBody, allowNullBody, chmod, chmodDirectory, eagerDeleteTargetFile, eagerDeleteTargetFile, forceWrites, forceWrites, keepLastModified, keepLastModified, moveExistingFileStrategy, moveExistingFileStrategy

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default FileEndpointBuilderFactory.FileEndpointBuilder basic()

Specified by:

basic in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

basic in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

autoCreate

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder autoCreate(boolean autoCreate)

Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option is a: <code>boolean</code> type. Default: true Group: advanced

Specified by:

autoCreate in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

autoCreate in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

autoCreate

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder autoCreate(String autoCreate)

Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Specified by:

autoCreate in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

autoCreate in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

bufferSize

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder bufferSize(int bufferSize)

Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files). The option is a: <code>int</code> type. Default: 131072 Group: advanced

Specified by:

bufferSize in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

bufferSize in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder bufferSize(String bufferSize)

Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files). The option will be converted to a <code>int</code> type. Default: 131072 Group: advanced

Specified by:

bufferSize in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

bufferSize in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

copyAndDeleteOnRenameFail

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder copyAndDeleteOnRenameFail(boolean copyAndDeleteOnRenameFail)

Whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component. The option is a: <code>boolean</code> type. Default: true Group: advanced

Specified by:

copyAndDeleteOnRenameFail in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

copyAndDeleteOnRenameFail in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

copyAndDeleteOnRenameFail - the value to set

Returns:

the dsl builder

copyAndDeleteOnRenameFail

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder copyAndDeleteOnRenameFail(String copyAndDeleteOnRenameFail)

Whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Specified by:

copyAndDeleteOnRenameFail in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

copyAndDeleteOnRenameFail in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

copyAndDeleteOnRenameFail - the value to set

Returns:

the dsl builder

renameUsingCopy

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder renameUsingCopy(boolean renameUsingCopy)

Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

renameUsingCopy in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

renameUsingCopy in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

renameUsingCopy - the value to set

Returns:

the dsl builder

renameUsingCopy

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder renameUsingCopy(String renameUsingCopy)

Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

renameUsingCopy in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

renameUsingCopy in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

renameUsingCopy - the value to set

Returns:

the dsl builder

synchronous

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

synchronous in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default FileEndpointBuilderFactory.AdvancedFileEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface FileEndpointBuilderFactory.AdvancedFileEndpointConsumerBuilder

Specified by:

synchronous in interface FileEndpointBuilderFactory.AdvancedFileEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder