Interface SftpEndpointBuilderFactory.SftpEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
,SftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Enclosing interface:
- SftpEndpointBuilderFactory
public static interface SftpEndpointBuilderFactory.SftpEndpointBuilder extends SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder, SftpEndpointBuilderFactory.SftpEndpointProducerBuilder
Builder for endpoint for the SFTP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder
advanced()
default SftpEndpointBuilderFactory.SftpEndpointBuilder
binary(boolean binary)
Specifies the file transfer mode, BINARY or ASCII.default SftpEndpointBuilderFactory.SftpEndpointBuilder
binary(String binary)
Specifies the file transfer mode, BINARY or ASCII.default SftpEndpointBuilderFactory.SftpEndpointBuilder
charset(String charset)
This option is used to specify the encoding of the file.default SftpEndpointBuilderFactory.SftpEndpointBuilder
ciphers(String ciphers)
Set a comma separated list of ciphers that will be used in order of preference.default SftpEndpointBuilderFactory.SftpEndpointBuilder
disconnect(boolean disconnect)
Whether or not to disconnect from remote FTP server right after use.default SftpEndpointBuilderFactory.SftpEndpointBuilder
disconnect(String disconnect)
Whether or not to disconnect from remote FTP server right after use.default SftpEndpointBuilderFactory.SftpEndpointBuilder
doneFileName(String doneFileName)
Producer: If provided, then Camel will write a 2nd done file when the original file has been written.default SftpEndpointBuilderFactory.SftpEndpointBuilder
fileName(String fileName)
Use Expression such as File Language to dynamically set the filename.default SftpEndpointBuilderFactory.SftpEndpointBuilder
jschLoggingLevel(String jschLoggingLevel)
The logging level to use for JSCH activity logging.default SftpEndpointBuilderFactory.SftpEndpointBuilder
jschLoggingLevel(org.apache.camel.LoggingLevel jschLoggingLevel)
The logging level to use for JSCH activity logging.default SftpEndpointBuilderFactory.SftpEndpointBuilder
keyExchangeProtocols(String keyExchangeProtocols)
Set a comma separated list of key exchange protocols that will be used in order of preference.default SftpEndpointBuilderFactory.SftpEndpointBuilder
keyPair(String keyPair)
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
keyPair(KeyPair keyPair)
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
knownHosts(byte[] knownHosts)
Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
knownHosts(String knownHosts)
Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
knownHostsFile(String knownHostsFile)
Sets the known_hosts file, so that the SFTP endpoint can do host key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
knownHostsUri(String knownHostsUri)
Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
passiveMode(boolean passiveMode)
Sets passive mode connections.default SftpEndpointBuilderFactory.SftpEndpointBuilder
passiveMode(String passiveMode)
Sets passive mode connections.default SftpEndpointBuilderFactory.SftpEndpointBuilder
password(String password)
Password to use for login.default SftpEndpointBuilderFactory.SftpEndpointBuilder
preferredAuthentications(String preferredAuthentications)
Set the preferred authentications which SFTP endpoint will used.default SftpEndpointBuilderFactory.SftpEndpointBuilder
privateKey(byte[] privateKey)
Set the private key as byte so that the SFTP endpoint can do private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
privateKey(String privateKey)
Set the private key as byte so that the SFTP endpoint can do private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
privateKeyFile(String privateKeyFile)
Set the private key file so that the SFTP endpoint can do private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
privateKeyPassphrase(String privateKeyPassphrase)
Set the private key file passphrase so that the SFTP endpoint can do private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
privateKeyUri(String privateKeyUri)
Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification.default SftpEndpointBuilderFactory.SftpEndpointBuilder
publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms)
Set a comma separated list of public key accepted algorithms.default SftpEndpointBuilderFactory.SftpEndpointBuilder
separator(String separator)
Sets the path separator to be used.default SftpEndpointBuilderFactory.SftpEndpointBuilder
separator(org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator separator)
Sets the path separator to be used.default SftpEndpointBuilderFactory.SftpEndpointBuilder
serverHostKeys(String serverHostKeys)
Set a comma separated list of algorithms supported for the server host key.default SftpEndpointBuilderFactory.SftpEndpointBuilder
strictHostKeyChecking(String strictHostKeyChecking)
Sets whether to use strict host key checking.default SftpEndpointBuilderFactory.SftpEndpointBuilder
username(String username)
Username to use for login.default SftpEndpointBuilderFactory.SftpEndpointBuilder
useUserKnownHostsFile(boolean useUserKnownHostsFile)
If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.default SftpEndpointBuilderFactory.SftpEndpointBuilder
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, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
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, 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.SftpEndpointBuilderFactory.SftpEndpointProducerBuilder
fileExist, fileExist, flatten, flatten, jailStartingDirectory, jailStartingDirectory, moveExisting, tempFileName, tempPrefix
-
-
-
-
Method Detail
-
advanced
default SftpEndpointBuilderFactory.AdvancedSftpEndpointBuilder advanced()
- Specified by:
advanced
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
advanced
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
-
binary
default SftpEndpointBuilderFactory.SftpEndpointBuilder binary(boolean binary)
Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
binary
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
binary
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
binary
- the value to set- Returns:
- the dsl builder
-
binary
default SftpEndpointBuilderFactory.SftpEndpointBuilder binary(String binary)
Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
binary
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
binary
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
binary
- the value to set- Returns:
- the dsl builder
-
charset
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
charset
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
charset
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
charset
- the value to set- Returns:
- the dsl builder
-
disconnect
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>boolean</code> type. Default: false Group: common- Specified by:
disconnect
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
disconnect
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
disconnect
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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 <code>boolean</code> type. Default: false Group: common- Specified by:
disconnect
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
disconnect
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
doneFileName
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
doneFileName
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
doneFileName
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
doneFileName
- the value to set- Returns:
- the dsl builder
-
fileName
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
fileName
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
fileName
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
fileName
- the value to set- Returns:
- the dsl builder
-
jschLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointBuilder jschLoggingLevel(org.apache.camel.LoggingLevel jschLoggingLevel)
The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: common- Specified by:
jschLoggingLevel
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
jschLoggingLevel
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
jschLoggingLevel
- the value to set- Returns:
- the dsl builder
-
jschLoggingLevel
default SftpEndpointBuilderFactory.SftpEndpointBuilder jschLoggingLevel(String jschLoggingLevel)
The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: common- Specified by:
jschLoggingLevel
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
jschLoggingLevel
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
jschLoggingLevel
- the value to set- Returns:
- the dsl builder
-
passiveMode
default SftpEndpointBuilderFactory.SftpEndpointBuilder passiveMode(boolean passiveMode)
Sets passive mode connections. Default is active mode connections. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
passiveMode
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
passiveMode
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
passiveMode
- the value to set- Returns:
- the dsl builder
-
passiveMode
default SftpEndpointBuilderFactory.SftpEndpointBuilder passiveMode(String passiveMode)
Sets passive mode connections. Default is active mode connections. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
passiveMode
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
passiveMode
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
passiveMode
- the value to set- Returns:
- the dsl builder
-
separator
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common- Specified by:
separator
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
separator
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
separator
- the value to set- Returns:
- the dsl builder
-
separator
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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 <code>org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator</code> type. Default: UNIX Group: common- Specified by:
separator
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
separator
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
separator
- the value to set- Returns:
- the dsl builder
-
ciphers
default SftpEndpointBuilderFactory.SftpEndpointBuilder ciphers(String ciphers)
Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
ciphers
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
ciphers
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
ciphers
- the value to set- Returns:
- the dsl builder
-
keyExchangeProtocols
default SftpEndpointBuilderFactory.SftpEndpointBuilder keyExchangeProtocols(String keyExchangeProtocols)
Set a comma separated list of key exchange protocols that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: diffie-hellman-group-exchange-sha1,diffie-hellman-group1-sha1,diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
keyExchangeProtocols
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
keyExchangeProtocols
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
keyExchangeProtocols
- the value to set- Returns:
- the dsl builder
-
keyPair
default SftpEndpointBuilderFactory.SftpEndpointBuilder keyPair(KeyPair keyPair)
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. The option is a: <code>java.security.KeyPair</code> type. Group: security- Specified by:
keyPair
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
keyPair
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
keyPair
- the value to set- Returns:
- the dsl builder
-
keyPair
default SftpEndpointBuilderFactory.SftpEndpointBuilder keyPair(String keyPair)
Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. The option will be converted to a <code>java.security.KeyPair</code> type. Group: security- Specified by:
keyPair
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
keyPair
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
keyPair
- the value to set- Returns:
- the dsl builder
-
knownHosts
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>byte[]</code> type. Group: security- Specified by:
knownHosts
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
knownHosts
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
knownHosts
- the value to set- Returns:
- the dsl builder
-
knownHosts
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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 <code>byte[]</code> type. Group: security- Specified by:
knownHosts
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
knownHosts
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
knownHosts
- the value to set- Returns:
- the dsl builder
-
knownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointBuilder knownHostsFile(String knownHostsFile)
Sets the known_hosts file, so that the SFTP endpoint can do host key verification. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
knownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
knownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
knownHostsFile
- the value to set- Returns:
- the dsl builder
-
knownHostsUri
default SftpEndpointBuilderFactory.SftpEndpointBuilder knownHostsUri(String knownHostsUri)
Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
knownHostsUri
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
knownHostsUri
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
knownHostsUri
- the value to set- Returns:
- the dsl builder
-
password
default SftpEndpointBuilderFactory.SftpEndpointBuilder password(String password)
Password to use for login. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
password
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
password
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
preferredAuthentications
default SftpEndpointBuilderFactory.SftpEndpointBuilder preferredAuthentications(String preferredAuthentications)
Set the preferred authentications which SFTP endpoint will used. Some example include:password,publickey. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
preferredAuthentications
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
preferredAuthentications
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
preferredAuthentications
- the value to set- Returns:
- the dsl builder
-
privateKey
default SftpEndpointBuilderFactory.SftpEndpointBuilder privateKey(byte[] privateKey)
Set the private key as byte so that the SFTP endpoint can do private key verification. The option is a: <code>byte[]</code> type. Group: security- Specified by:
privateKey
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
privateKey
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKey
default SftpEndpointBuilderFactory.SftpEndpointBuilder privateKey(String privateKey)
Set the private key as byte so that the SFTP endpoint can do private key verification. The option will be converted to a <code>byte[]</code> type. Group: security- Specified by:
privateKey
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
privateKey
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
privateKey
- the value to set- Returns:
- the dsl builder
-
privateKeyFile
default SftpEndpointBuilderFactory.SftpEndpointBuilder privateKeyFile(String privateKeyFile)
Set the private key file so that the SFTP endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
privateKeyFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
privateKeyFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
privateKeyFile
- the value to set- Returns:
- the dsl builder
-
privateKeyPassphrase
default SftpEndpointBuilderFactory.SftpEndpointBuilder privateKeyPassphrase(String privateKeyPassphrase)
Set the private key file passphrase so that the SFTP endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
privateKeyPassphrase
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
privateKeyPassphrase
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
privateKeyPassphrase
- the value to set- Returns:
- the dsl builder
-
privateKeyUri
default SftpEndpointBuilderFactory.SftpEndpointBuilder privateKeyUri(String privateKeyUri)
Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
privateKeyUri
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
privateKeyUri
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
privateKeyUri
- the value to set- Returns:
- the dsl builder
-
publicKeyAcceptedAlgorithms
default SftpEndpointBuilderFactory.SftpEndpointBuilder publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms)
Set a comma separated list of public key accepted algorithms. Some examples include: ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-512,rsa-sha2-256 If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
publicKeyAcceptedAlgorithms
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
publicKeyAcceptedAlgorithms
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
publicKeyAcceptedAlgorithms
- the value to set- Returns:
- the dsl builder
-
serverHostKeys
default SftpEndpointBuilderFactory.SftpEndpointBuilder serverHostKeys(String serverHostKeys)
Set a comma separated list of algorithms supported for the server host key. Some examples include: ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-512,rsa-sha2-256 If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
serverHostKeys
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
serverHostKeys
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
serverHostKeys
- the value to set- Returns:
- the dsl builder
-
strictHostKeyChecking
default SftpEndpointBuilderFactory.SftpEndpointBuilder strictHostKeyChecking(String strictHostKeyChecking)
Sets whether to use strict host key checking. The option is a: <code>java.lang.String</code> type. Default: no Group: security- Specified by:
strictHostKeyChecking
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
strictHostKeyChecking
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
strictHostKeyChecking
- the value to set- Returns:
- the dsl builder
-
username
default SftpEndpointBuilderFactory.SftpEndpointBuilder username(String username)
Username to use for login. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
username
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
username
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
useUserKnownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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: <code>boolean</code> type. Default: true Group: security- Specified by:
useUserKnownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
useUserKnownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
useUserKnownHostsFile
- the value to set- Returns:
- the dsl builder
-
useUserKnownHostsFile
default SftpEndpointBuilderFactory.SftpEndpointBuilder 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 <code>boolean</code> type. Default: true Group: security- Specified by:
useUserKnownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointConsumerBuilder
- Specified by:
useUserKnownHostsFile
in interfaceSftpEndpointBuilderFactory.SftpEndpointProducerBuilder
- Parameters:
useUserKnownHostsFile
- the value to set- Returns:
- the dsl builder
-
-