Package org.apache.camel.builder.endpoint.dsl

Interface SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
Enclosing interface:
SftpEndpointBuilderFactory
public static interface SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the SFTP component.

  • Method Details

    • basic

      default SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder basic()

    • fastExistsCheck

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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)
      Parameters:
      fastExistsCheck - the value to set
      Returns:
      the dsl builder

    • fastExistsCheck

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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)
      Parameters:
      fastExistsCheck - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • download

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

    • download

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder download(String download)
      Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      download - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • ignoreFileNotFoundOrPermissionError

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder ignoreFileNotFoundOrPermissionError(boolean ignoreFileNotFoundOrPermissionError)
      Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      ignoreFileNotFoundOrPermissionError - the value to set
      Returns:
      the dsl builder

    • ignoreFileNotFoundOrPermissionError

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder ignoreFileNotFoundOrPermissionError(String ignoreFileNotFoundOrPermissionError)
      Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exist or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      ignoreFileNotFoundOrPermissionError - the value to set
      Returns:
      the dsl builder

    • inProgressRepository

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder inProgressRepository(org.apache.camel.spi.IdempotentRepository inProgressRepository)
      A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option is a: org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • inProgressRepository

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder inProgressRepository(String inProgressRepository)
      A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option will be converted to a org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • localWorkDirectory

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder localWorkDirectory(String localWorkDirectory)
      When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. The option is a: java.lang.String type. Group: consumer (advanced)
      Parameters:
      localWorkDirectory - the value to set
      Returns:
      the dsl builder

    • onCompletionExceptionHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder onCompletionExceptionHandler(org.apache.camel.spi.ExceptionHandler onCompletionExceptionHandler)
      To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      onCompletionExceptionHandler - the value to set
      Returns:
      the dsl builder

    • onCompletionExceptionHandler

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder onCompletionExceptionHandler(String onCompletionExceptionHandler)
      To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      onCompletionExceptionHandler - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder pollStrategy(String pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • processStrategy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder processStrategy(org.apache.camel.component.file.GenericFileProcessStrategy<org.apache.camel.component.file.remote.SftpRemoteFile> processStrategy)
      A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option is a: org.apache.camel.component.file.GenericFileProcessStrategy<org.apache.camel.component.file.remote.SftpRemoteFile> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • processStrategy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder processStrategy(String processStrategy)
      A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option will be converted to a org.apache.camel.component.file.GenericFileProcessStrategy<org.apache.camel.component.file.remote.SftpRemoteFile> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnConnectFailed

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      throwExceptionOnConnectFailed - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnConnectFailed

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer (advanced)
      Parameters:
      throwExceptionOnConnectFailed - the value to set
      Returns:
      the dsl builder

    • useList

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

    • useList

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

    • autoCreate

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      autoCreate - the value to set
      Returns:
      the dsl builder

    • autoCreate

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      autoCreate - the value to set
      Returns:
      the dsl builder

    • bindAddress

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder bindAddress(String bindAddress)
      Specifies the address of the local interface against which the connection should bind. The option is a: java.lang.String type. Group: advanced
      Parameters:
      bindAddress - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • bulkRequests

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: java.lang.Integer type. Group: advanced
      Parameters:
      bulkRequests - the value to set
      Returns:
      the dsl builder

    • bulkRequests

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 java.lang.Integer type. Group: advanced
      Parameters:
      bulkRequests - the value to set
      Returns:
      the dsl builder

    • compression

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: int type. Group: advanced
      Parameters:
      compression - the value to set
      Returns:
      the dsl builder

    • compression

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 int type. Group: advanced
      Parameters:
      compression - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • existDirCheckUsingLs

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: boolean type. Default: true Group: advanced
      Parameters:
      existDirCheckUsingLs - the value to set
      Returns:
      the dsl builder

    • existDirCheckUsingLs

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 boolean type. Default: true Group: advanced
      Parameters:
      existDirCheckUsingLs - the value to set
      Returns:
      the dsl builder

    • filenameEncoding

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder filenameEncoding(String filenameEncoding)
      Encoding to use for FTP client when parsing filenames. By default, UTF-8 is used. The option is a: java.lang.String type. Group: advanced
      Parameters:
      filenameEncoding - the value to set
      Returns:
      the dsl builder

    • maximumReconnectAttempts

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      maximumReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • maximumReconnectAttempts

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      maximumReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • proxy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: com.jcraft.jsch.Proxy type. Group: advanced
      Parameters:
      proxy - the value to set
      Returns:
      the dsl builder

    • proxy

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 com.jcraft.jsch.Proxy type. Group: advanced
      Parameters:
      proxy - the value to set
      Returns:
      the dsl builder

    • reconnectDelay

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder reconnectDelay(long reconnectDelay)
      Delay in millis Camel will wait before performing a reconnect attempt. The option is a: long type. Default: 1000 Group: advanced
      Parameters:
      reconnectDelay - the value to set
      Returns:
      the dsl builder

    • reconnectDelay

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      reconnectDelay - the value to set
      Returns:
      the dsl builder

    • serverAliveCountMax

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: int type. Default: 1 Group: advanced
      Parameters:
      serverAliveCountMax - the value to set
      Returns:
      the dsl builder

    • serverAliveCountMax

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 int type. Default: 1 Group: advanced
      Parameters:
      serverAliveCountMax - the value to set
      Returns:
      the dsl builder

    • serverAliveInterval

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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: int type. Group: advanced
      Parameters:
      serverAliveInterval - the value to set
      Returns:
      the dsl builder

    • serverAliveInterval

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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 int type. Group: advanced
      Parameters:
      serverAliveInterval - the value to set
      Returns:
      the dsl builder

    • serverMessageLoggingLevel

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder serverMessageLoggingLevel(org.apache.camel.LoggingLevel serverMessageLoggingLevel)
      The logging level used for various human intended log messages from the FTP server. This can be used during troubleshooting to raise the logging level and inspect the logs received from the FTP server. The option is a: org.apache.camel.LoggingLevel type. Default: DEBUG Group: advanced
      Parameters:
      serverMessageLoggingLevel - the value to set
      Returns:
      the dsl builder

    • serverMessageLoggingLevel

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder serverMessageLoggingLevel(String serverMessageLoggingLevel)
      The logging level used for various human intended log messages from the FTP server. This can be used during troubleshooting to raise the logging level and inspect the logs received from the FTP server. The option will be converted to a org.apache.camel.LoggingLevel type. Default: DEBUG Group: advanced
      Parameters:
      serverMessageLoggingLevel - the value to set
      Returns:
      the dsl builder

    • soTimeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      soTimeout - the value to set
      Returns:
      the dsl builder

    • soTimeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      soTimeout - the value to set
      Returns:
      the dsl builder

    • stepwise

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      stepwise - the value to set
      Returns:
      the dsl builder

    • stepwise

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      stepwise - the value to set
      Returns:
      the dsl builder

    • timeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • timeout

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointConsumerBuilder 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
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder