SshConfiguration (Camel :: SSH 3.11.4 API)

java.lang.Object
- org.apache.camel.component.ssh.SshConfiguration

All Implemented Interfaces:: Cloneable

@UriParams
public class SshConfiguration
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_SSH_PORT

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SSH_PORT`

Constructor Summary

Constructors
Constructor and Description

SshConfiguration()

SshConfiguration(URI uri)

Constructors
Constructor and Description
`SshConfiguration()`
`SshConfiguration(URI uri)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(URI uri)`
`SshConfiguration`	`copy()`
`String`	`getCertResource()`
`String`	`getCertResourcePassword()`
`String`	`getChannelType()`
`String`	`getHost()`
`org.apache.sshd.common.keyprovider.KeyPairProvider`	`getKeyPairProvider()`
`String`	`getKeyType()`
`String`	`getKnownHostsResource()`
`String`	`getPassword()`
`String`	`getPollCommand()`
`int`	`getPort()`
`String`	`getShellPrompt()`
`long`	`getSleepForShellPrompt()`
`long`	`getTimeout()`
`String`	`getUsername()`
`boolean`	`isFailOnUnknownHost()`
`void`	`setCertResource(String certResource)` Sets the resource path of the certificate to use for Authentication.
`void`	`setCertResourcePassword(String certResourcePassword)` Sets the password to use in loading certResource, if certResource is an encrypted key.
`void`	`setChannelType(String channelType)` Sets the channel type to pass to the Channel as part of command execution.
`void`	`setFailOnUnknownHost(boolean failOnUnknownHost)` Specifies whether a connection to an unknown host should fail or not.
`void`	`setHost(String host)` Sets the hostname of the remote SSH server.
`void`	`setKeyPairProvider(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)` Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
`void`	`setKeyType(String keyType)` Sets the key type to pass to the KeyPairProvider as part of authentication.
`void`	`setKnownHostsResource(String knownHostsResource)` Sets the resource path for a known_hosts file
`void`	`setPassword(String password)` Sets the password to use in connecting to remote SSH server.
`void`	`setPollCommand(String pollCommand)` Sets the command string to send to the remote SSH server during every poll cycle.
`void`	`setPort(int port)` Sets the port number for the remote SSH server.
`void`	`setShellPrompt(String shellPrompt)` Sets the shellPrompt to be dropped when response is read after command execution
`void`	`setSleepForShellPrompt(long sleepForShellPrompt)` Sets the sleep period in milliseconds to wait reading response from shell prompt.
`void`	`setTimeout(long timeout)` Sets the timeout in milliseconds to wait in establishing the remote SSH server connection.
`void`	`setUsername(String username)` Sets the username to use in logging into the remote SSH server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SSH_PORT
```
public static final int DEFAULT_SSH_PORT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SshConfiguration
```
public SshConfiguration()
```
  - SshConfiguration
```
public SshConfiguration(URI uri)
```
- Method Detail
  - 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.

Class SshConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SSH_PORT

Constructor Detail

SshConfiguration

SshConfiguration

Method Detail

configure

copy

getUsername

setUsername

getHost

setHost

getPort

setPort

getPassword

setPassword

getPollCommand

setPollCommand

getKeyPairProvider

setKeyPairProvider

getKeyType

setKeyType

getTimeout

setTimeout

getCertResource

setCertResource

getCertResourcePassword

setCertResourcePassword

getKnownHostsResource

setKnownHostsResource

isFailOnUnknownHost

setFailOnUnknownHost

getChannelType

setChannelType

getShellPrompt

setShellPrompt

getSleepForShellPrompt

setSleepForShellPrompt