All Superinterfaces:: org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder, MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder

Enclosing interface:: MinaSftpEndpointBuilderFactory

public static interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder extends MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder, MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder

Advanced builder for endpoint for the MINA SFTP component.

Method Summary

Modifier and Type

Method

Description

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

autoCreate(boolean autoCreate)

Automatically create missing directories in the file's pathname.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

autoCreate(String autoCreate)

Automatically create missing directories in the file's pathname.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

basic()

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

bindAddress(String bindAddress)

Specifies the address of the local interface against which the connection should bind.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

browseLimit(int browseLimit)

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

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

browseLimit(String browseLimit)

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

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

bulkRequests(Integer bulkRequests)

Specifies how many requests may be outstanding at any one time.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

bulkRequests(String bulkRequests)

Specifies how many requests may be outstanding at any one time.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

compression(int compression)

To use compression.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

compression(String compression)

To use compression.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

connectTimeout(int connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

connectTimeout(String connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

existDirCheckUsingLs(Boolean existDirCheckUsingLs)

Deprecated.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

existDirCheckUsingLs(String existDirCheckUsingLs)

Deprecated.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

filenameEncoding(String filenameEncoding)

Encoding to use for FTP client when parsing filenames.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

jschLoggingLevel(String jschLoggingLevel)

Deprecated.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

maximumReconnectAttempts(int maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

maximumReconnectAttempts(String maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

readBufferSize(Integer readBufferSize)

Sets the buffer size in bytes used for reading data from SFTP connections.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

readBufferSize(String readBufferSize)

Sets the buffer size in bytes used for reading data from SFTP connections.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

reconnectDelay(long reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

reconnectDelay(String reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

serverAliveCountMax(int serverAliveCountMax)

Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

serverAliveCountMax(String serverAliveCountMax)

Sets the number of keep-alive messages which may be sent without receiving any messages back from the server.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

serverAliveInterval(int serverAliveInterval)

Sets the interval (millis) to send a keep-alive message.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

serverAliveInterval(String serverAliveInterval)

Sets the interval (millis) to send a keep-alive message.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

serverMessageLoggingLevel(String serverMessageLoggingLevel)

Deprecated.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

soTimeout(int soTimeout)

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

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

soTimeout(String soTimeout)

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

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

timeout(int timeout)

Sets the data timeout for waiting for reply Used only by FTPClient.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

timeout(String timeout)

Sets the data timeout for waiting for reply Used only by FTPClient.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

writeBufferSize(Integer writeBufferSize)

Sets the buffer size in bytes used for writing data to SFTP connections.

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

writeBufferSize(String writeBufferSize)

Sets the buffer size in bytes used for writing data to SFTP connections.

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

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

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

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, download, download, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, 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.MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
allowNullBody, allowNullBody, chmod, chmodDirectory, disconnectOnBatchComplete, disconnectOnBatchComplete, eagerDeleteTargetFile, eagerDeleteTargetFile, keepLastModified, keepLastModified, lazyStartProducer, lazyStartProducer, moveExistingFileStrategy, moveExistingFileStrategy, sendNoop, sendNoop

Method Details
- basic
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder basic()
  
  Specified by:
  
  basic in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  basic in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
- fastExistsCheck
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  fastExistsCheck in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  fastExistsCheck - the value to set
  
  Returns:
  
  the dsl builder
- fastExistsCheck
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  fastExistsCheck in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  fastExistsCheck - the value to set
  
  Returns:
  
  the dsl builder
- autoCreate
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  autoCreate in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  autoCreate - the value to set
  
  Returns:
  
  the dsl builder
- autoCreate
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  autoCreate in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  autoCreate - the value to set
  
  Returns:
  
  the dsl builder
- bindAddress
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  bindAddress in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  bindAddress in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  bindAddress - the value to set
  
  Returns:
  
  the dsl builder
- browseLimit
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  browseLimit in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  browseLimit - the value to set
  
  Returns:
  
  the dsl builder
- browseLimit
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  browseLimit in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  browseLimit - the value to set
  
  Returns:
  
  the dsl builder
- bulkRequests
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  bulkRequests in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  bulkRequests in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  bulkRequests - the value to set
  
  Returns:
  
  the dsl builder
- bulkRequests
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  bulkRequests in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  bulkRequests in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  bulkRequests - the value to set
  
  Returns:
  
  the dsl builder
- compression
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder compression(int compression)
  
  To use compression. Specify a level from 1 to 10. The option is a: int type. Group: advanced
  
  Specified by:
  
  compression in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  compression in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  compression - the value to set
  
  Returns:
  
  the dsl builder
- compression
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder compression(String compression)
  
  To use compression. Specify a level from 1 to 10. The option will be converted to a int type. Group: advanced
  
  Specified by:
  
  compression in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  compression in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  compression - the value to set
  
  Returns:
  
  the dsl builder
- connectTimeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  connectTimeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  connectTimeout - the value to set
  
  Returns:
  
  the dsl builder
- connectTimeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  connectTimeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  connectTimeout - the value to set
  
  Returns:
  
  the dsl builder
- existDirCheckUsingLs
  
  @Deprecated default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder existDirCheckUsingLs(Boolean existDirCheckUsingLs)
  
  Deprecated.
  
  Deprecated: JSch-specific parameter, ignored by mina-sftp. MINA SSHD uses stat() for directory existence checks. The option is a: java.lang.Boolean type. Default: false Group: advanced
  
  Specified by:
  
  existDirCheckUsingLs in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  existDirCheckUsingLs in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  existDirCheckUsingLs - the value to set
  
  Returns:
  
  the dsl builder
- existDirCheckUsingLs
  
  @Deprecated default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder existDirCheckUsingLs(String existDirCheckUsingLs)
  
  Deprecated.
  
  Deprecated: JSch-specific parameter, ignored by mina-sftp. MINA SSHD uses stat() for directory existence checks. The option will be converted to a java.lang.Boolean type. Default: false Group: advanced
  
  Specified by:
  
  existDirCheckUsingLs in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  existDirCheckUsingLs in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  existDirCheckUsingLs - the value to set
  
  Returns:
  
  the dsl builder
- filenameEncoding
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  filenameEncoding in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  filenameEncoding in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  filenameEncoding - the value to set
  
  Returns:
  
  the dsl builder
- jschLoggingLevel
  
  @Deprecated default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder jschLoggingLevel(String jschLoggingLevel)
  
  Deprecated.
  
  Deprecated: JSch-specific parameter, ignored by mina-sftp. Configure logging via your logging framework instead. The option is a: java.lang.String type. Group: advanced
  
  Specified by:
  
  jschLoggingLevel in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  jschLoggingLevel in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  jschLoggingLevel - the value to set
  
  Returns:
  
  the dsl builder
- maximumReconnectAttempts
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  maximumReconnectAttempts in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  maximumReconnectAttempts - the value to set
  
  Returns:
  
  the dsl builder
- maximumReconnectAttempts
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  maximumReconnectAttempts in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  maximumReconnectAttempts - the value to set
  
  Returns:
  
  the dsl builder
- readBufferSize
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder readBufferSize(Integer readBufferSize)
  
  Sets the buffer size in bytes used for reading data from SFTP connections. If not specified, the MINA SSHD default buffer size is used. Larger values may improve transfer speed for large files but will increase memory usage. Maximum recommended value is 126976 bytes (124KB) to avoid data corruption issues. This parameter maps directly to Apache MINA SSHD's READ_BUFFER_SIZE property. The option is a: java.lang.Integer type. Group: advanced
  
  Specified by:
  
  readBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  readBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  readBufferSize - the value to set
  
  Returns:
  
  the dsl builder
- readBufferSize
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder readBufferSize(String readBufferSize)
  
  Sets the buffer size in bytes used for reading data from SFTP connections. If not specified, the MINA SSHD default buffer size is used. Larger values may improve transfer speed for large files but will increase memory usage. Maximum recommended value is 126976 bytes (124KB) to avoid data corruption issues. This parameter maps directly to Apache MINA SSHD's READ_BUFFER_SIZE property. The option will be converted to a java.lang.Integer type. Group: advanced
  
  Specified by:
  
  readBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  readBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  readBufferSize - the value to set
  
  Returns:
  
  the dsl builder
- reconnectDelay
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  reconnectDelay in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  reconnectDelay - the value to set
  
  Returns:
  
  the dsl builder
- reconnectDelay
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  reconnectDelay in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  reconnectDelay - the value to set
  
  Returns:
  
  the dsl builder
- serverAliveCountMax
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  serverAliveCountMax in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverAliveCountMax in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverAliveCountMax - the value to set
  
  Returns:
  
  the dsl builder
- serverAliveCountMax
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  serverAliveCountMax in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverAliveCountMax in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverAliveCountMax - the value to set
  
  Returns:
  
  the dsl builder
- serverAliveInterval
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  serverAliveInterval in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverAliveInterval in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverAliveInterval - the value to set
  
  Returns:
  
  the dsl builder
- serverAliveInterval
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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
  
  Specified by:
  
  serverAliveInterval in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverAliveInterval in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverAliveInterval - the value to set
  
  Returns:
  
  the dsl builder
- serverMessageLoggingLevel
  
  @Deprecated default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder serverMessageLoggingLevel(String serverMessageLoggingLevel)
  
  Deprecated.
  
  Deprecated: JSch-specific parameter, ignored by mina-sftp. Configure logging via your logging framework instead. The option is a: java.lang.String type. Group: advanced
  
  Specified by:
  
  serverMessageLoggingLevel in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverMessageLoggingLevel in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverMessageLoggingLevel - the value to set
  
  Returns:
  
  the dsl builder
- soTimeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  soTimeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  soTimeout - the value to set
  
  Returns:
  
  the dsl builder
- soTimeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  soTimeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  soTimeout - the value to set
  
  Returns:
  
  the dsl builder
- stepwise
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  stepwise in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  stepwise - the value to set
  
  Returns:
  
  the dsl builder
- stepwise
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  stepwise in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  stepwise - the value to set
  
  Returns:
  
  the dsl builder
- timeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  timeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  timeout - the value to set
  
  Returns:
  
  the dsl builder
- timeout
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder 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 MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  timeout in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  timeout - the value to set
  
  Returns:
  
  the dsl builder
- writeBufferSize
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder writeBufferSize(Integer writeBufferSize)
  
  Sets the buffer size in bytes used for writing data to SFTP connections. If not specified, the MINA SSHD default buffer size is used. Larger values may improve transfer speed for large files but will increase memory usage. Maximum recommended value is 126976 bytes (124KB) to avoid data corruption issues. This parameter maps directly to Apache MINA SSHD's WRITE_BUFFER_SIZE property. The option is a: java.lang.Integer type. Group: advanced
  
  Specified by:
  
  writeBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  writeBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  writeBufferSize - the value to set
  
  Returns:
  
  the dsl builder
- writeBufferSize
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder writeBufferSize(String writeBufferSize)
  
  Sets the buffer size in bytes used for writing data to SFTP connections. If not specified, the MINA SSHD default buffer size is used. Larger values may improve transfer speed for large files but will increase memory usage. Maximum recommended value is 126976 bytes (124KB) to avoid data corruption issues. This parameter maps directly to Apache MINA SSHD's WRITE_BUFFER_SIZE property. The option will be converted to a java.lang.Integer type. Group: advanced
  
  Specified by:
  
  writeBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  writeBufferSize in interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder
  
  Parameters:
  
  writeBufferSize - the value to set
  
  Returns:
  
  the dsl builder

Interface MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

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.MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointConsumerBuilder

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointProducerBuilder

Method Details

basic

fastExistsCheck

fastExistsCheck

autoCreate

autoCreate

bindAddress

browseLimit

browseLimit

bulkRequests

bulkRequests

compression

compression

connectTimeout

connectTimeout

existDirCheckUsingLs

existDirCheckUsingLs

filenameEncoding

jschLoggingLevel

maximumReconnectAttempts

maximumReconnectAttempts

readBufferSize

readBufferSize

reconnectDelay

reconnectDelay

serverAliveCountMax

serverAliveCountMax

serverAliveInterval

serverAliveInterval

serverMessageLoggingLevel

soTimeout

soTimeout

stepwise

stepwise

timeout

timeout

writeBufferSize

writeBufferSize