org.apache.camel.builder.endpoint.dsl

Interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder, FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Enclosing interface:

FtpsEndpointBuilderFactory

public static interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointBuilder
extends FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder, FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Advanced builder for endpoint for the FTPS component.

Method Summary

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

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.FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

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 FtpsEndpointBuilderFactory.FtpsEndpointBuilder basic()

Specified by:

basic in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointConsumerBuilder

Specified by:

basic in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

fastExistsCheck

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

Specified by:

fastExistsCheck in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

fastExistsCheck

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

Specified by:

fastExistsCheck in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

fastExistsCheck - the value to set

Returns:

the dsl builder

activePortRange

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

Specified by:

activePortRange in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

activePortRange - the value to set

Returns:

the dsl builder

autoCreate

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

Specified by:

autoCreate in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

autoCreate

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

Specified by:

autoCreate in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

bufferSize

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

Specified by:

bufferSize in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

bufferSize

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

Specified by:

bufferSize in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

bufferSize - the value to set

Returns:

the dsl builder

connectTimeout

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

Specified by:

connectTimeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

connectTimeout

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

Specified by:

connectTimeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

ftpClient

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

Specified by:

ftpClient in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClient

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

Specified by:

ftpClient in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

ftpClient - the value to set

Returns:

the dsl builder

ftpClientConfig

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

Specified by:

ftpClientConfig in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfig

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

Specified by:

ftpClientConfig in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

ftpClientConfig - the value to set

Returns:

the dsl builder

ftpClientConfigParameters

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

Specified by:

ftpClientConfigParameters in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientConfigParameters

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

Specified by:

ftpClientConfigParameters in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

ftpClientParameters

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

Specified by:

ftpClientParameters in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

ftpClientParameters

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

Specified by:

ftpClientParameters in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

maximumReconnectAttempts

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

Specified by:

maximumReconnectAttempts in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

maximumReconnectAttempts

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

Specified by:

maximumReconnectAttempts in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

reconnectDelay

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

Specified by:

reconnectDelay in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

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

Specified by:

reconnectDelay in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

siteCommand

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

Specified by:

siteCommand in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

siteCommand - the value to set

Returns:

the dsl builder

soTimeout

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

Specified by:

soTimeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

soTimeout

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

Specified by:

soTimeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

soTimeout - the value to set

Returns:

the dsl builder

stepwise

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

Specified by:

stepwise in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

stepwise - the value to set

Returns:

the dsl builder

stepwise

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

Specified by:

stepwise in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

stepwise - the value to set

Returns:

the dsl builder

synchronous

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

Specified by:

synchronous in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

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

Specified by:

synchronous in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

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

Specified by:

throwExceptionOnConnectFailed in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

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

Specified by:

throwExceptionOnConnectFailed in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

timeout

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

Specified by:

timeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

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

Specified by:

timeout in interface FtpsEndpointBuilderFactory.AdvancedFtpsEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder