Package com.sshtools.client

Class SshClient

java.lang.Object

com.sshtools.client.SshClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class SshClient
extends Object
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SshClient.OnConfiguration
static final class	SshClient.PreConnectedSshClientBuilder
static final class	SshClient.SshClientBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_CONNECT_TIMEOUT
static final String	GUEST_USERNAME

Constructor Summary

Constructors

Constructor	Description
SshClient(SshConnection con)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(SshConnection con, boolean closeConnection)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, char[] password)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, char[] password, SshClientContext context)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, char[] password, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, long connectTimeout, char[] password)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, long connectTimeout, char[] password, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, long connectTimeout, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, long connectTimeout, File key)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, long connectTimeout, File key, String passphrase)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, SshClientContext sshContext, long connectTimeout, char[] password, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, SshClientContext sshContext, long connectTimeout, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, SshClientContext sshContext, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, SshKeyPair... identities)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, File key)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, int port, String username, File key, String passphrase)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username, char[] password, File key, String passphrase)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username, long connectTimeout)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username, long connectTimeout, char[] password, File key, String passphrase)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username, SshClientContext sshContext)	Deprecated, for removal: This API element is subject to removal in a future version.
SshClient(String hostname, Integer port, String username, SshClientContext sshContext, long connectTimeout)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
Task	addTask(Task task)
boolean	authenticate(ClientAuthenticator authenticator, long timeout)
void	close()
protected void	configure(SshClientContext sshContext)	Deprecated, for removal: This API element is subject to removal in a future version.
void	disconnect()
protected final Connection<SshClientContext>	doConnect(String hostname, int port, SshClientContext sshContext, long connectTimeout, List<String> keys)
protected <T extends Task> T	doTask(T task, long timeout)
String	executeCommand(String cmd)
String	executeCommand(String cmd, long timeout)
String	executeCommand(String cmd, long timeout, String charset)
String	executeCommand(String cmd, String charset)
int	executeCommandWithResult(String cmd)
int	executeCommandWithResult(String cmd, StringBuffer buffer)
int	executeCommandWithResult(String cmd, StringBuffer buffer, long timeout)
int	executeCommandWithResult(String cmd, StringBuffer buffer, long timeout, String charset)
int	executeCommandWithResult(String cmd, StringBuffer buffer, String charset)
Set<String>	getAuthenticationMethods()
Connection<SshClientContext>	getConnection()
SshClientContext	getContext()
File	getFile(String path)
File	getFile(String path, long timeout)
void	getFile(String path, File destination)
void	getFile(String path, File destination, long timeout)
ForwardingPolicy	getForwardingPolicy()
String	getHost()
SshPublicKey	getHostKey()
String	getLocalIdentification()
int	getPort()
String	getRemoteIdentification()
String[]	getRemotePublicKeys()
boolean	isAuthenticated()
boolean	isConnected()
static void	main(String[] args)
SshClient	openRemoteClient(String hostname, int port, String username)
SessionChannelNG	openSessionChannel()
SessionChannelNG	openSessionChannel(boolean autoConsume)
SessionChannelNG	openSessionChannel(long timeout)
SessionChannelNG	openSessionChannel(long timeout, boolean autoConsume)
void	putFile(File file)
void	putFile(File file, String path)
void	putFile(File file, String path, long timeout)
<T extends Task> void	runTask(T task)
<T extends Task> void	runTask(T task, long timeout)
int	startLocalForwarding(String addressToBind, int portToBind, String destinationHost, int destinationPort)
int	startLocalForwarding(String addressToBind, String destinationHost)
int	startRemoteForwarding(String addressToBind, int portToBind, String destinationHost, int destinationPort)
int	startRemoteForwarding(String addressToBind, String destinationHost)
void	stopLocalForwarding()
void	stopLocalForwarding(String addressToBind, int portToBind)
void	stopRemoteForwarding()
void	stopRemoteForwarding(String addressToBind, int portToBind)

Methods inherited from class java.lang.Object

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

Field Details

GUEST_USERNAME

public static final String GUEST_USERNAME

DEFAULT_CONNECT_TIMEOUT

public static final long DEFAULT_CONNECT_TIMEOUT

Constructor Details

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 long connectTimeout,
 char[] password)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

password - password

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 char[] password)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

password - password

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 char[] password,
 SshClientContext context)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

password - password

sshContext - context

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 long connectTimeout,
 File key)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

key - key file

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 File key)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

key - key file

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 long connectTimeout,
 File key,
 String passphrase)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

key - key file

passphrase - key passphrase

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 File key,
 String passphrase)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

key - key file

passphrase - key passphrase

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 long connectTimeout,
 SshKeyPair... identities)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 SshKeyPair... identities)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 SshClientContext sshContext,
 long connectTimeout,
 SshKeyPair... identities)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

connectTimeout - timeout

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 SshClientContext sshContext,
 SshKeyPair... identities)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 long connectTimeout,
 char[] password,
 SshKeyPair... identities)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

password - password

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 char[] password,
 SshKeyPair... identities)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

password - password

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username,
 long connectTimeout,
 char[] password,
 File key,
 String passphrase)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

password - password

key - key file

passphrase - key passphrase

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username,
 char[] password,
 File key,
 String passphrase)
          throws IOException,
SshException,
InvalidPassphraseException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

password - password

key - key

passphrase - passphrase

Throws:

IOException - on I/O error

SshException - on general SSH error

InvalidPassphraseException

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username,
 long connectTimeout)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

connectTimeout - timeout

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username,
 SshClientContext sshContext,
 long connectTimeout)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

connectTimeout - timeout

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 Integer port,
 String username,
 SshClientContext sshContext)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(SshConnection con)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

connectTimeout - timeout

password - password

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(SshConnection con,
 boolean closeConnection)

Deprecated, for removal: This API element is subject to removal in a future version.

SshClient

@Deprecated(since="3.1.0",
            forRemoval=true)
public SshClient(String hostname,
 int port,
 String username,
 SshClientContext sshContext,
 long connectTimeout,
 char[] password,
 SshKeyPair... identities)
          throws IOException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new client.

Parameters:

hostname - host

port - port

username - user

sshContext - context

connectTimeout - timeout

password - password

identities - identities

Throws:

IOException - on I/O error

SshException - on general SSH error

See Also:

• SshClient.SshClientBuilder

Method Details

doConnect

protected final Connection<SshClientContext> doConnect(String hostname,
 int port,
 SshClientContext sshContext,
 long connectTimeout,
 List<String> keys)
                                                throws SshException,
IOException

Throws:

SshException

IOException

configure

@Deprecated(since="3.1.0",
            forRemoval=true)
protected void configure(SshClientContext sshContext)
                  throws SshException,
IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Further configuration the client context.

Parameters:

sshContext -

Throws:

SshException

IOException

See Also:

• }.

addTask

public Task addTask(Task task)
             throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getContext

public SshClientContext getContext()

getConnection

public Connection<SshClientContext> getConnection()

getForwardingPolicy

public ForwardingPolicy getForwardingPolicy()

startLocalForwarding

public int startLocalForwarding(String addressToBind,
 String destinationHost)
                         throws UnauthorizedException,
SshException

Throws:

UnauthorizedException

SshException

startLocalForwarding

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

Throws:

UnauthorizedException

SshException

stopLocalForwarding

public void stopLocalForwarding(String addressToBind,
 int portToBind)

stopLocalForwarding

public void stopLocalForwarding()

startRemoteForwarding

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

Throws:

SshException

startRemoteForwarding

public int startRemoteForwarding(String addressToBind,
 String destinationHost)
                          throws SshException

Throws:

SshException

stopRemoteForwarding

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

Throws:

SshException

stopRemoteForwarding

public void stopRemoteForwarding()
                          throws SshException

Throws:

SshException

isConnected

public boolean isConnected()

disconnect

public void disconnect()

doTask

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

Throws:

IOException

getFile

public File getFile(String path)
             throws IOException

Throws:

IOException

getFile

public File getFile(String path,
 long timeout)
             throws IOException

Throws:

IOException

getFile

public void getFile(String path,
 File destination)
             throws IOException

Throws:

IOException

getFile

public void getFile(String path,
 File destination,
 long timeout)
             throws IOException

Throws:

IOException

putFile

public void putFile(File file)
             throws IOException

Throws:

IOException

putFile

public void putFile(File file,
 String path)
             throws IOException

Throws:

IOException

putFile

public void putFile(File file,
 String path,
 long timeout)
             throws IOException

Throws:

IOException

executeCommand

public String executeCommand(String cmd)
                      throws IOException

Throws:

IOException

executeCommand

public String executeCommand(String cmd,
 long timeout)
                      throws IOException

Throws:

IOException

executeCommand

public String executeCommand(String cmd,
 String charset)
                      throws IOException

Throws:

IOException

executeCommand

public String executeCommand(String cmd,
 long timeout,
 String charset)
                      throws IOException

Throws:

IOException

executeCommandWithResult

public int executeCommandWithResult(String cmd,
 StringBuffer buffer)
                             throws IOException

Throws:

IOException

executeCommandWithResult

public int executeCommandWithResult(String cmd)
                             throws IOException

Throws:

IOException

executeCommandWithResult

public int executeCommandWithResult(String cmd,
 StringBuffer buffer,
 long timeout)
                             throws IOException

Throws:

IOException

executeCommandWithResult

public int executeCommandWithResult(String cmd,
 StringBuffer buffer,
 String charset)
                             throws IOException

Throws:

IOException

executeCommandWithResult

public int executeCommandWithResult(String cmd,
 StringBuffer buffer,
 long timeout,
 String charset)
                             throws IOException

Throws:

IOException

getAuthenticationMethods

public Set<String> getAuthenticationMethods()

authenticate

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

Throws:

IOException

SshException

isAuthenticated

public boolean isAuthenticated()

runTask

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

Throws:

IOException

runTask

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

Throws:

IOException

getRemotePublicKeys

public String[] getRemotePublicKeys()

getRemoteIdentification

public String getRemoteIdentification()

getLocalIdentification

public String getLocalIdentification()

getHost

public 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

openRemoteClient

public SshClient openRemoteClient(String hostname,
 int port,
 String username)
                           throws SshException,
IOException,
UnauthorizedException

Throws:

SshException

IOException

UnauthorizedException

getPort

public int getPort()

main

public static void main(String[] args)
                 throws IOException,
SshException

Throws:

IOException

SshException