com.sshtools.client

Class SshClient

java.lang.Object

com.sshtools.client.SshClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SshClient
extends java.lang.Object
implements java.io.Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXIT_CODE_NOT_RECEIVED

Constructor Summary

Constructors

Constructor and Description
SshClient(SshConnection con)
SshClient(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, 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, 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, SshKeyPair... identities)
SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, long connectTimeout, char[] password, SshKeyPair... identities)
SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, long connectTimeout, SshKeyPair... identities)
SshClient(java.lang.String hostname, int port, java.lang.String username, SshClientContext sshContext, SshKeyPair... identities)
SshClient(java.lang.String hostname, int port, java.lang.String username, SshKeyPair... identities)

Method Summary

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> T	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)
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()
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)
ForwardingPolicy	getForwardingPolicy()
java.lang.String	getHost()
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> void	runTask(T task)
<T extends Task> void	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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXIT_CODE_NOT_RECEIVED

public static final int EXIT_CODE_NOT_RECEIVED

See Also:

Constant Field Values

Constructor Detail

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 long connectTimeout,
                 char[] password)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 char[] password)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 long connectTimeout,
                 java.io.File key)
          throws java.io.IOException,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 java.io.File key)
          throws java.io.IOException,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

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,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 java.io.File key,
                 java.lang.String passphrase)
          throws java.io.IOException,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 long connectTimeout,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 SshClientContext sshContext,
                 long connectTimeout,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 SshClientContext sshContext,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 long connectTimeout,
                 char[] password,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 char[] password,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

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,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

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,
                 SshException,
                 InvalidPassphraseException

Throws:

java.io.IOException

SshException

InvalidPassphraseException

SshClient

public SshClient(java.lang.String hostname,
                 java.lang.Integer port,
                 java.lang.String username,
                 long connectTimeout)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 java.lang.Integer port,
                 java.lang.String username)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 java.lang.Integer port,
                 java.lang.String username,
                 SshClientContext sshContext,
                 long connectTimeout)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(java.lang.String hostname,
                 java.lang.Integer port,
                 java.lang.String username,
                 SshClientContext sshContext)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

SshClient

public SshClient(SshConnection con)

SshClient

public SshClient(SshConnection con,
                 boolean closeConnection)

SshClient

public SshClient(java.lang.String hostname,
                 int port,
                 java.lang.String username,
                 SshClientContext sshContext,
                 long connectTimeout,
                 char[] password,
                 SshKeyPair... identities)
          throws java.io.IOException,
                 SshException

Throws:

java.io.IOException

SshException

Method Detail

doConnect

protected void doConnect(java.lang.String hostname,
                         int port,
                         java.lang.String username,
                         SshClientContext sshContext,
                         long connectTimeout)
                  throws SshException,
                         java.io.IOException

Throws:

SshException

java.io.IOException

configure

protected void configure(SshClientContext sshContext)
                  throws SshException,
                         java.io.IOException

Throws:

SshException

java.io.IOException

addTask

public void addTask(Task task)
             throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getContext

public SshClientContext getContext()

getConnection

public Connection<SshClientContext> getConnection()

getForwardingPolicy

public ForwardingPolicy getForwardingPolicy()

startLocalForwarding

public int startLocalForwarding(java.lang.String addressToBind,
                                int portToBind,
                                java.lang.String destinationHost,
                                int destinationPort)
                         throws UnauthorizedException,
                                SshException

Throws:

UnauthorizedException

SshException

stopLocalForwarding

public void stopLocalForwarding(java.lang.String addressToBind,
                                int portToBind)

stopLocalForwarding

public void stopLocalForwarding()

startRemoteForwarding

public int startRemoteForwarding(java.lang.String addressToBind,
                                 int portToBind,
                                 java.lang.String destinationHost,
                                 int destinationPort)
                          throws SshException

Throws:

SshException

stopRemoteForwarding

public void stopRemoteForwarding(java.lang.String addressToBind,
                                 int portToBind)
                          throws SshException

Throws:

SshException

stopRemoteForwarding

public void stopRemoteForwarding()

isConnected

public boolean isConnected()

disconnect

public void disconnect()

doTask

protected <T extends Task> T doTask(T task,
                                    long timeout)
                             throws java.io.IOException

Throws:

java.io.IOException

getFile

public java.io.File getFile(java.lang.String path)
                     throws java.io.IOException

Throws:

java.io.IOException

getFile

public java.io.File getFile(java.lang.String path,
                            long timeout)
                     throws java.io.IOException

Throws:

java.io.IOException

getFile

public void getFile(java.lang.String path,
                    java.io.File destination)
             throws java.io.IOException

Throws:

java.io.IOException

getFile

public void getFile(java.lang.String path,
                    java.io.File destination,
                    long timeout)
             throws java.io.IOException

Throws:

java.io.IOException

putFile

public void putFile(java.io.File file)
             throws java.io.IOException

Throws:

java.io.IOException

putFile

public void putFile(java.io.File file,
                    java.lang.String path)
             throws java.io.IOException

Throws:

java.io.IOException

putFile

public void putFile(java.io.File file,
                    java.lang.String path,
                    long timeout)
             throws java.io.IOException

Throws:

java.io.IOException

executeCommand

public java.lang.String executeCommand(java.lang.String cmd)
                                throws java.io.IOException

Throws:

java.io.IOException

executeCommand

public java.lang.String executeCommand(java.lang.String cmd,
                                       long timeout)
                                throws java.io.IOException

Throws:

java.io.IOException

executeCommand

public java.lang.String executeCommand(java.lang.String cmd,
                                       java.lang.String charset)
                                throws java.io.IOException

Throws:

java.io.IOException

executeCommand

public java.lang.String executeCommand(java.lang.String cmd,
                                       long timeout,
                                       java.lang.String charset)
                                throws java.io.IOException

Throws:

java.io.IOException

executeCommandWithResult

public int executeCommandWithResult(java.lang.String cmd,
                                    java.lang.StringBuffer buffer)
                             throws java.io.IOException

Throws:

java.io.IOException

executeCommandWithResult

public int executeCommandWithResult(java.lang.String cmd)
                             throws java.io.IOException

Throws:

java.io.IOException

executeCommandWithResult

public int executeCommandWithResult(java.lang.String cmd,
                                    java.lang.StringBuffer buffer,
                                    long timeout)
                             throws java.io.IOException

Throws:

java.io.IOException

executeCommandWithResult

public int executeCommandWithResult(java.lang.String cmd,
                                    java.lang.StringBuffer buffer,
                                    java.lang.String charset)
                             throws java.io.IOException

Throws:

java.io.IOException

executeCommandWithResult

public int executeCommandWithResult(java.lang.String cmd,
                                    java.lang.StringBuffer buffer,
                                    long timeout,
                                    java.lang.String charset)
                             throws java.io.IOException

Throws:

java.io.IOException

getAuthenticationMethods

public java.util.Set<java.lang.String> getAuthenticationMethods()

authenticate

public boolean authenticate(ClientAuthenticator authenticator,
                            long timeout)
                     throws java.io.IOException,
                            SshException

Throws:

java.io.IOException

SshException

isAuthenticated

public boolean isAuthenticated()

runTask

public <T extends Task> void runTask(T task,
                                     long timeout)
                              throws java.io.IOException

Throws:

java.io.IOException

runTask

public <T extends Task> void runTask(T task)
                              throws java.io.IOException

Throws:

java.io.IOException

getRemotePublicKeys

public java.lang.String[] getRemotePublicKeys()

getRemoteIdentification

public java.lang.String getRemoteIdentification()

getLocalIdentification

public java.lang.String getLocalIdentification()

getHost

public java.lang.String getHost()

getHostKey

public SshPublicKey getHostKey()

openSessionChannel

public SessionChannelNG openSessionChannel()
                                    throws SshException

Throws:

SshException

openSessionChannel

public SessionChannelNG openSessionChannel(long timeout)
                                    throws SshException

Throws:

SshException

openSessionChannel

public SessionChannelNG openSessionChannel(boolean autoConsume)
                                    throws SshException

Throws:

SshException

openSessionChannel

public SessionChannelNG openSessionChannel(long timeout,
                                           boolean autoConsume)
                                    throws SshException

Throws:

SshException