|
SSH Factory | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.jscape.inet.ssh.util.SshParameters
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 |
public SshParameters(java.lang.String sshHostname,
int sshPort,
java.lang.String sshUsername,
java.lang.String privateKeyPassphrase,
java.io.File privateKey)
sshHostname - the SSH server hostnamesshPort - the SSH server portsshUsername - the SSH server usernameprivateKeyPassphrase - the private key file passwordprivateKey - the private key file
public SshParameters(java.lang.String sshHostname,
java.lang.String sshUsername,
java.io.File privateKey)
sshHostname - the SSH server hostnamesshUsername - the SSH server usernameprivateKey - the private key file
public SshParameters(java.lang.String sshHostname,
int sshPort,
java.lang.String sshUsername,
java.io.File privateKey)
sshHostname - the SSH server hostnamesshPort - the SSH server portsshUsername - the SSH server usernameprivateKey - the private key file
public SshParameters(java.lang.String sshHostname,
java.lang.String sshUsername,
java.lang.String sshPassword)
sshHostname - the SSH server hostnamesshUsername - the SSH server usernamesshPassword - the SSH server password
public SshParameters(java.lang.String sshHostname,
int sshPort,
java.lang.String sshUsername,
java.lang.String sshPassword)
sshHostname - the SSH server hostnamesshPort - the SSH server portsshUsername - the SSH server usernamesshPassword - the SSH server password
public SshParameters(java.lang.String sshHostname,
java.lang.String sshUsername,
java.lang.String privateKeyPassphrase,
java.io.File privateKey)
sshHostname - the SSH server hostnamesshUsername - the SSH server usernameprivateKeyPassphrase - the private key passphraseprivateKey - the private key file| Method Detail |
public java.lang.String getSshHostname()
public java.lang.String getSshPassword()
public int getSshPort()
public java.lang.String getSshUsername()
public java.io.File getPrivateKey()
public void setSshHostname(java.lang.String string)
string - the SSH hostnamepublic void setSshPassword(java.lang.String string)
string - the SSH account password or private key passphrase if public-key authentication is usedpublic void setSshPort(int i)
i - the SSH portpublic void setSshUsername(java.lang.String string)
string - the SSH usernamepublic void setPrivateKey(java.io.File privateKey)
privateKey -
|
SSH Factory | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||