|
Secure FTP 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
public class 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(ConnectionParameters connectionParameters,
User user,
java.io.File privateKey,
java.lang.String privateKeyPassword,
HostKeyVerifier hostKeyVerifier)
|
|
SshParameters(SshParameters that)
Copy constructor. |
|
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,
int sshPort,
java.lang.String sshUsername,
java.lang.String sshPassword,
java.io.File privateKey,
java.lang.String privateKeyPassphrase)
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 | |
---|---|
ConnectionParameters |
getConnectionParameters()
Returns corresponded connection parameters. |
long |
getConnectionTimeout()
Returns connection timeout in milliseconds. |
HostKeyVerifier |
getHostKeyVerifier()
Returns current host key verifier. |
java.security.KeyPair |
getKeyPair()
Returns user key pair. |
java.io.File |
getPrivateKey()
Sets key pair to be used when authenticating with SSH Server. |
java.lang.String |
getProxyHost()
Gets proxy hostname. |
java.lang.String |
getProxyPassword()
Gets the proxy authentication password. |
int |
getProxyPort()
Gets the proxy port. |
java.lang.String |
getProxyType()
Gets the proxy type: SOCKS5, HTTP. |
java.lang.String |
getProxyUserId()
Gets the user authentication proxy. |
long |
getReadingTimeout()
Returns reading timeout in milliseconds. |
int |
getSocketTrafficClass()
Get socket traffic class |
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. |
boolean |
getTcpNoDelay()
Get TCP no delay. |
User |
getUser()
Returns user instance. |
void |
setConnectionParameters(ConnectionParameters value)
Sets connection parameters. |
void |
setConnectionTimeout(long value)
Sets connection timeout. |
void |
setHostKeyVerifier(HostKeyVerifier hostKeyVerifier)
Setups new host key verifier. |
void |
setKeyPair(java.security.KeyPair keyPair)
Sets user key pair. |
void |
setPrivateKey(java.io.File privateKey)
Sets key pair to be used when authenticating with SSH Server. |
void |
setPrivateKey(java.io.File privateKey,
java.lang.String filePassword)
Sets key pair to be used when authenticating with SSH Server. |
void |
setPrivateKey(java.lang.String serializedKeyData)
Sets key pair to be used when authenticating with SSH Server. |
void |
setPrivateKey(java.lang.String serializedKeyData,
java.lang.String password)
Sets key pair to be used when authenticating with SSH Server. |
void |
setProxyHost(java.lang.String proxyHost)
Sets the proxy hostname. |
void |
setProxyPassword(java.lang.String proxyPassword)
Sets the proxy authentication password. |
void |
setProxyPort(int proxyPort)
Sets the proxy port. |
void |
setProxyType(java.lang.String proxyType)
Sets the proxy type |
void |
setProxyUserId(java.lang.String proxyUserId)
Sets user authentication proxy. |
void |
setReadingTimeout(long value)
Sets reading timeout. |
void |
setSocketTrafficClass(int trafficClass)
Set socket traffic class. |
void |
setSshHostname(java.lang.String host)
Sets SSH hostname. |
void |
setSshPassword(java.lang.String password)
Sets SSH password. |
void |
setSshPort(int port)
Sets SSH port. |
void |
setSshUsername(java.lang.String name)
Sets SSH username. |
void |
setTcpNoDelay(boolean tcpNoDelay)
Set TCP no delay. |
void |
setUser(User user)
Sets a new user value. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SshParameters(ConnectionParameters connectionParameters, User user, java.io.File privateKey, java.lang.String privateKeyPassword, HostKeyVerifier hostKeyVerifier)
public SshParameters(java.lang.String sshHostname, int sshPort, java.lang.String sshUsername, java.lang.String sshPassword, java.io.File privateKey, java.lang.String privateKeyPassphrase)
sshHostname
- the SSH server hostnamesshPort
- the SSH server portsshUsername
- the SSH server usernamesshPassword
- the SSH server passwordprivateKey
- the private key fileprivateKeyPassphrase
- the private key passphrasepublic 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 filepublic 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 filepublic 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 filepublic 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 filepublic 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 passwordpublic 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 passwordpublic SshParameters(SshParameters that)
that
- instance to copyMethod Detail |
---|
public ConnectionParameters getConnectionParameters()
public void setConnectionParameters(ConnectionParameters value)
value
- a new connection parameters valuepublic int getSocketTrafficClass()
public void setSocketTrafficClass(int trafficClass)
trafficClass
- public boolean getTcpNoDelay()
public void setTcpNoDelay(boolean tcpNoDelay)
tcpNoDelay
- public java.lang.String getSshHostname()
public void setSshHostname(java.lang.String host)
host
- the SSH hostnamepublic int getSshPort()
public void setSshPort(int port)
port
- the SSH portpublic long getConnectionTimeout()
public void setConnectionTimeout(long value)
value
- connection timeout in millisecondspublic long getReadingTimeout()
public void setReadingTimeout(long value)
value
- reading timeout in millisecondspublic java.lang.String getProxyHost()
public void setProxyHost(java.lang.String proxyHost)
proxyHost
- The proxy hostnamepublic int getProxyPort()
public void setProxyPort(int proxyPort)
proxyPort
- The proxy port.public java.lang.String getProxyUserId()
public void setProxyUserId(java.lang.String proxyUserId)
proxyUserId
- User authentication proxy.public java.lang.String getProxyPassword()
public void setProxyPassword(java.lang.String proxyPassword)
proxyPassword
- Initializes the proxy authentication password.public java.lang.String getProxyType()
public void setProxyType(java.lang.String proxyType)
proxyType
- The proxy type.public User getUser()
public void setUser(User user)
user
- a new user valuepublic java.lang.String getSshUsername()
public void setSshUsername(java.lang.String name)
name
- the SSH usernamepublic java.lang.String getSshPassword()
public void setSshPassword(java.lang.String password)
password
- the SSH account password or private key passphrase if public-key authentication is usedpublic java.io.File getPrivateKey()
public void setPrivateKey(java.io.File privateKey)
privateKey
- private key filepublic void setPrivateKey(java.io.File privateKey, java.lang.String filePassword)
privateKey
- private key filefilePassword
- file passwordpublic void setPrivateKey(java.lang.String serializedKeyData)
serializedKeyData
- the serialized key datapublic void setPrivateKey(java.lang.String serializedKeyData, java.lang.String password)
serializedKeyData
- the serialized key datapassword
- the private key passwordpublic java.security.KeyPair getKeyPair()
public void setKeyPair(java.security.KeyPair keyPair)
keyPair
- user key pairpublic HostKeyVerifier getHostKeyVerifier()
public void setHostKeyVerifier(HostKeyVerifier hostKeyVerifier)
hostKeyVerifier
- new host key verifierpublic java.lang.String toString()
toString
in class java.lang.Object
|
Secure FTP Factory | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |