All Superinterfaces:: org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder, MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder

Enclosing interface:: MinaSftpEndpointBuilderFactory

public static interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder extends MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder, MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder

Builder for endpoint for the MINA SFTP component.

Method Summary

Modifier and Type

Method

Description

default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder

advanced()

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

autoCreateKnownHostsFile(boolean autoCreateKnownHostsFile)

If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission).

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

autoCreateKnownHostsFile(String autoCreateKnownHostsFile)

If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission).

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

binary(boolean binary)

Specifies the file transfer mode, BINARY or ASCII.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

binary(String binary)

Specifies the file transfer mode, BINARY or ASCII.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

certBytes(byte[] certBytes)

Set the OpenSSH certificate as byte array.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

certBytes(String certBytes)

Set the OpenSSH certificate as byte array.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

certFile(String certFile)

Set the OpenSSH certificate file path for certificate-based authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

certUri(String certUri)

Set the OpenSSH certificate as a classpath: or file: URI.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

charset(String charset)

This option is used to specify the encoding of the file.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

ciphers(String ciphers)

Set the list of ciphers that will be used in order of preference.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

disconnect(boolean disconnect)

Whether or not to disconnect from remote FTP server right after use.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

disconnect(String disconnect)

Whether or not to disconnect from remote FTP server right after use.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

doneFileName(String doneFileName)

Producer: If provided, then Camel will write a 2nd done file when the original file has been written.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

fileName(String fileName)

Use Expression such as File Language to dynamically set the filename.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

keyExchangeProtocols(String keyExchangeProtocols)

Set the list of key exchange protocols that will be used in order of preference.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

keyPair(String keyPair)

Set a java.security.KeyPair directly for public key authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

keyPair(KeyPair keyPair)

Set a java.security.KeyPair directly for public key authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

knownHosts(byte[] knownHosts)

Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

knownHosts(String knownHosts)

Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

knownHostsFile(String knownHostsFile)

Sets the known_hosts file, so that the SFTP endpoint can do host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

knownHostsUri(String knownHostsUri)

Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

passiveMode(boolean passiveMode)

Sets passive mode connections.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

passiveMode(String passiveMode)

Sets passive mode connections.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

password(String password)

Password to use for login.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

preferredAuthentications(String preferredAuthentications)

Set the preferred authentications which SFTP endpoint will used.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

privateKey(byte[] privateKey)

Set the private key as byte array for public key authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

privateKey(String privateKey)

Set the private key as byte array for public key authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

privateKeyFile(String privateKeyFile)

Set the private key file path so that the SFTP endpoint can do public key authentication.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

privateKeyPassphrase(String privateKeyPassphrase)

Set the passphrase for decrypting an encrypted private key.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

privateKeyUri(String privateKeyUri)

Set the private key as a classpath: or file: URI (e.g., classpath:keys/id_rsa).

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms)

Set a comma separated list of public key accepted algorithms.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

separator(String separator)

Sets the path separator to be used.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)

Sets the path separator to be used.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

serverHostKeys(String serverHostKeys)

Set the list of algorithms supported for the server host key.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

serverKeyVerifier(String serverKeyVerifier)

Custom ServerKeyVerifier for host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

serverKeyVerifier(org.apache.sshd.client.keyverifier.ServerKeyVerifier serverKeyVerifier)

Custom ServerKeyVerifier for host key verification.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

strictHostKeyChecking(String strictHostKeyChecking)

Sets whether to use strict host key checking.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

username(String username)

Username to use for login.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

useUserKnownHostsFile(boolean useUserKnownHostsFile)

If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.

default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

useUserKnownHostsFile(String useUserKnownHostsFile)

If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.

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.MinaSftpEndpointConsumerBuilder
antExclude, antFilterCaseSensitive, antFilterCaseSensitive, antInclude, backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, delete, delete, eagerMaxMessagesPerPoll, eagerMaxMessagesPerPoll, exclude, excludeExt, exclusiveReadLockStrategy, exclusiveReadLockStrategy, filter, filter, filterDirectory, filterFile, greedy, greedy, idempotent, idempotent, idempotentEager, idempotentEager, idempotentKey, idempotentRepository, idempotentRepository, include, includeExt, initialDelay, initialDelay, maxDepth, maxDepth, maxMessagesPerPoll, maxMessagesPerPoll, minDepth, minDepth, move, moveFailed, noop, noop, preMove, preSort, preSort, readLock, readLockCheckInterval, readLockCheckInterval, readLockDeleteOrphanLockFiles, readLockDeleteOrphanLockFiles, readLockIdempotentReleaseAsync, readLockIdempotentReleaseAsync, readLockIdempotentReleaseAsyncPoolSize, readLockIdempotentReleaseAsyncPoolSize, readLockIdempotentReleaseDelay, readLockIdempotentReleaseDelay, readLockIdempotentReleaseExecutorService, readLockIdempotentReleaseExecutorService, readLockLoggingLevel, readLockLoggingLevel, readLockMarkerFile, readLockMarkerFile, readLockMinAge, readLockMinAge, readLockMinLength, readLockMinLength, readLockRemoveOnCommit, readLockRemoveOnCommit, readLockRemoveOnRollback, readLockRemoveOnRollback, readLockTimeout, readLockTimeout, recursive, recursive, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, shuffle, shuffle, sortBy, sorter, sorter, startScheduler, startScheduler, streamDownload, streamDownload, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
checksumFileAlgorithm, checksumWriteFile, checksumWriteFile, fileExist, fileExist, flatten, flatten, jailStartingDirectory, jailStartingDirectory, moveExisting, tempFileName, tempPrefix

Method Details
- advanced
  
  default MinaSftpEndpointBuilderFactory.AdvancedMinaSftpEndpointBuilder advanced()
  
  Specified by:
  
  advanced in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  advanced in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
- binary
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder binary(boolean binary)
  
  Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option is a: boolean type. Default: false Group: common
  
  Specified by:
  
  binary in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  binary in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  binary - the value to set
  
  Returns:
  
  the dsl builder
- binary
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder binary(String binary)
  
  Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option will be converted to a boolean type. Default: false Group: common
  
  Specified by:
  
  binary in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  binary in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  binary - the value to set
  
  Returns:
  
  the dsl builder
- charset
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder charset(String charset)
  
  This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. The option is a: java.lang.String type. Group: common
  
  Specified by:
  
  charset in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  charset in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  charset - the value to set
  
  Returns:
  
  the dsl builder
- disconnect
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder disconnect(boolean disconnect)
  
  Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option is a: boolean type. Default: false Group: common
  
  Specified by:
  
  disconnect in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  disconnect in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  disconnect - the value to set
  
  Returns:
  
  the dsl builder
- disconnect
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder disconnect(String disconnect)
  
  Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option will be converted to a boolean type. Default: false Group: common
  
  Specified by:
  
  disconnect in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  disconnect in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  disconnect - the value to set
  
  Returns:
  
  the dsl builder
- doneFileName
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder doneFileName(String doneFileName)
  
  Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. The option is a: java.lang.String type. Group: common
  
  Specified by:
  
  doneFileName in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  doneFileName in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  doneFileName - the value to set
  
  Returns:
  
  the dsl builder
- fileName
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder fileName(String fileName)
  
  Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option is a: java.lang.String type. Group: common
  
  Specified by:
  
  fileName in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  fileName in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  fileName - the value to set
  
  Returns:
  
  the dsl builder
- passiveMode
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder passiveMode(boolean passiveMode)
  
  Sets passive mode connections. Default is active mode connections. The option is a: boolean type. Default: false Group: common
  
  Specified by:
  
  passiveMode in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  passiveMode in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  passiveMode - the value to set
  
  Returns:
  
  the dsl builder
- passiveMode
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder passiveMode(String passiveMode)
  
  Sets passive mode connections. Default is active mode connections. The option will be converted to a boolean type. Default: false Group: common
  
  Specified by:
  
  passiveMode in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  passiveMode in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  passiveMode - the value to set
  
  Returns:
  
  the dsl builder
- separator
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)
  
  Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option is a: org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator type. Default: UNIX Group: common
  
  Specified by:
  
  separator in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  separator in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  separator - the value to set
  
  Returns:
  
  the dsl builder
- separator
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder separator(String separator)
  
  Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name. The option will be converted to a org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator type. Default: UNIX Group: common
  
  Specified by:
  
  separator in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  separator in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  separator - the value to set
  
  Returns:
  
  the dsl builder
- autoCreateKnownHostsFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder autoCreateKnownHostsFile(boolean autoCreateKnownHostsFile)
  
  If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission). The option is a: boolean type. Default: false Group: security
  
  Specified by:
  
  autoCreateKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  autoCreateKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  autoCreateKnownHostsFile - the value to set
  
  Returns:
  
  the dsl builder
- autoCreateKnownHostsFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder autoCreateKnownHostsFile(String autoCreateKnownHostsFile)
  
  If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission). The option will be converted to a boolean type. Default: false Group: security
  
  Specified by:
  
  autoCreateKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  autoCreateKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  autoCreateKnownHostsFile - the value to set
  
  Returns:
  
  the dsl builder
- certBytes
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder certBytes(byte[] certBytes)
  
  Set the OpenSSH certificate as byte array. The option is a: byte[] type. Group: security
  
  Specified by:
  
  certBytes in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  certBytes in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  certBytes - the value to set
  
  Returns:
  
  the dsl builder
- certBytes
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder certBytes(String certBytes)
  
  Set the OpenSSH certificate as byte array. The option will be converted to a byte[] type. Group: security
  
  Specified by:
  
  certBytes in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  certBytes in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  certBytes - the value to set
  
  Returns:
  
  the dsl builder
- certFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder certFile(String certFile)
  
  Set the OpenSSH certificate file path for certificate-based authentication. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  certFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  certFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  certFile - the value to set
  
  Returns:
  
  the dsl builder
- certUri
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder certUri(String certUri)
  
  Set the OpenSSH certificate as a classpath: or file: URI. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  certUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  certUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  certUri - the value to set
  
  Returns:
  
  the dsl builder
- ciphers
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder ciphers(String ciphers)
  
  Set the list of ciphers that will be used in order of preference. Possible cipher names are defined by Apache MINA SSHD. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from MINA SSHD will be used. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  ciphers in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  ciphers in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  ciphers - the value to set
  
  Returns:
  
  the dsl builder
- keyExchangeProtocols
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder keyExchangeProtocols(String keyExchangeProtocols)
  
  Set the list of key exchange protocols that will be used in order of preference. If not specified the default list from MINA SSHD will be used. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  keyExchangeProtocols in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  keyExchangeProtocols in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  keyExchangeProtocols - the value to set
  
  Returns:
  
  the dsl builder
- keyPair
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder keyPair(KeyPair keyPair)
  
  Set a java.security.KeyPair directly for public key authentication. The option is a: java.security.KeyPair type. Group: security
  
  Specified by:
  
  keyPair in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  keyPair in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  keyPair - the value to set
  
  Returns:
  
  the dsl builder
- keyPair
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder keyPair(String keyPair)
  
  Set a java.security.KeyPair directly for public key authentication. The option will be converted to a java.security.KeyPair type. Group: security
  
  Specified by:
  
  keyPair in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  keyPair in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  keyPair - the value to set
  
  Returns:
  
  the dsl builder
- knownHosts
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder knownHosts(byte[] knownHosts)
  
  Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification. The option is a: byte[] type. Group: security
  
  Specified by:
  
  knownHosts in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  knownHosts in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  knownHosts - the value to set
  
  Returns:
  
  the dsl builder
- knownHosts
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder knownHosts(String knownHosts)
  
  Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification. The option will be converted to a byte[] type. Group: security
  
  Specified by:
  
  knownHosts in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  knownHosts in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  knownHosts - the value to set
  
  Returns:
  
  the dsl builder
- knownHostsFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder knownHostsFile(String knownHostsFile)
  
  Sets the known_hosts file, so that the SFTP endpoint can do host key verification. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  knownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  knownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  knownHostsFile - the value to set
  
  Returns:
  
  the dsl builder
- knownHostsUri
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder knownHostsUri(String knownHostsUri)
  
  Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  knownHostsUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  knownHostsUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  knownHostsUri - the value to set
  
  Returns:
  
  the dsl builder
- password
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder password(String password)
  
  Password to use for login. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  password in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  password in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  password - the value to set
  
  Returns:
  
  the dsl builder
- preferredAuthentications
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder preferredAuthentications(String preferredAuthentications)
  
  Set the preferred authentications which SFTP endpoint will used. Some example include: password,publickey. If not specified the default list from MINA SSHD will be used. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  preferredAuthentications in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  preferredAuthentications in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  preferredAuthentications - the value to set
  
  Returns:
  
  the dsl builder
- privateKey
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder privateKey(byte[] privateKey)
  
  Set the private key as byte array for public key authentication. The option is a: byte[] type. Group: security
  
  Specified by:
  
  privateKey in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  privateKey in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  privateKey - the value to set
  
  Returns:
  
  the dsl builder
- privateKey
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder privateKey(String privateKey)
  
  Set the private key as byte array for public key authentication. The option will be converted to a byte[] type. Group: security
  
  Specified by:
  
  privateKey in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  privateKey in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  privateKey - the value to set
  
  Returns:
  
  the dsl builder
- privateKeyFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder privateKeyFile(String privateKeyFile)
  
  Set the private key file path so that the SFTP endpoint can do public key authentication. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  privateKeyFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  privateKeyFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  privateKeyFile - the value to set
  
  Returns:
  
  the dsl builder
- privateKeyPassphrase
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder privateKeyPassphrase(String privateKeyPassphrase)
  
  Set the passphrase for decrypting an encrypted private key. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  privateKeyPassphrase in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  privateKeyPassphrase in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  privateKeyPassphrase - the value to set
  
  Returns:
  
  the dsl builder
- privateKeyUri
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder privateKeyUri(String privateKeyUri)
  
  Set the private key as a classpath: or file: URI (e.g., classpath:keys/id_rsa). This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  privateKeyUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  privateKeyUri in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  privateKeyUri - the value to set
  
  Returns:
  
  the dsl builder
- publicKeyAcceptedAlgorithms
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms)
  
  Set a comma separated list of public key accepted algorithms. If not specified the default list from MINA SSHD will be used. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  publicKeyAcceptedAlgorithms in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  publicKeyAcceptedAlgorithms in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  publicKeyAcceptedAlgorithms - the value to set
  
  Returns:
  
  the dsl builder
- serverHostKeys
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder serverHostKeys(String serverHostKeys)
  
  Set the list of algorithms supported for the server host key. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from MINA SSHD will be used. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  serverHostKeys in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverHostKeys in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverHostKeys - the value to set
  
  Returns:
  
  the dsl builder
- serverKeyVerifier
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder serverKeyVerifier(org.apache.sshd.client.keyverifier.ServerKeyVerifier serverKeyVerifier)
  
  Custom ServerKeyVerifier for host key verification. When provided, this verifier is used exclusively, ignoring strictHostKeyChecking, knownHostsFile, and other host key options. The option is a: org.apache.sshd.client.keyverifier.ServerKeyVerifier type. Group: security
  
  Specified by:
  
  serverKeyVerifier in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverKeyVerifier in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverKeyVerifier - the value to set
  
  Returns:
  
  the dsl builder
- serverKeyVerifier
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder serverKeyVerifier(String serverKeyVerifier)
  
  Custom ServerKeyVerifier for host key verification. When provided, this verifier is used exclusively, ignoring strictHostKeyChecking, knownHostsFile, and other host key options. The option will be converted to a org.apache.sshd.client.keyverifier.ServerKeyVerifier type. Group: security
  
  Specified by:
  
  serverKeyVerifier in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  serverKeyVerifier in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  serverKeyVerifier - the value to set
  
  Returns:
  
  the dsl builder
- strictHostKeyChecking
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder strictHostKeyChecking(String strictHostKeyChecking)
  
  Sets whether to use strict host key checking. The option is a: java.lang.String type. Default: no Group: security
  
  Specified by:
  
  strictHostKeyChecking in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  strictHostKeyChecking in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  strictHostKeyChecking - the value to set
  
  Returns:
  
  the dsl builder
- username
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder username(String username)
  
  Username to use for login. The option is a: java.lang.String type. Group: security
  
  Specified by:
  
  username in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  username in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  username - the value to set
  
  Returns:
  
  the dsl builder
- useUserKnownHostsFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder useUserKnownHostsFile(boolean useUserKnownHostsFile)
  
  If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. The option is a: boolean type. Default: true Group: security
  
  Specified by:
  
  useUserKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  useUserKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  useUserKnownHostsFile - the value to set
  
  Returns:
  
  the dsl builder
- useUserKnownHostsFile
  
  default MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder useUserKnownHostsFile(String useUserKnownHostsFile)
  
  If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. The option will be converted to a boolean type. Default: true Group: security
  
  Specified by:
  
  useUserKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointConsumerBuilder
  
  Specified by:
  
  useUserKnownHostsFile in interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointProducerBuilder
  
  Parameters:
  
  useUserKnownHostsFile - the value to set
  
  Returns:
  
  the dsl builder

Interface MinaSftpEndpointBuilderFactory.MinaSftpEndpointBuilder

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.MinaSftpEndpointConsumerBuilder

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

Method Details

advanced

binary

binary

charset

disconnect

disconnect

doneFileName

fileName

passiveMode

passiveMode

separator

separator

autoCreateKnownHostsFile

autoCreateKnownHostsFile

certBytes

certBytes

certFile

certUri

ciphers

keyExchangeProtocols

keyPair

keyPair

knownHosts

knownHosts

knownHostsFile

knownHostsUri

password

preferredAuthentications

privateKey

privateKey

privateKeyFile

privateKeyPassphrase

privateKeyUri

publicKeyAcceptedAlgorithms

serverHostKeys

serverKeyVerifier

serverKeyVerifier

strictHostKeyChecking

username

useUserKnownHostsFile

useUserKnownHostsFile