Package org.apache.camel.component.scp

Class ScpConfiguration

java.lang.Object
org.apache.camel.component.file.GenericFileConfiguration
org.apache.camel.component.file.remote.RemoteFileConfiguration
org.apache.camel.component.scp.ScpConfiguration
@UriParams public class ScpConfiguration extends org.apache.camel.component.file.remote.RemoteFileConfiguration
SCP configuration

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.camel.component.file.remote.RemoteFileConfiguration

    org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_MOD
     
    static final int
    DEFAULT_SFTP_PORT
     

    Fields inherited from class org.apache.camel.component.file.GenericFileConfiguration

    directory

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScpConfiguration()
     
    ScpConfiguration(URI uri)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getChmod()
     
    String
    getCiphers()
     
    String
    getKnownHostsFile()
     
    String
    getPreferredAuthentications()
     
    byte[]
    getPrivateKeyBytes()
     
    String
    getPrivateKeyFile()
     
    String
    getPrivateKeyFilePassphrase()
     
    String
    getStrictHostKeyChecking()
     
    boolean
    isUseUserKnownHostsFile()
     
    void
    setChmod(String chmod)
    Allows you to set chmod on the stored file.
    void
    setCiphers(String ciphers)
    Set a comma separated list of ciphers that will be used in order of preference.
    protected void
    setDefaultPort()
     
    void
    setKnownHostsFile(String knownHostsFile)
    Sets the known_hosts file, so that the jsch endpoint can do host key verification.
    void
    setPreferredAuthentications(String preferredAuthentications)
    Set a comma separated list of authentications that will be used in order of preference.
    void
    setPrivateKeyBytes(byte[] privateKeyBytes)
    Set the private key bytes to that the endpoint can do private key verification.
    void
    setPrivateKeyFile(String privateKeyFile)
    Set the private key file to that the endpoint can do private key verification.
    void
    setPrivateKeyFilePassphrase(String privateKeyFilePassphrase)
    Set the private key file passphrase to that the endpoint can do private key verification.
    void
    setStrictHostKeyChecking(String strictHostKeyChecking)
    Sets whether to use strict host key checking.
    void
    setUseUserKnownHostsFile(boolean useUserKnownHostsFile)
    If knownHostFile has not been explicit configured, then use the host file from System.getProperty("user.home") + "/.ssh/known_hosts"

    Methods inherited from class org.apache.camel.component.file.remote.RemoteFileConfiguration

    configure, getConnectTimeout, getDirectoryName, getHost, getPassword, getPort, getProtocol, getSeparator, getSiteCommand, getSoTimeout, getTimeout, getUsername, isBinary, isIgnoreFileNotFoundOrPermissionError, isPassiveMode, isSendNoop, isStepwise, isStreamDownload, isThrowExceptionOnConnectFailed, isUseList, needToNormalize, normalizePath, remoteServerInformation, setBinary, setConnectTimeout, setDirectoryName, setHost, setIgnoreFileNotFoundOrPermissionError, setPassiveMode, setPassword, setPort, setProtocol, setSendNoop, setSeparator, setSiteCommand, setSoTimeout, setStepwise, setStreamDownload, setThrowExceptionOnConnectFailed, setTimeout, setUseList, setUsername

    Methods inherited from class org.apache.camel.component.file.GenericFileConfiguration

    getDirectory, setDirectory, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • ScpConfiguration

      public ScpConfiguration()

    • ScpConfiguration

      public ScpConfiguration(URI uri)

  • Method Details

    • setDefaultPort

      protected void setDefaultPort()
      Specified by:
      setDefaultPort in class org.apache.camel.component.file.remote.RemoteFileConfiguration

    • getKnownHostsFile

      public String getKnownHostsFile()

    • setKnownHostsFile

      public void setKnownHostsFile(String knownHostsFile)
      Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system.

    • isUseUserKnownHostsFile

      public boolean isUseUserKnownHostsFile()

    • setUseUserKnownHostsFile

      public void setUseUserKnownHostsFile(boolean useUserKnownHostsFile)
      If knownHostFile has not been explicit configured, then use the host file from System.getProperty("user.home") + "/.ssh/known_hosts"

    • getPrivateKeyFile

      public String getPrivateKeyFile()

    • setPrivateKeyFile

      public void setPrivateKeyFile(String privateKeyFile)
      Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system.

    • getPrivateKeyBytes

      public byte[] getPrivateKeyBytes()

    • setPrivateKeyBytes

      public void setPrivateKeyBytes(byte[] privateKeyBytes)
      Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority.

    • getPrivateKeyFilePassphrase

      public String getPrivateKeyFilePassphrase()

    • setPrivateKeyFilePassphrase

      public void setPrivateKeyFilePassphrase(String privateKeyFilePassphrase)
      Set the private key file passphrase to that the endpoint can do private key verification.

    • getStrictHostKeyChecking

      public String getStrictHostKeyChecking()

    • setStrictHostKeyChecking

      public void setStrictHostKeyChecking(String strictHostKeyChecking)
      Sets whether to use strict host key checking. Possible values are: no, yes

    • setChmod

      public void setChmod(String chmod)
      Allows you to set chmod on the stored file. For example chmod=664.

    • getChmod

      public String getChmod()

    • setCiphers

      public void setCiphers(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.

    • getCiphers

      public String getCiphers()

    • setPreferredAuthentications

      public void setPreferredAuthentications(String preferredAuthentications)
      Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used.

    • getPreferredAuthentications

      public String getPreferredAuthentications()