public class SshParameters
extends java.lang.Object
implements java.io.Serializable
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 and Description |
---|
SshParameters(SshParameters that)
Copy constructor.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.io.File keyFile)
Creates a new SshParameters instance.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.io.File keyFile,
java.lang.String keyFilePassword)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.lang.String password)
Creates a new SshParameters instance.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.lang.String password,
java.io.File keyFile)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.lang.String password,
java.io.File keyFile,
java.lang.String keyFilePassword)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
int port,
java.lang.String username,
java.lang.String password,
java.security.KeyPair keyPair)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
java.lang.String username,
java.io.File keyFile)
Creates a new SshParameters instance.
|
SshParameters(java.lang.String host,
java.lang.String username,
java.io.File keyFile,
java.lang.String keyFilePassword)
Creates a new SshParameters instance.
|
SshParameters(java.lang.String proxyType,
java.lang.String proxyHost,
int proxyPort,
java.lang.String proxyUsername,
java.lang.String proxyPassword,
java.lang.String host,
int port,
long connectionTimeout,
long readingTimeout,
java.lang.Integer socketTrafficClass,
java.lang.Boolean tcpNoDelay,
HostKeyVerificationService hostKeyVerifier,
java.lang.String username,
java.lang.String password,
java.io.File keyFile,
java.lang.String keyFilePassword,
com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm publicKeyAlgorithm,
ClientAuthentication clientAuthentication)
Creates a new parameters instance.
|
SshParameters(java.lang.String proxyType,
java.lang.String proxyHost,
int proxyPort,
java.lang.String proxyUsername,
java.lang.String proxyPassword,
java.lang.String host,
int port,
long connectionTimeout,
long readingTimeout,
java.lang.Integer socketTrafficClass,
java.lang.Boolean tcpNoDelay,
HostKeyVerificationService hostKeyVerifier,
java.lang.String username,
java.lang.String password,
java.security.KeyPair keyPair,
com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm publicKeyAlgorithm,
ClientAuthentication clientAuthentication)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
java.lang.String username,
java.lang.String password)
Creates a new SshParameters instance.
|
SshParameters(java.lang.String host,
java.lang.String username,
java.lang.String password,
java.io.File keyFile)
Creates a new parameters instance.
|
SshParameters(java.lang.String host,
java.lang.String username,
java.lang.String password,
java.security.KeyPair keyPair)
Creates a new parameters instance.
|
Modifier and Type | Method and Description |
---|---|
ClientAuthentication |
getClientAuthentication()
Returns client authentication operation.
|
long |
getConnectionTimeout()
Returns connection timeout in milliseconds.
|
HostKeyVerificationService |
getHostKeyVerifier()
Returns current host key verifier.
|
java.lang.String |
getHostname()
Returns a server host.
|
java.security.KeyPair |
getKeyPair()
Returns user key pair.
|
java.lang.String |
getPassword()
Returns an user password.
|
int |
getPort()
Returns a server port.
|
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()
Deprecated.
use getProxyUsername()
|
java.lang.String |
getProxyUsername()
Returns a proxy username.
|
com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm |
getPublicKeyAlgorithm() |
long |
getReadingTimeout()
Returns reading timeout in milliseconds.
|
java.lang.Integer |
getSocketTrafficClass()
Get socket traffic class
|
java.lang.String |
getSshHostname()
Deprecated.
use getHostname()
|
java.lang.String |
getSshPassword()
Deprecated.
use getPassword()
|
int |
getSshPort()
Deprecated.
use getPort()
|
java.lang.String |
getSshUsername()
Deprecated.
use getUsername()
|
java.lang.Boolean |
getTcpNoDelay()
Get TCP no delay.
|
java.lang.String |
getUsername()
Returns an username.
|
void |
setClientAuthentication(ClientAuthentication value)
Sets client authentication operation.
|
void |
setConnectionTimeout(long value)
Sets connection timeout.
|
void |
setHostKeyVerifier(HostKeyVerificationService hostKeyVerifier)
Setups new host key verifier.
|
void |
setHostname(java.lang.String value)
Sets a server host.
|
void |
setKeyPair(java.security.KeyPair value)
Sets user key pair.
|
void |
setPassword(java.lang.String value)
Sets an user password.
|
void |
setPort(int value)
Sets a server port.
|
void |
setPrivateKey(java.io.File keyFile)
Sets key pair to be used when authenticating with SSH Server.
|
void |
setPrivateKey(java.io.File keyFile,
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 valus)
Sets the proxy hostname.
|
void |
setProxyPassword(java.lang.String value)
Sets the proxy authentication password.
|
void |
setProxyPort(int value)
Sets the proxy port.
|
void |
setProxyType(java.lang.String value)
Sets the proxy type
|
void |
setProxyUserId(java.lang.String value)
Deprecated.
use setProxyUsername()
|
void |
setProxyUsername(java.lang.String value)
Sets a proxy username.
|
void |
setPublicKeyAlgorithm(com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm value) |
void |
setReadingTimeout(long value)
Sets reading timeout.
|
void |
setSocketTrafficClass(java.lang.Integer value)
Set socket traffic class.
|
void |
setSshHostname(java.lang.String value)
Deprecated.
use setHostname()
|
void |
setSshPassword(java.lang.String value)
Deprecated.
use setPassword()
|
void |
setSshPort(int value)
Deprecated.
use setPort()
|
void |
setSshUsername(java.lang.String value)
Deprecated.
use setUsername()
|
void |
setTcpNoDelay(java.lang.Boolean value)
Set TCP no delay.
|
void |
setUsername(java.lang.String value)
Sets an username.
|
java.lang.String |
toString() |
public SshParameters(java.lang.String proxyType, java.lang.String proxyHost, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword, java.lang.String host, int port, long connectionTimeout, long readingTimeout, java.lang.Integer socketTrafficClass, java.lang.Boolean tcpNoDelay, HostKeyVerificationService hostKeyVerifier, java.lang.String username, java.lang.String password, java.security.KeyPair keyPair, com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm publicKeyAlgorithm, ClientAuthentication clientAuthentication)
proxyType
- a proxy typeproxyHost
- a proxy hostproxyPort
- a proxy portproxyUsername
- a proxy usernameproxyPassword
- a proxy passwordhost
- a server hostport
- a server portconnectionTimeout
- a connection timeoutreadingTimeout
- a reading timeoutsocketTrafficClass
- a socket traffic classtcpNoDelay
- a TCP no-delay flaghostKeyVerifier
- a server host key verifierusername
- an usernamepassword
- a passwordkeyPair
- user keysclientAuthentication
- a client authentication operationpublic SshParameters(java.lang.String proxyType, java.lang.String proxyHost, int proxyPort, java.lang.String proxyUsername, java.lang.String proxyPassword, java.lang.String host, int port, long connectionTimeout, long readingTimeout, java.lang.Integer socketTrafficClass, java.lang.Boolean tcpNoDelay, HostKeyVerificationService hostKeyVerifier, java.lang.String username, java.lang.String password, java.io.File keyFile, java.lang.String keyFilePassword, com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm publicKeyAlgorithm, ClientAuthentication clientAuthentication)
proxyType
- a proxy typeproxyHost
- a proxy hostproxyPort
- a proxy portproxyUsername
- a proxy usernameproxyPassword
- a proxy passwordhost
- a a server hostport
- a server portconnectionTimeout
- a connection timeoutreadingTimeout
- a reading timeoutsocketTrafficClass
- a socket traffic classtcpNoDelay
- a TCP no-delay flaghostKeyVerifier
- a server host key verifierusername
- an usernamepassword
- a passwordkeyFile
- a user keys filekeyFilePassword
- a keys file passwordclientAuthentication
- a client authentication operationpublic SshParameters(java.lang.String host, int port, java.lang.String username, java.lang.String password, java.security.KeyPair keyPair)
host
- a server hostport
- a server portusername
- an usernamepassword
- a passwordkeyPair
- user keyspublic SshParameters(java.lang.String host, java.lang.String username, java.lang.String password, java.security.KeyPair keyPair)
host
- a server hostusername
- an usernamepassword
- a passwordkeyPair
- user keyspublic SshParameters(java.lang.String host, int port, java.lang.String username, java.lang.String password, java.io.File keyFile, java.lang.String keyFilePassword)
host
- the SSH server hostnameport
- the SSH server portusername
- the SSH server usernamepassword
- the SSH server passwordkeyFile
- the private key filekeyFilePassword
- the private key passphrasepublic SshParameters(java.lang.String host, int port, java.lang.String username, java.lang.String password, java.io.File keyFile)
host
- a server hostport
- a server portusername
- an usernamepassword
- a passwordkeyFile
- a user keys filepublic SshParameters(java.lang.String host, java.lang.String username, java.lang.String password, java.io.File keyFile)
host
- a server hostusername
- an usernamepassword
- a passwordkeyFile
- a user keys filepublic SshParameters(java.lang.String host, int port, java.lang.String username, java.io.File keyFile, java.lang.String keyFilePassword)
host
- a server hostport
- a server portusername
- an usernamekeyFile
- a user keys filekeyFilePassword
- a keys file passwordpublic SshParameters(java.lang.String host, java.lang.String username, java.io.File keyFile, java.lang.String keyFilePassword)
host
- the SSH server hostnameusername
- the SSH server usernamekeyFilePassword
- the private key passphrasekeyFile
- the private key filepublic SshParameters(java.lang.String host, int port, java.lang.String username, java.io.File keyFile)
host
- the SSH server hostnameport
- the SSH server portusername
- the SSH server usernamekeyFile
- the private key filepublic SshParameters(java.lang.String host, java.lang.String username, java.io.File keyFile)
host
- the SSH server hostnameusername
- the SSH server usernamekeyFile
- the private key filepublic SshParameters(java.lang.String host, int port, java.lang.String username, java.lang.String password)
host
- the SSH server hostnameport
- the SSH server portusername
- the SSH server usernamepassword
- the SSH server passwordpublic SshParameters(java.lang.String host, java.lang.String username, java.lang.String password)
host
- the SSH server hostnameusername
- the SSH server usernamepassword
- the SSH server passwordpublic SshParameters(SshParameters that)
that
- instance to copypublic java.lang.String getProxyType()
public void setProxyType(java.lang.String value)
value
- The proxy type.public java.lang.String getProxyHost()
public void setProxyHost(java.lang.String valus)
valus
- The proxy hostnamepublic int getProxyPort()
public void setProxyPort(int value)
value
- The proxy port.public java.lang.String getProxyUsername()
public void setProxyUsername(java.lang.String value)
value
- a proxy usernamepublic java.lang.String getProxyUserId()
public void setProxyUserId(java.lang.String value)
value
- User authentication proxypublic java.lang.String getProxyPassword()
public void setProxyPassword(java.lang.String value)
value
- Initializes the proxy authentication password.public java.lang.String getHostname()
public void setHostname(java.lang.String value)
value
- a server portpublic java.lang.String getSshHostname()
public void setSshHostname(java.lang.String value)
value
- the SSH hostnamepublic int getPort()
public void setPort(int value)
value
- a server portpublic int getSshPort()
public void setSshPort(int value)
value
- 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.Integer getSocketTrafficClass()
public void setSocketTrafficClass(java.lang.Integer value)
value
- public java.lang.Boolean getTcpNoDelay()
public void setTcpNoDelay(java.lang.Boolean value)
value
- public HostKeyVerificationService getHostKeyVerifier()
public void setHostKeyVerifier(HostKeyVerificationService hostKeyVerifier)
hostKeyVerifier
- new host key verifierpublic java.lang.String getUsername()
public void setUsername(java.lang.String value)
value
- an usernamepublic java.lang.String getSshUsername()
public void setSshUsername(java.lang.String value)
value
- the SSH usernamepublic java.lang.String getPassword()
public void setPassword(java.lang.String value)
value
- a passwordpublic java.lang.String getSshPassword()
public void setSshPassword(java.lang.String value)
value
- the SSH account password or private key passphrase if public-key authentication is usedpublic java.security.KeyPair getKeyPair()
public void setKeyPair(java.security.KeyPair value)
value
- user key pairpublic void setPrivateKey(java.io.File keyFile, java.lang.String filePassword)
keyFile
- private key filefilePassword
- file passwordpublic void setPrivateKey(java.io.File keyFile)
keyFile
- private key filepublic void setPrivateKey(java.lang.String serializedKeyData, java.lang.String password)
serializedKeyData
- the serialized key datapassword
- the private key passwordpublic void setPrivateKey(java.lang.String serializedKeyData)
serializedKeyData
- the serialized key datapublic com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm getPublicKeyAlgorithm()
public void setPublicKeyAlgorithm(com.jscape.inet.ssh.protocol.v2.messages.PublicKeyAlgorithm value)
public ClientAuthentication getClientAuthentication()
public void setClientAuthentication(ClientAuthentication value)
value
- client authentication operationpublic java.lang.String toString()
toString
in class java.lang.Object
Copyright © JSCAPE LLC. 1999-2021. All Rights Reserved