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

Interface SftpEndpointBuilderFactory.SftpEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
SftpEndpointBuilderFactory.SftpEndpointBuilder
Enclosing interface:
SftpEndpointBuilderFactory
public static interface SftpEndpointBuilderFactory.SftpEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the SFTP component.

  • Method Details

    • advanced

      default SftpEndpointBuilderFactory.AdvancedSftpEndpointProducerBuilder advanced()

    • binary

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

    • binary

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

    • charset

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

    • disconnect

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

    • disconnect

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

    • doneFileName

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

    • fileName

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

    • jschLoggingLevel

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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: org.apache.camel.LoggingLevel type. Default: WARN Group: common
      Parameters:
      jschLoggingLevel - the value to set
      Returns:
      the dsl builder

    • jschLoggingLevel

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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 org.apache.camel.LoggingLevel type. Default: WARN Group: common
      Parameters:
      jschLoggingLevel - the value to set
      Returns:
      the dsl builder

    • passiveMode

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder passiveMode(boolean passiveMode)
      Sets passive mode connections. Default is active mode connections. The option is a: boolean type. Default: false Group: common
      Parameters:
      passiveMode - the value to set
      Returns:
      the dsl builder

    • passiveMode

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

    • separator

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

    • separator

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

    • checksumFileAlgorithm

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder checksumFileAlgorithm(String checksumFileAlgorithm)
      If provided, then Camel will write a checksum file when the original file has been written. The checksum file will contain the checksum created with the provided algorithm for the original file. The checksum file will always be written in the same folder as the original file. The option is a: java.lang.String type. Group: producer
      Parameters:
      checksumFileAlgorithm - the value to set
      Returns:
      the dsl builder

    • fileExist

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder fileExist(org.apache.camel.component.file.GenericFileExist fileExist)
      What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers. The option is a: org.apache.camel.component.file.GenericFileExist type. Default: Override Group: producer
      Parameters:
      fileExist - the value to set
      Returns:
      the dsl builder

    • fileExist

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder fileExist(String fileExist)
      What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers. The option will be converted to a org.apache.camel.component.file.GenericFileExist type. Default: Override Group: producer
      Parameters:
      fileExist - the value to set
      Returns:
      the dsl builder

    • flatten

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder flatten(boolean flatten)
      Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. The option is a: boolean type. Default: false Group: producer
      Parameters:
      flatten - the value to set
      Returns:
      the dsl builder

    • flatten

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder flatten(String flatten)
      Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      flatten - the value to set
      Returns:
      the dsl builder

    • jailStartingDirectory

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder jailStartingDirectory(boolean jailStartingDirectory)
      Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. The option is a: boolean type. Default: true Group: producer
      Parameters:
      jailStartingDirectory - the value to set
      Returns:
      the dsl builder

    • jailStartingDirectory

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder jailStartingDirectory(String jailStartingDirectory)
      Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. The option will be converted to a boolean type. Default: true Group: producer
      Parameters:
      jailStartingDirectory - the value to set
      Returns:
      the dsl builder

    • moveExisting

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder moveExisting(String moveExisting)
      Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base. The option is a: java.lang.String type. Group: producer
      Parameters:
      moveExisting - the value to set
      Returns:
      the dsl builder

    • tempFileName

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder tempFileName(String tempFileName)
      The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir. The option is a: java.lang.String type. Group: producer
      Parameters:
      tempFileName - the value to set
      Returns:
      the dsl builder

    • tempPrefix

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder tempPrefix(String tempPrefix)
      This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files. The option is a: java.lang.String type. Group: producer
      Parameters:
      tempPrefix - the value to set
      Returns:
      the dsl builder

    • autoCreateKnownHostsFile

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

    • autoCreateKnownHostsFile

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

    • ciphers

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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: java.lang.String type. Group: security
      Parameters:
      ciphers - the value to set
      Returns:
      the dsl builder

    • keyExchangeProtocols

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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: java.lang.String type. Group: security
      Parameters:
      keyExchangeProtocols - the value to set
      Returns:
      the dsl builder

    • keyPair

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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: java.security.KeyPair type. Group: security
      Parameters:
      keyPair - the value to set
      Returns:
      the dsl builder

    • keyPair

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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 java.security.KeyPair type. Group: security
      Parameters:
      keyPair - the value to set
      Returns:
      the dsl builder

    • knownHosts

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

    • knownHosts

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

    • knownHostsFile

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

    • knownHostsUri

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

    • password

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder password(String password)
      Password to use for login. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • preferredAuthentications

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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: java.lang.String type. Group: security
      Parameters:
      preferredAuthentications - the value to set
      Returns:
      the dsl builder

    • privateKey

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder privateKey(byte[] privateKey)
      Set the private key as byte so that the SFTP endpoint can do private key verification. The option is a: byte[] type. Group: security
      Parameters:
      privateKey - the value to set
      Returns:
      the dsl builder

    • privateKey

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder 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 byte[] type. Group: security
      Parameters:
      privateKey - the value to set
      Returns:
      the dsl builder

    • privateKeyFile

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder privateKeyFile(String privateKeyFile)
      Set the private key file so that the SFTP endpoint can do private key verification. The option is a: java.lang.String type. Group: security
      Parameters:
      privateKeyFile - the value to set
      Returns:
      the dsl builder

    • privateKeyPassphrase

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder privateKeyPassphrase(String privateKeyPassphrase)
      Set the private key file passphrase so that the SFTP endpoint can do private key verification. The option is a: java.lang.String type. Group: security
      Parameters:
      privateKeyPassphrase - the value to set
      Returns:
      the dsl builder

    • privateKeyUri

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder privateKeyUri(String privateKeyUri)
      Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private 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
      Parameters:
      privateKeyUri - the value to set
      Returns:
      the dsl builder

    • publicKeyAcceptedAlgorithms

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder publicKeyAcceptedAlgorithms(String publicKeyAcceptedAlgorithms)
      Set a comma separated list of public key accepted algorithms. Some examples include: ssh-dss,ssh-rsa,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521. If not specified the default list from JSCH will be used. The option is a: java.lang.String type. Group: security
      Parameters:
      publicKeyAcceptedAlgorithms - the value to set
      Returns:
      the dsl builder

    • serverHostKeys

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder serverHostKeys(String serverHostKeys)
      Set a comma separated 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 JSCH will be used. The option is a: java.lang.String type. Group: security
      Parameters:
      serverHostKeys - the value to set
      Returns:
      the dsl builder

    • strictHostKeyChecking

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder strictHostKeyChecking(String strictHostKeyChecking)
      Sets whether to use strict host key checking. The option is a: java.lang.String type. Default: no Group: security
      Parameters:
      strictHostKeyChecking - the value to set
      Returns:
      the dsl builder

    • username

      default SftpEndpointBuilderFactory.SftpEndpointProducerBuilder username(String username)
      Username to use for login. The option is a: java.lang.String type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder

    • useUserKnownHostsFile

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

    • useUserKnownHostsFile

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