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

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

browseLimit(int browseLimit)

Maximum number of messages to keep in memory available for browsing.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

browseLimit(String browseLimit)

Maximum number of messages to keep in memory available for browsing.

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(String ftpClient)

To use a custom instance of FTPClient.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

ftpClient(org.apache.commons.net.ftp.FTPClient ftpClient)

To use a custom instance of FTPClient.

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

ftpClientConfig(org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig)

To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

ftpClientConfigParameters(String key, Object value)

Used by FtpComponent to provide additional parameters for the FTPClientConfig.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

ftpClientConfigParameters(Map values)

Used by FtpComponent to provide additional parameters for the FTPClientConfig.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

ftpClientParameters(String key, Object value)

Used by FtpComponent to provide additional parameters for the FTPClient.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

ftpClientParameters(Map values)

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 Is the SocketOptions.SO_TIMEOUT value in millis.

default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

soTimeout(String soTimeout)

Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis.

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

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.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, download, download, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, handleDirectoryParserAbsoluteResult, handleDirectoryParserAbsoluteResult, ignoreFileNotFoundOrPermissionError, ignoreFileNotFoundOrPermissionError, inProgressRepository, inProgressRepository, localWorkDirectory, onCompletionExceptionHandler, onCompletionExceptionHandler, pollStrategy, pollStrategy, processStrategy, processStrategy, throwExceptionOnConnectFailed, throwExceptionOnConnectFailed, useList, useList

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder
allowNullBody, allowNullBody, chmod, disconnectOnBatchComplete, disconnectOnBatchComplete, eagerDeleteTargetFile, eagerDeleteTargetFile, keepLastModified, keepLastModified, lazyStartProducer, lazyStartProducer, moveExistingFileStrategy, moveExistingFileStrategy, sendNoop, sendNoop

Method Details
- 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: boolean 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 boolean 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, e.g., 10000-19999 to include all 1xxxx ports. The option is a: java.lang.String 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: boolean 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 boolean 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
- browseLimit
  
  default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder browseLimit(int browseLimit)
  
  Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option is a: int type. Default: 100 Group: advanced
  
  Specified by:
  
  browseLimit in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder
  
  Specified by:
  
  browseLimit in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder
  
  Parameters:
  
  browseLimit - the value to set
  
  Returns:
  
  the dsl builder
- browseLimit
  
  default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder browseLimit(String browseLimit)
  
  Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option will be converted to a int type. Default: 100 Group: advanced
  
  Specified by:
  
  browseLimit in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointConsumerBuilder
  
  Specified by:
  
  browseLimit in interface FtpEndpointBuilderFactory.AdvancedFtpEndpointProducerBuilder
  
  Parameters:
  
  browseLimit - 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: int 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 int 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: int 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 int 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(org.apache.commons.net.ftp.FTPClient ftpClient)
  
  To use a custom instance of FTPClient. The option is a: org.apache.commons.net.ftp.FTPClient 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 org.apache.commons.net.ftp.FTPClient 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(org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig)
  
  To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. The option is a: org.apache.commons.net.ftp.FTPClientConfig 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 org.apache.commons.net.ftp.FTPClientConfig 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: java.util.Map<java.lang.String, java.lang.Object> 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: java.util.Map<java.lang.String, java.lang.Object> 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: java.util.Map<java.lang.String, java.lang.Object> 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: java.util.Map<java.lang.String, java.lang.Object> 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: int 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 int 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: long type. Default: 1000 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 long type. Default: 1000 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: java.lang.String 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 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: int type. Default: 300000 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 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 int type. Default: 300000 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: boolean 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 boolean 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
- timeout
  
  default FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder timeout(int timeout)
  
  Sets the data timeout for waiting for reply Used only by FTPClient. The option is a: int type. Default: 30000 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 int type. Default: 30000 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

Interface FtpEndpointBuilderFactory.AdvancedFtpEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

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

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

Method Details

basic

fastExistsCheck

fastExistsCheck

activePortRange

autoCreate

autoCreate

browseLimit

browseLimit

bufferSize

bufferSize

connectTimeout

connectTimeout

ftpClient

ftpClient

ftpClientConfig

ftpClientConfig

ftpClientConfigParameters

ftpClientConfigParameters

ftpClientParameters

ftpClientParameters

maximumReconnectAttempts

maximumReconnectAttempts

reconnectDelay

reconnectDelay

siteCommand

soTimeout

soTimeout

stepwise

stepwise

timeout

timeout