public class SshClient
extends java.lang.Object
implements java.io.Closeable
Modifier and Type | Field and Description |
---|---|
static int |
EXIT_CODE_NOT_RECEIVED |
Constructor and Description |
---|
SshClient(com.sshtools.common.ssh.SshConnection con) |
SshClient(com.sshtools.common.ssh.SshConnection con,
boolean closeConnection) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username,
char[] password,
java.io.File key,
java.lang.String passphrase) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username,
long connectTimeout) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username,
long connectTimeout,
char[] password,
java.io.File key,
java.lang.String passphrase) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username,
SshClientContext sshContext) |
SshClient(java.lang.String hostname,
java.lang.Integer port,
java.lang.String username,
SshClientContext sshContext,
long connectTimeout) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
char[] password) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
char[] password,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
java.io.File key) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
java.io.File key,
java.lang.String passphrase) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
long connectTimeout,
char[] password) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
long connectTimeout,
char[] password,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
long connectTimeout,
java.io.File key) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
long connectTimeout,
java.io.File key,
java.lang.String passphrase) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
long connectTimeout,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
SshClientContext sshContext,
long connectTimeout,
char[] password,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
SshClientContext sshContext,
long connectTimeout,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
SshClientContext sshContext,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
SshClient(java.lang.String hostname,
int port,
java.lang.String username,
com.sshtools.common.ssh.components.SshKeyPair... identities) |
Modifier and Type | Method and Description |
---|---|
void |
addTask(Task task) |
boolean |
authenticate(ClientAuthenticator authenticator,
long timeout) |
void |
close() |
protected void |
configure(SshClientContext sshContext) |
void |
disconnect() |
protected void |
doConnect(java.lang.String hostname,
int port,
java.lang.String username,
SshClientContext sshContext,
long connectTimeout) |
protected <T extends Task> |
doTask(T task,
long timeout) |
java.lang.String |
executeCommand(java.lang.String cmd) |
java.lang.String |
executeCommand(java.lang.String cmd,
long timeout) |
java.lang.String |
executeCommand(java.lang.String cmd,
long timeout,
java.lang.String charset) |
java.lang.String |
executeCommand(java.lang.String cmd,
java.lang.String charset) |
int |
executeCommandWithResult(java.lang.String cmd,
java.lang.StringBuffer buffer) |
int |
executeCommandWithResult(java.lang.String cmd,
java.lang.StringBuffer buffer,
long timeout) |
int |
executeCommandWithResult(java.lang.String cmd,
java.lang.StringBuffer buffer,
long timeout,
java.lang.String charset) |
int |
executeCommandWithResult(java.lang.String cmd,
java.lang.StringBuffer buffer,
java.lang.String charset) |
java.util.Set<java.lang.String> |
getAuthenticationMethods() |
com.sshtools.synergy.ssh.Connection<SshClientContext> |
getConnection() |
SshClientContext |
getContext() |
java.io.File |
getFile(java.lang.String path) |
void |
getFile(java.lang.String path,
java.io.File destination) |
void |
getFile(java.lang.String path,
java.io.File destination,
long timeout) |
java.io.File |
getFile(java.lang.String path,
long timeout) |
com.sshtools.common.forwarding.ForwardingPolicy |
getForwardingPolicy() |
java.lang.String |
getHost() |
com.sshtools.common.ssh.components.SshPublicKey |
getHostKey() |
java.lang.String |
getLocalIdentification() |
java.lang.String |
getRemoteIdentification() |
java.lang.String[] |
getRemotePublicKeys() |
boolean |
isAuthenticated() |
boolean |
isConnected() |
SessionChannelNG |
openSessionChannel() |
SessionChannelNG |
openSessionChannel(boolean autoConsume) |
SessionChannelNG |
openSessionChannel(long timeout) |
SessionChannelNG |
openSessionChannel(long timeout,
boolean autoConsume) |
void |
putFile(java.io.File file) |
void |
putFile(java.io.File file,
java.lang.String path) |
void |
putFile(java.io.File file,
java.lang.String path,
long timeout) |
<T extends Task> |
runTask(T task) |
<T extends Task> |
runTask(T task,
long timeout) |
int |
startLocalForwarding(java.lang.String addressToBind,
int portToBind,
java.lang.String destinationHost,
int destinationPort) |
int |
startRemoteForwarding(java.lang.String addressToBind,
int portToBind,
java.lang.String destinationHost,
int destinationPort) |
void |
stopLocalForwarding() |
void |
stopLocalForwarding(java.lang.String addressToBind,
int portToBind) |
void |
stopRemoteForwarding() |
void |
stopRemoteForwarding(java.lang.String addressToBind,
int portToBind) |
public static final int EXIT_CODE_NOT_RECEIVED
public SshClient(java.lang.String hostname, int port, java.lang.String username, long connectTimeout, char[] password) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, int port, java.lang.String username, char[] password) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, int port, java.lang.String username, long connectTimeout, java.io.File key) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, java.io.File key) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, long connectTimeout, java.io.File key, java.lang.String passphrase) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, java.io.File key, java.lang.String passphrase) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, long connectTimeout, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, long connectTimeout, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, int port, java.lang.String username, long connectTimeout, char[] password, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, int port, java.lang.String username, char[] password, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username, long connectTimeout, char[] password, java.io.File key, java.lang.String passphrase) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username, char[] password, java.io.File key, java.lang.String passphrase) throws java.io.IOException, com.sshtools.common.ssh.SshException, com.sshtools.common.publickey.InvalidPassphraseException
java.io.IOException
com.sshtools.common.ssh.SshException
com.sshtools.common.publickey.InvalidPassphraseException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username, long connectTimeout) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username, SshClientContext sshContext, long connectTimeout) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(java.lang.String hostname, java.lang.Integer port, java.lang.String username, SshClientContext sshContext) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public SshClient(com.sshtools.common.ssh.SshConnection con)
public SshClient(com.sshtools.common.ssh.SshConnection con, boolean closeConnection)
public SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, long connectTimeout, char[] password, com.sshtools.common.ssh.components.SshKeyPair... identities) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
protected void doConnect(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, long connectTimeout) throws com.sshtools.common.ssh.SshException, java.io.IOException
com.sshtools.common.ssh.SshException
java.io.IOException
protected void configure(SshClientContext sshContext) throws com.sshtools.common.ssh.SshException, java.io.IOException
com.sshtools.common.ssh.SshException
java.io.IOException
public void addTask(Task task) throws java.io.IOException
java.io.IOException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
java.io.IOException
public SshClientContext getContext()
public com.sshtools.synergy.ssh.Connection<SshClientContext> getConnection()
public com.sshtools.common.forwarding.ForwardingPolicy getForwardingPolicy()
public int startLocalForwarding(java.lang.String addressToBind, int portToBind, java.lang.String destinationHost, int destinationPort) throws com.sshtools.common.permissions.UnauthorizedException, com.sshtools.common.ssh.SshException
com.sshtools.common.permissions.UnauthorizedException
com.sshtools.common.ssh.SshException
public void stopLocalForwarding(java.lang.String addressToBind, int portToBind)
public void stopLocalForwarding()
public int startRemoteForwarding(java.lang.String addressToBind, int portToBind, java.lang.String destinationHost, int destinationPort) throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
public void stopRemoteForwarding(java.lang.String addressToBind, int portToBind) throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
public void stopRemoteForwarding()
public boolean isConnected()
public void disconnect()
protected <T extends Task> T doTask(T task, long timeout) throws java.io.IOException
java.io.IOException
public java.io.File getFile(java.lang.String path) throws java.io.IOException
java.io.IOException
public java.io.File getFile(java.lang.String path, long timeout) throws java.io.IOException
java.io.IOException
public void getFile(java.lang.String path, java.io.File destination) throws java.io.IOException
java.io.IOException
public void getFile(java.lang.String path, java.io.File destination, long timeout) throws java.io.IOException
java.io.IOException
public void putFile(java.io.File file) throws java.io.IOException
java.io.IOException
public void putFile(java.io.File file, java.lang.String path) throws java.io.IOException
java.io.IOException
public void putFile(java.io.File file, java.lang.String path, long timeout) throws java.io.IOException
java.io.IOException
public java.lang.String executeCommand(java.lang.String cmd) throws java.io.IOException
java.io.IOException
public java.lang.String executeCommand(java.lang.String cmd, long timeout) throws java.io.IOException
java.io.IOException
public java.lang.String executeCommand(java.lang.String cmd, java.lang.String charset) throws java.io.IOException
java.io.IOException
public java.lang.String executeCommand(java.lang.String cmd, long timeout, java.lang.String charset) throws java.io.IOException
java.io.IOException
public int executeCommandWithResult(java.lang.String cmd, java.lang.StringBuffer buffer) throws java.io.IOException
java.io.IOException
public int executeCommandWithResult(java.lang.String cmd, java.lang.StringBuffer buffer, long timeout) throws java.io.IOException
java.io.IOException
public int executeCommandWithResult(java.lang.String cmd, java.lang.StringBuffer buffer, java.lang.String charset) throws java.io.IOException
java.io.IOException
public int executeCommandWithResult(java.lang.String cmd, java.lang.StringBuffer buffer, long timeout, java.lang.String charset) throws java.io.IOException
java.io.IOException
public java.util.Set<java.lang.String> getAuthenticationMethods()
public boolean authenticate(ClientAuthenticator authenticator, long timeout) throws java.io.IOException, com.sshtools.common.ssh.SshException
java.io.IOException
com.sshtools.common.ssh.SshException
public boolean isAuthenticated()
public <T extends Task> void runTask(T task, long timeout) throws java.io.IOException
java.io.IOException
public <T extends Task> void runTask(T task) throws java.io.IOException
java.io.IOException
public java.lang.String[] getRemotePublicKeys()
public java.lang.String getRemoteIdentification()
public java.lang.String getLocalIdentification()
public java.lang.String getHost()
public com.sshtools.common.ssh.components.SshPublicKey getHostKey()
public SessionChannelNG openSessionChannel() throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
public SessionChannelNG openSessionChannel(long timeout) throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
public SessionChannelNG openSessionChannel(boolean autoConsume) throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
public SessionChannelNG openSessionChannel(long timeout, boolean autoConsume) throws com.sshtools.common.ssh.SshException
com.sshtools.common.ssh.SshException
Copyright © 2021. All rights reserved.