SSH Factory

com.jscape.inet.ssh.util
Class SshParameters

java.lang.Object
  extended bycom.jscape.inet.ssh.util.SshParameters

public class SshParameters
extends java.lang.Object

Contains information used in establishing a connection to and authenticating with an SSH server.

Username/Password authentication example:

 String hostname = "hostname.com";
 String username = "jsmith";
 String password = "secret";
 

SshParameters sshParams = new SshParameters(hostname,username,password);

Public-key authentication using passphrase protected private key example:

 String hostname = "hostname.com";
 String username = "jsmith";
 

// passphrase for private key String password = "secret";

// location of private key file File privateKey = new File("c:/keys/id_rsa");

SshParameters sshParams = new SshParameters(hostname,username,password,privateKey);

The SshParameters class supports private keys in both OpenSSH and SSH.COM private key formats.


Constructor Summary
SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.io.File privateKey)
          Creates a new SshParameters instance.
SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String sshPassword)
          Creates a new SshParameters instance.
SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String privateKeyPassphrase, java.io.File privateKey)
          Creates a new parameters instance.
SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.io.File privateKey)
          Creates a new SshParameters instance.
SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.lang.String sshPassword)
          Creates a new SshParameters instance.
SshParameters(java.lang.String sshHostname, java.lang.String sshUsername, java.lang.String privateKeyPassphrase, java.io.File privateKey)
          Creates a new SshParameters instance.
 
Method Summary
 java.io.File getPrivateKey()
          Sets key pair to be used when authenticating with SSH Server.
 java.lang.String getSshHostname()
          Gets SSH hostname.
 java.lang.String getSshPassword()
          Gets SSH password.
 int getSshPort()
          Gets SSH port.
 java.lang.String getSshUsername()
          Gets SSH username.
 void setPrivateKey(java.io.File privateKey)
          Sets key pair to be used when authenticating with SSH Server.
 void setSshHostname(java.lang.String string)
          Sets SSH hostname.
 void setSshPassword(java.lang.String string)
          Sets SSH password.
 void setSshPort(int i)
          Sets SSH port.
 void setSshUsername(java.lang.String string)
          Sets SSH username.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.lang.String privateKeyPassphrase,
                     java.io.File privateKey)
Creates a new parameters instance.

Parameters:
sshHostname - the SSH server hostname
sshPort - the SSH server port
sshUsername - the SSH server username
privateKeyPassphrase - the private key file password
privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.io.File privateKey)
Creates a new SshParameters instance. For use in SSH authentication when private key is not protected by a password.

Parameters:
sshHostname - the SSH server hostname
sshUsername - the SSH server username
privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.io.File privateKey)
Creates a new SshParameters instance. For use in SSH authentication when private key is not protected by a password.

Parameters:
sshHostname - the SSH server hostname
sshPort - the SSH server port
sshUsername - the SSH server username
privateKey - the private key file

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.lang.String sshPassword)
Creates a new SshParameters instance.

Parameters:
sshHostname - the SSH server hostname
sshUsername - the SSH server username
sshPassword - the SSH server password

SshParameters

public SshParameters(java.lang.String sshHostname,
                     int sshPort,
                     java.lang.String sshUsername,
                     java.lang.String sshPassword)
Creates a new SshParameters instance.

Parameters:
sshHostname - the SSH server hostname
sshPort - the SSH server port
sshUsername - the SSH server username
sshPassword - the SSH server password

SshParameters

public SshParameters(java.lang.String sshHostname,
                     java.lang.String sshUsername,
                     java.lang.String privateKeyPassphrase,
                     java.io.File privateKey)
Creates a new SshParameters instance. For use in SSH authentication when private key is protected by a passphrase.

Parameters:
sshHostname - the SSH server hostname
sshUsername - the SSH server username
privateKeyPassphrase - the private key passphrase
privateKey - the private key file
Method Detail

getSshHostname

public java.lang.String getSshHostname()
Gets SSH hostname.

Returns:
the SSH hostname

getSshPassword

public java.lang.String getSshPassword()
Gets SSH password.

Returns:
the SSH account password or private key passphrase is public-key authentication is used

getSshPort

public int getSshPort()
Gets SSH port. Default port is 22.

Returns:
the SSH port

getSshUsername

public java.lang.String getSshUsername()
Gets SSH username.

Returns:
the SSH username

getPrivateKey

public java.io.File getPrivateKey()
Sets key pair to be used when authenticating with SSH Server.

Returns:
File

setSshHostname

public void setSshHostname(java.lang.String string)
Sets SSH hostname.

Parameters:
string - the SSH hostname

setSshPassword

public void setSshPassword(java.lang.String string)
Sets SSH password.

Parameters:
string - the SSH account password or private key passphrase if public-key authentication is used

setSshPort

public void setSshPort(int i)
Sets SSH port. Default port is 22.

Parameters:
i - the SSH port

setSshUsername

public void setSshUsername(java.lang.String string)
Sets SSH username.

Parameters:
string - the SSH username

setPrivateKey

public void setPrivateKey(java.io.File privateKey)
Sets key pair to be used when authenticating with SSH Server.

Parameters:
privateKey -

SSH Factory

Copyright JSCAPE 2004 All Rights Reserved