org.apache.camel.builder.endpoint.dsl

Interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

FtpsEndpointBuilderFactory.AdvancedFtpsEndpointBuilder

Enclosing interface:

FtpsEndpointBuilderFactory

public static interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the FTPS component.

Method Summary

Modifier and Type	Method and Description
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	activePortRange(String activePortRange) Set the client side port range in active mode.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	autoCreate(boolean autoCreate) Automatically create missing directories in the file's pathname.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	autoCreate(String autoCreate) Automatically create missing directories in the file's pathname.
default FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder	basic()
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	bufferSize(int bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	bufferSize(String bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	connectTimeout(int connectTimeout) Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	connectTimeout(String connectTimeout) Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	download(boolean download) Whether the FTP consumer should download the file.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	download(String download) Whether the FTP consumer should download the file.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	fastExistsCheck(boolean fastExistsCheck) If set this option to be true, camel-ftp will use the list file directly to check if the file exists.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	fastExistsCheck(String fastExistsCheck) If set this option to be true, camel-ftp will use the list file directly to check if the file exists.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClient(Object ftpClient) To use a custom instance of FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClient(String ftpClient) To use a custom instance of FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientConfig(Object ftpClientConfig) To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientConfig(String ftpClientConfig) To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientConfigParameters(Map values) Used by FtpComponent to provide additional parameters for the FTPClientConfig.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientConfigParameters(String key, Object value) Used by FtpComponent to provide additional parameters for the FTPClientConfig.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientParameters(Map values) Used by FtpComponent to provide additional parameters for the FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ftpClientParameters(String key, Object value) Used by FtpComponent to provide additional parameters for the FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	handleDirectoryParserAbsoluteResult(boolean handleDirectoryParserAbsoluteResult) Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	handleDirectoryParserAbsoluteResult(String handleDirectoryParserAbsoluteResult) Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ignoreFileNotFoundOrPermissionError(boolean ignoreFileNotFoundOrPermissionError) Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	ignoreFileNotFoundOrPermissionError(String ignoreFileNotFoundOrPermissionError) Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	inProgressRepository(org.apache.camel.spi.IdempotentRepository inProgressRepository) A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	inProgressRepository(String inProgressRepository) A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	localWorkDirectory(String localWorkDirectory) When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	maximumReconnectAttempts(int maximumReconnectAttempts) Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	maximumReconnectAttempts(String maximumReconnectAttempts) Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	onCompletionExceptionHandler(org.apache.camel.spi.ExceptionHandler onCompletionExceptionHandler) To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	onCompletionExceptionHandler(String onCompletionExceptionHandler) To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	pollStrategy(String pollStrategy) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	processStrategy(Object processStrategy) A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	processStrategy(String processStrategy) A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	reconnectDelay(long reconnectDelay) Delay in millis Camel will wait before performing a reconnect attempt.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	reconnectDelay(String reconnectDelay) Delay in millis Camel will wait before performing a reconnect attempt.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	siteCommand(String siteCommand) Sets optional site command(s) to be executed after successful login.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	soTimeout(int soTimeout) Sets the so timeout FTP and FTPS Only for Camel 2.4.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	soTimeout(String soTimeout) Sets the so timeout FTP and FTPS Only for Camel 2.4.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	stepwise(boolean stepwise) Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	stepwise(String stepwise) Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed) Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed) Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	timeout(int timeout) Sets the data timeout for waiting for reply Used only by FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	timeout(String timeout) Sets the data timeout for waiting for reply Used only by FTPClient.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	useList(boolean useList) Whether to allow using LIST command when downloading a file.
default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder	useList(String useList) Whether to allow using LIST command when downloading a file.

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

Method Detail

basic

default FtpsEndpointBuilderFactory.FtpsEndpointConsumerBuilder basic()

fastExistsCheck

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder fastExistsCheck(boolean fastExistsCheck)

If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. The option is a: <code>boolean</code> type. Default: false Group: common (advanced)

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

fastExistsCheck

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder fastExistsCheck(String fastExistsCheck)

If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. The option will be converted to a <code>boolean</code> type. Default: false Group: common (advanced)

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

download

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder download(boolean download)

Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

download - the value to set

Returns:

the dsl builder

download

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder download(String download)

Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

download - the value to set

Returns:

the dsl builder

exceptionHandler

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

handleDirectoryParserAbsoluteResult

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder handleDirectoryParserAbsoluteResult(boolean handleDirectoryParserAbsoluteResult)

Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

handleDirectoryParserAbsoluteResult - the value to set

Returns:

the dsl builder

handleDirectoryParserAbsoluteResult

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder handleDirectoryParserAbsoluteResult(String handleDirectoryParserAbsoluteResult)

Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

handleDirectoryParserAbsoluteResult - the value to set

Returns:

the dsl builder

ignoreFileNotFoundOrPermissionError

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ignoreFileNotFoundOrPermissionError(boolean ignoreFileNotFoundOrPermissionError)

Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

ignoreFileNotFoundOrPermissionError - the value to set

Returns:

the dsl builder

ignoreFileNotFoundOrPermissionError

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ignoreFileNotFoundOrPermissionError(String ignoreFileNotFoundOrPermissionError)

Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

ignoreFileNotFoundOrPermissionError - the value to set

Returns:

the dsl builder

inProgressRepository

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder inProgressRepository(org.apache.camel.spi.IdempotentRepository inProgressRepository)

A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option is a: <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: consumer (advanced)

Parameters:

inProgressRepository - the value to set

Returns:

the dsl builder

inProgressRepository

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder inProgressRepository(String inProgressRepository)

A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option will be converted to a <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: consumer (advanced)

Parameters:

inProgressRepository - the value to set

Returns:

the dsl builder

localWorkDirectory

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder localWorkDirectory(String localWorkDirectory)

When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)

Parameters:

localWorkDirectory - the value to set

Returns:

the dsl builder

onCompletionExceptionHandler

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder onCompletionExceptionHandler(org.apache.camel.spi.ExceptionHandler onCompletionExceptionHandler)

To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

onCompletionExceptionHandler - the value to set

Returns:

the dsl builder

onCompletionExceptionHandler

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder onCompletionExceptionHandler(String onCompletionExceptionHandler)

To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

onCompletionExceptionHandler - the value to set

Returns:

the dsl builder

pollStrategy

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)

Parameters:

pollStrategy - the value to set

Returns:

the dsl builder

pollStrategy

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder pollStrategy(String pollStrategy)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)

Parameters:

pollStrategy - the value to set

Returns:

the dsl builder

processStrategy

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder processStrategy(Object processStrategy)

A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option is a: <code>org.apache.camel.component.file.GenericFileProcessStrategy&lt;org.apache.commons.net.ftp.FTPFile&gt;</code> type. Group: consumer (advanced)

Parameters:

processStrategy - the value to set

Returns:

the dsl builder

processStrategy

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder processStrategy(String processStrategy)

A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option will be converted to a <code>org.apache.camel.component.file.GenericFileProcessStrategy&lt;org.apache.commons.net.ftp.FTPFile&gt;</code> type. Group: consumer (advanced)

Parameters:

processStrategy - the value to set

Returns:

the dsl builder

useList

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder useList(boolean useList)

Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

useList - the value to set

Returns:

the dsl builder

useList

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder useList(String useList)

Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)

Parameters:

useList - the value to set

Returns:

the dsl builder

activePortRange

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder activePortRange(String activePortRange)

Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, eg 10000-19999 to include all 1xxxx ports. The option is a: <code>java.lang.String</code> type. Group: advanced

Parameters:

activePortRange - the value to set

Returns:

the dsl builder

autoCreate

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder 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

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

autoCreate

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder 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

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

bufferSize

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder 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

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder 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

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

connectTimeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder connectTimeout(int connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option is a: <code>int</code> type. Default: 10000 Group: advanced

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

connectTimeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder connectTimeout(String connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option will be converted to a <code>int</code> type. Default: 10000 Group: advanced

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

ftpClient

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClient(Object ftpClient)

To use a custom instance of FTPClient. The option is a: <code>org.apache.commons.net.ftp.FTPClient</code> type. Group: advanced

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClient

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClient(String ftpClient)

To use a custom instance of FTPClient. The option will be converted to a <code>org.apache.commons.net.ftp.FTPClient</code> type. Group: advanced

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClientConfig

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientConfig(Object ftpClientConfig)

To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. The option is a: <code>org.apache.commons.net.ftp.FTPClientConfig</code> type. Group: advanced

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfig

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientConfig(String ftpClientConfig)

To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. The option will be converted to a <code>org.apache.commons.net.ftp.FTPClientConfig</code> type. Group: advanced

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfigParameters

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientConfigParameters(String key,
                                                                                                 Object value)

Used by FtpComponent to provide additional parameters for the FTPClientConfig. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientConfigParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientConfigParameters

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientConfigParameters(Map values)

Used by FtpComponent to provide additional parameters for the FTPClientConfig. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientConfigParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

values - the values

Returns:

the dsl builder

ftpClientParameters

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientParameters(String key,
                                                                                           Object value)

Used by FtpComponent to provide additional parameters for the FTPClient. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientParameters

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder ftpClientParameters(Map values)

Used by FtpComponent to provide additional parameters for the FTPClient. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the ftpClientParameters(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Parameters:

values - the values

Returns:

the dsl builder

maximumReconnectAttempts

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder maximumReconnectAttempts(int maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option is a: <code>int</code> type. Group: advanced

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

maximumReconnectAttempts

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder maximumReconnectAttempts(String maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option will be converted to a <code>int</code> type. Group: advanced

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

reconnectDelay

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder reconnectDelay(long reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt. The option is a: <code>long</code> type. Group: advanced

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder reconnectDelay(String reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt. The option will be converted to a <code>long</code> type. Group: advanced

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

siteCommand

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder siteCommand(String siteCommand)

Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character. The option is a: <code>java.lang.String</code> type. Group: advanced

Parameters:

siteCommand - the value to set

Returns:

the dsl builder

soTimeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder soTimeout(int soTimeout)

Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance. The option is a: <code>int</code> type. Default: 5m Group: advanced

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

soTimeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder soTimeout(String soTimeout)

Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance. The option will be converted to a <code>int</code> type. Default: 5m Group: advanced

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

stepwise

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder stepwise(boolean stepwise)

Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

stepwise - the value to set

Returns:

the dsl builder

stepwise

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder stepwise(String stepwise)

Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

stepwise - the value to set

Returns:

the dsl builder

synchronous

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder synchronous(boolean synchronous)

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

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder 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

Parameters:

synchronous - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)

Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed)

Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

timeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder timeout(int timeout)

Sets the data timeout for waiting for reply Used only by FTPClient. The option is a: <code>int</code> type. Default: 30s Group: advanced

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder timeout(String timeout)

Sets the data timeout for waiting for reply Used only by FTPClient. The option will be converted to a <code>int</code> type. Default: 30s Group: advanced

Parameters:

timeout - the value to set

Returns:

the dsl builder