Interface SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
,SftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Enclosing interface:
- SftpEndpointBuilderFactory
public static interface SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder extends SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder, SftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
Advanced builder for endpoint for the SFTP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
autoCreate(boolean autoCreate)
Automatically create missing directories in the file's pathname.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
autoCreate(String autoCreate)
Automatically create missing directories in the file's pathname.default SftpEndpointBuilderFactory.SftpEndpointBuilder
basic()
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
bindAddress(String bindAddress)
Specifies the address of the local interface against which the connection should bind.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
bulkRequests(Integer bulkRequests)
Specifies how many requests may be outstanding at any one time.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
bulkRequests(String bulkRequests)
Specifies how many requests may be outstanding at any one time.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
compression(int compression)
To use compression.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
compression(String compression)
To use compression.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
connectTimeout(int connectTimeout)
Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
connectTimeout(String connectTimeout)
Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
existDirCheckUsingLs(boolean existDirCheckUsingLs)
Whether to check for existing directory using LS command or CD.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
existDirCheckUsingLs(String existDirCheckUsingLs)
Whether to check for existing directory using LS command or CD.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
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 SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
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 SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
maximumReconnectAttempts(int maximumReconnectAttempts)
Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
maximumReconnectAttempts(String maximumReconnectAttempts)
Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
proxy(com.jcraft.jsch.Proxy proxy)
To use a custom configured com.jcraft.jsch.Proxy.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
proxy(String proxy)
To use a custom configured com.jcraft.jsch.Proxy.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
reconnectDelay(long reconnectDelay)
Delay in millis Camel will wait before performing a reconnect attempt.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
reconnectDelay(String reconnectDelay)
Delay in millis Camel will wait before performing a reconnect attempt.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
serverAliveCountMax(int serverAliveCountMax)
Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
serverAliveCountMax(String serverAliveCountMax)
Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
serverAliveInterval(int serverAliveInterval)
Sets the interval (millis) to send a keep-alive message.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
serverAliveInterval(String serverAliveInterval)
Sets the interval (millis) to send a keep-alive message.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
soTimeout(int soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
soTimeout(String soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
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 SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
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 SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)
Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed)
Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
timeout(int timeout)
Sets the data timeout for waiting for reply Used only by FTPClient.default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
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.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, download, download, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, ignoreFileNotFoundOrPermissionError, ignoreFileNotFoundOrPermissionError, inProgressRepository, inProgressRepository, localWorkDirectory, onCompletionExceptionHandler, onCompletionExceptionHandler, pollStrategy, pollStrategy, processStrategy, processStrategy, useList, useList
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
allowNullBody, allowNullBody, chmod, chmodDirectory, disconnectOnBatchComplete, disconnectOnBatchComplete, eagerDeleteTargetFile, eagerDeleteTargetFile, keepLastModified, keepLastModified, lazyStartProducer, lazyStartProducer, moveExistingFileStrategy, moveExistingFileStrategy, sendNoop, sendNoop
-
-
-
-
Method Detail
-
basic
default SftpEndpointBuilderFactory.SftpEndpointBuilder basic()
- Specified by:
basic
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
basic
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
-
fastExistsCheck
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
fastExistsCheck
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
fastExistsCheck
- the value to set- Returns:
- the dsl builder
-
fastExistsCheck
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
fastExistsCheck
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
fastExistsCheck
- the value to set- Returns:
- the dsl builder
-
autoCreate
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
autoCreate
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
autoCreate
- the value to set- Returns:
- the dsl builder
-
autoCreate
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
autoCreate
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
autoCreate
- the value to set- Returns:
- the dsl builder
-
bindAddress
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder bindAddress(String bindAddress)
Specifies the address of the local interface against which the connection should bind. The option is a: <code>java.lang.String</code> type. Group: advanced- Specified by:
bindAddress
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
bindAddress
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
bindAddress
- the value to set- Returns:
- the dsl builder
-
bulkRequests
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder bulkRequests(Integer bulkRequests)
Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage. The option is a: <code>java.lang.Integer</code> type. Group: advanced- Specified by:
bulkRequests
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
bulkRequests
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
bulkRequests
- the value to set- Returns:
- the dsl builder
-
bulkRequests
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder bulkRequests(String bulkRequests)
Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage. The option will be converted to a <code>java.lang.Integer</code> type. Group: advanced- Specified by:
bulkRequests
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
bulkRequests
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
bulkRequests
- the value to set- Returns:
- the dsl builder
-
compression
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder compression(int compression)
To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support. The option is a: <code>int</code> type. Group: advanced- Specified by:
compression
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
compression
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
compression
- the value to set- Returns:
- the dsl builder
-
compression
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder compression(String compression)
To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support. The option will be converted to a <code>int</code> type. Group: advanced- Specified by:
compression
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
compression
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
compression
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
connectTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
connectTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
existDirCheckUsingLs
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder existDirCheckUsingLs(boolean existDirCheckUsingLs)
Whether to check for existing directory using LS command or CD. By default LS is used which is safer as otherwise Camel needs to change the directory back after checking. However LS has been reported to cause a problem on windows system in some situations and therefore you can disable this option to use CD. The option is a: <code>boolean</code> type. Default: true Group: advanced- Specified by:
existDirCheckUsingLs
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
existDirCheckUsingLs
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
existDirCheckUsingLs
- the value to set- Returns:
- the dsl builder
-
existDirCheckUsingLs
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder existDirCheckUsingLs(String existDirCheckUsingLs)
Whether to check for existing directory using LS command or CD. By default LS is used which is safer as otherwise Camel needs to change the directory back after checking. However LS has been reported to cause a problem on windows system in some situations and therefore you can disable this option to use CD. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced- Specified by:
existDirCheckUsingLs
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
existDirCheckUsingLs
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
existDirCheckUsingLs
- the value to set- Returns:
- the dsl builder
-
maximumReconnectAttempts
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
maximumReconnectAttempts
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
maximumReconnectAttempts
- the value to set- Returns:
- the dsl builder
-
maximumReconnectAttempts
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
maximumReconnectAttempts
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
maximumReconnectAttempts
- the value to set- Returns:
- the dsl builder
-
proxy
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder proxy(com.jcraft.jsch.Proxy proxy)
To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host. The option is a: <code>com.jcraft.jsch.Proxy</code> type. Group: advanced- Specified by:
proxy
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
proxy
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
proxy
- the value to set- Returns:
- the dsl builder
-
proxy
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder proxy(String proxy)
To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host. The option will be converted to a <code>com.jcraft.jsch.Proxy</code> type. Group: advanced- Specified by:
proxy
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
proxy
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
proxy
- the value to set- Returns:
- the dsl builder
-
reconnectDelay
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder reconnectDelay(long reconnectDelay)
Delay in millis Camel will wait before performing a reconnect attempt. The option is a: <code>long</code> type. Default: 1000 Group: advanced- Specified by:
reconnectDelay
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
reconnectDelay
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
reconnectDelay
- the value to set- Returns:
- the dsl builder
-
reconnectDelay
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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. Default: 1000 Group: advanced- Specified by:
reconnectDelay
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
reconnectDelay
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
reconnectDelay
- the value to set- Returns:
- the dsl builder
-
serverAliveCountMax
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder serverAliveCountMax(int serverAliveCountMax)
Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one. The option is a: <code>int</code> type. Default: 1 Group: advanced- Specified by:
serverAliveCountMax
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
serverAliveCountMax
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
serverAliveCountMax
- the value to set- Returns:
- the dsl builder
-
serverAliveCountMax
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder serverAliveCountMax(String serverAliveCountMax)
Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one. The option will be converted to a <code>int</code> type. Default: 1 Group: advanced- Specified by:
serverAliveCountMax
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
serverAliveCountMax
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
serverAliveCountMax
- the value to set- Returns:
- the dsl builder
-
serverAliveInterval
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder serverAliveInterval(int serverAliveInterval)
Sets the interval (millis) to send a keep-alive message. If zero is specified, any keep-alive message must not be sent. The default interval is zero. The option is a: <code>int</code> type. Group: advanced- Specified by:
serverAliveInterval
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
serverAliveInterval
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
serverAliveInterval
- the value to set- Returns:
- the dsl builder
-
serverAliveInterval
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder serverAliveInterval(String serverAliveInterval)
Sets the interval (millis) to send a keep-alive message. If zero is specified, any keep-alive message must not be sent. The default interval is zero. The option will be converted to a <code>int</code> type. Group: advanced- Specified by:
serverAliveInterval
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
serverAliveInterval
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
serverAliveInterval
- the value to set- Returns:
- the dsl builder
-
soTimeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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: <code>int</code> type. Default: 300000 Group: advanced- Specified by:
soTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
soTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
soTimeout
- the value to set- Returns:
- the dsl builder
-
soTimeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 <code>int</code> type. Default: 300000 Group: advanced- Specified by:
soTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
soTimeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
soTimeout
- the value to set- Returns:
- the dsl builder
-
stepwise
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
stepwise
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
stepwise
- the value to set- Returns:
- the dsl builder
-
stepwise
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
stepwise
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
stepwise
- the value to set- Returns:
- the dsl builder
-
throwExceptionOnConnectFailed
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
throwExceptionOnConnectFailed
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
throwExceptionOnConnectFailed
- the value to set- Returns:
- the dsl builder
-
throwExceptionOnConnectFailed
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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 interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
throwExceptionOnConnectFailed
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
throwExceptionOnConnectFailed
- the value to set- Returns:
- the dsl builder
-
timeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder timeout(int timeout)
Sets the data timeout for waiting for reply Used only by FTPClient. The option is a: <code>int</code> type. Default: 30000 Group: advanced- Specified by:
timeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
timeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder 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: 30000 Group: advanced- Specified by:
timeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder
- Specified by:
timeout
in interfaceSftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
-