Package org.apache.camel.component.ssh

Class SshConfiguration

java.lang.Object
org.apache.camel.component.ssh.SshConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class SshConfiguration extends Object implements Cloneable

  • Field Details

  • Constructor Details

    • SshConfiguration

      public SshConfiguration()

    • SshConfiguration

      public SshConfiguration(URI uri)

  • Method Details

    • configure

      public void configure(URI uri)

    • copy

      public SshConfiguration copy()

    • getUsername

      public String getUsername()

    • setUsername

      public void setUsername(String username)
      Sets the username to use in logging into the remote SSH server.
      Parameters:
      username - String representing login username.

    • getHost

      public String getHost()

    • setHost

      public void setHost(String host)
      Sets the hostname of the remote SSH server.
      Parameters:
      host - String representing hostname of SSH server.

    • getPort

      public int getPort()

    • setPort

      public void setPort(int port)
      Sets the port number for the remote SSH server.
      Parameters:
      port - int representing port number on remote host. Defaults to 22.

    • getPassword

      public String getPassword()

    • setPassword

      public void setPassword(String password)
      Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
      Parameters:
      password - String representing password for username at remote host.

    • getPollCommand

      public String getPollCommand()

    • setPollCommand

      public void setPollCommand(String pollCommand)
      Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from("ssh://...") You may need to end your command with a newline, and that must be URL encoded %0A
      Parameters:
      pollCommand - String representing the command to send.

    • getKeyPairProvider

      public org.apache.sshd.common.keyprovider.KeyPairProvider getKeyPairProvider()

    • setKeyPairProvider

      public void setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)
      Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
      Parameters:
      keyPairProvider - KeyPairProvider reference to use in authenticating. If set to 'null', then will attempt to connect using username/password settings.
      See Also:
      • KeyPairProvider

    • getKeyType

      public String getKeyType()

    • setKeyType

      public void setKeyType(String keyType)
      Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default.
      Parameters:
      keyType - String defining the type of KeyPair to use for authentication.
      See Also:
      • KeyPairProvider

    • getTimeout

      public long getTimeout()

    • setTimeout

      public void setTimeout(long timeout)
      Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
      Parameters:
      timeout - long milliseconds to wait.

    • getCertResource

      public String getCertResource()

    • setCertResource

      public void setCertResource(String certResource)
      Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting.
      Parameters:
      certResource - String file, classpath, or http url for the certificate

    • getCertResourcePassword

      public String getCertResourcePassword()

    • setCertResourcePassword

      public void setCertResourcePassword(String certResourcePassword)
      Sets the password to use in loading certResource, if certResource is an encrypted key.
      Parameters:
      certResourcePassword - String representing password use to load the certResource key

    • getKnownHostsResource

      public String getKnownHostsResource()

    • setKnownHostsResource

      public void setKnownHostsResource(String knownHostsResource)
      Sets the resource path for a known_hosts file
      Parameters:
      knownHostsResource - String file, classpath, or http url for the certificate

    • isFailOnUnknownHost

      public boolean isFailOnUnknownHost()

    • setFailOnUnknownHost

      public void setFailOnUnknownHost(boolean failOnUnknownHost)
      Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set.
      Parameters:
      failOnUnknownHost - boolean flag, whether a connection to an unknown host should fail

    • getChannelType

      public String getChannelType()

    • setChannelType

      public void setChannelType(String channelType)
      Sets the channel type to pass to the Channel as part of command execution. Defaults to "exec".
      Parameters:
      channelType - String defining the type of Channel to use for command execution.
      See Also:
      • Channel

    • getShellPrompt

      public String getShellPrompt()

    • setShellPrompt

      public void setShellPrompt(String shellPrompt)
      Sets the shellPrompt to be dropped when response is read after command execution
      Parameters:
      shellPrompt - String defining ending string of command line which has to be dropped when response is read after command execution.

    • getSleepForShellPrompt

      public long getSleepForShellPrompt()

    • setSleepForShellPrompt

      public void setSleepForShellPrompt(long sleepForShellPrompt)
      Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds.
      Parameters:
      sleepForShellPrompt - long milliseconds to wait.

    • getKex

      public String getKex()

    • setKex

      public void setKex(String kex)
      Comma-separated list of allowed/supported key exchange algorithms in their **order** of preference.
      Parameters:
      kex -

    • getCiphers

      public String getCiphers()

    • setCiphers

      public void setCiphers(String ciphers)
      Comma-separated list of allowed/supported ciphers in their order of preference.
      Parameters:
      ciphers -

    • getMacs

      public String getMacs()

    • setMacs

      public void setMacs(String macs)
      Comma-separated list of allowed/supported message authentication code algorithms in their **order** of preference. The MAC algorithm is used for data integrity protection.
      Parameters:
      macs -

    • getSignatures

      public String getSignatures()

    • setSignatures

      public void setSignatures(String signatures)
      Comma-separated list of allowed/supported signature algorithms in their order of preference.
      Parameters:
      signatures -

    • getCompressions

      public String getCompressions()

    • setCompressions

      public void setCompressions(String compressions)
      Whether to use compression, and if so which.
      Parameters:
      compressions -

    • getClientBuilder

      public org.apache.sshd.client.ClientBuilder getClientBuilder()

    • setClientBuilder

      public void setClientBuilder(org.apache.sshd.client.ClientBuilder clientBuilder)
      Instance of ClientBuilder used by the producer or consumer to create a new SshClient
      Parameters:
      clientBuilder - the ClientBuilder instance