org.apache.camel.builder.endpoint.dsl

Interface FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder, FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Enclosing interface:

FtpEndpointBuilderFactory

public static interface FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder
extends FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder, FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Advanced builder for endpoint for the FTP component.

Method Summary

Modifier and Type	Method and Description
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	activePortRange(String activePortRange) Set the client side port range in active mode.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	autoCreate(boolean autoCreate) Automatically create missing directories in the file's pathname.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	autoCreate(String autoCreate) Automatically create missing directories in the file's pathname.
default FtpEndpointBuilderFactory.FtpEndpointBuilder	basic()
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	bufferSize(int bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	bufferSize(String bufferSize) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files).
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	connectTimeout(int connectTimeout) Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	connectTimeout(String connectTimeout) Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	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 FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	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 FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClient(Object ftpClient) To use a custom instance of FTPClient.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClient(String ftpClient) To use a custom instance of FTPClient.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientConfig(Object ftpClientConfig) To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientConfig(String ftpClientConfig) To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientConfigParameters(Map values) Used by FtpComponent to provide additional parameters for the FTPClientConfig.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientConfigParameters(String key, Object value) Used by FtpComponent to provide additional parameters for the FTPClientConfig.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientParameters(Map values) Used by FtpComponent to provide additional parameters for the FTPClient.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	ftpClientParameters(String key, Object value) Used by FtpComponent to provide additional parameters for the FTPClient.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	maximumReconnectAttempts(int maximumReconnectAttempts) Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	maximumReconnectAttempts(String maximumReconnectAttempts) Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	reconnectDelay(long reconnectDelay) Delay in millis Camel will wait before performing a reconnect attempt.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	reconnectDelay(String reconnectDelay) Delay in millis Camel will wait before performing a reconnect attempt.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	siteCommand(String siteCommand) Sets optional site command(s) to be executed after successful login.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	soTimeout(int soTimeout) Sets the so timeout FTP and FTPS Only for Camel 2.4.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	soTimeout(String soTimeout) Sets the so timeout FTP and FTPS Only for Camel 2.4.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	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 FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	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 FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed) Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed) Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	timeout(int timeout) Sets the data timeout for waiting for reply Used only by FTPClient.
default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder	timeout(String timeout) Sets the data timeout for waiting for reply Used only by FTPClient.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

download, download, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, handleDirectoryParserAbsoluteResult, handleDirectoryParserAbsoluteResult, ignoreFileNotFoundOrPermissionError, ignoreFileNotFoundOrPermissionError, inProgressRepository, inProgressRepository, localWorkDirectory, onCompletionExceptionHandler, onCompletionExceptionHandler, pollStrategy, pollStrategy, processStrategy, processStrategy, useList, useList

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.FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

allowNullBody, allowNullBody, chmod, disconnectOnBatchComplete, disconnectOnBatchComplete, eagerDeleteTargetFile, eagerDeleteTargetFile, keepLastModified, keepLastModified, moveExistingFileStrategy, moveExistingFileStrategy, sendNoop, sendNoop

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 FtpEndpointBuilderFactory.FtpEndpointBuilder basic()

Specified by:

basic in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

basic in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

fastExistsCheck

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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)

Specified by:

fastExistsCheck in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

fastExistsCheck in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

fastExistsCheck

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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)

Specified by:

fastExistsCheck in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

fastExistsCheck in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

activePortRange

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

activePortRange in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

activePortRange in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

activePortRange - the value to set

Returns:

the dsl builder

autoCreate

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

autoCreate in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

autoCreate

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

autoCreate in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

bufferSize

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

bufferSize in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

bufferSize in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

connectTimeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

connectTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

connectTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

connectTimeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

connectTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

connectTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

ftpClient

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClient in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClient in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClient

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClient in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClient in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClientConfig

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientConfig in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientConfig in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfig

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientConfig in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientConfig in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfigParameters

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientConfigParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientConfigParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientConfigParameters

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientConfigParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientConfigParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

ftpClientParameters

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientParameters

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

ftpClientParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

ftpClientParameters in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

maximumReconnectAttempts

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

maximumReconnectAttempts in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

maximumReconnectAttempts in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

maximumReconnectAttempts

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

maximumReconnectAttempts in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

maximumReconnectAttempts in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

reconnectDelay

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder reconnectDelay(long reconnectDelay)

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

Specified by:

reconnectDelay in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

reconnectDelay in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

reconnectDelay in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

reconnectDelay in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

siteCommand

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

siteCommand in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

siteCommand in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

siteCommand - the value to set

Returns:

the dsl builder

soTimeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

soTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

soTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

soTimeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

soTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

soTimeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

stepwise

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

stepwise in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

stepwise in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

stepwise - the value to set

Returns:

the dsl builder

stepwise

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

stepwise in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

stepwise in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

stepwise - the value to set

Returns:

the dsl builder

synchronous

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

synchronous in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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 FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

synchronous in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

throwExceptionOnConnectFailed in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

throwExceptionOnConnectFailed in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

throwExceptionOnConnectFailed in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

throwExceptionOnConnectFailed in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

timeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

timeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

timeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder 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

Specified by:

timeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder

Specified by:

timeout in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder