csbase.sshclient

Class SSHClient

java.lang.Object

csbase.sshclient.SSHClient

public class SSHClient
extends Object

A SSHClient with operations to upload/download files, execute remote commands and list the contents of a directory.

This client has support to tunneled connections.

Example of use:

 SSHClient sshClient = new SSHClient(sshHost, sshPort);
 sshClient.connect(sshUserName, sshUserPrivKey);
 

With tunnel:

 SSHClient sshClient = new SSHClient(sshHost, sshPort);
 sshClient.createTunnel(...);
 sshClient.connect(sshUserName, sshUserPrivKey);
 

To close the connections use the disconnect() method.

Author:

Tecgraf/PUC-Rio

Constructor Summary

Constructors

Constructor and Description
SSHClient(String host, int port) Constructor.

Method Summary

Modifier and Type	Method and Description
void	connect(String userName, String privateKeyFilePath) Connects to the remote host using a username and a private key for authentication
void	connect(String userName, String privateKeyFilePath, int timeOut) Connects to the remote host using a username and a private key for authentication.
void	connectByPassword(String userName, String password) Connects to the remote host using a username and a password for authentication
void	connectByPassword(String userName, String password, int timeOut) Connects to the remote host using a username and a password for authentication
void	createDirectory(String remoteDirectoryPath) Creates a remote directory.
void	createTunnel(String tunnelHost, int tunnelPort, String tunnelUserName, String tunnelPrivateKeyFilePath, int localPort) Creates a tunnel.
void	createTunnel(String tunnelHost, int tunnelPort, String tunnelUserName, String tunnelPrivateKeyFilePath, int localPort, int localRange) Creates a tunnel.
void	disconnect() Disconnect the client and its tunnel.
void	download(String localFilePath, String remoteFilePath) Downloads a remote file or directory.
CommandResult	execute(String command) Executes a command in the remote server.
boolean	isConnected() Check if the client has a active connection.
boolean	isTunneled() Checks if the client is using a tunnel.
Map<String,Long>	listFiles(String remotePath) Lists files with theirs modification timestamp from a remote path.
Map<String,Long>	listFilesAndDirectories(String remotePath) Lists files and directories with theirs modification timestamp from a remote path.
void	remove(String remotePath) Removes a remote file or directory.
boolean	stat(String remotePath) Verifies the existence of a remote file or directory.
void	upload(String localFilePath, String remoteFilePath) Uploads a local file or directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHClient

public SSHClient(String host,
                 int port)

Constructor.

Parameters:

host - remote host

port - remote port

Method Detail

connect

public void connect(String userName,
                    String privateKeyFilePath)
             throws SSHClientException

Connects to the remote host using a username and a private key for authentication

Parameters:

userName - the username

privateKeyFilePath - private key path

Throws:

SSHClientException - error while connecting

connect

public void connect(String userName,
                    String privateKeyFilePath,
                    int timeOut)
             throws SSHClientException

Connects to the remote host using a username and a private key for authentication.

Parameters:

userName - the username

privateKeyFilePath - private key path

timeOut - time out

Throws:

SSHClientException - error while connecting

connectByPassword

public void connectByPassword(String userName,
                              String password)
                       throws SSHClientException

Connects to the remote host using a username and a password for authentication

Parameters:

userName - the username

password - the password

Throws:

SSHClientException - error while connecting

connectByPassword

public void connectByPassword(String userName,
                              String password,
                              int timeOut)
                       throws SSHClientException

Connects to the remote host using a username and a password for authentication

Parameters:

userName - the username

password - the password

timeOut - time out

Throws:

SSHClientException - error while connecting

createTunnel

public void createTunnel(String tunnelHost,
                         int tunnelPort,
                         String tunnelUserName,
                         String tunnelPrivateKeyFilePath,
                         int localPort)
                  throws SSHClientException

Creates a tunnel.

Parameters:

tunnelHost - tunnel host

tunnelPort - tunnel port

tunnelUserName - tunnel user name

tunnelPrivateKeyFilePath - tunnel private key path

localPort - tunnel local port

Throws:

SSHClientException - In case of error creating the tunnel

createTunnel

public void createTunnel(String tunnelHost,
                         int tunnelPort,
                         String tunnelUserName,
                         String tunnelPrivateKeyFilePath,
                         int localPort,
                         int localRange)
                  throws SSHClientException

Creates a tunnel.

Parameters:

tunnelHost - tunnel host

tunnelPort - tunnel port

tunnelUserName - tunnel user name

tunnelPrivateKeyFilePath - tunnel private key path

localPort - tunnel local port

localRange - tunnel local port range

Throws:

SSHClientException - In case of error creating the tunnel

disconnect

public void disconnect()

Disconnect the client and its tunnel.

isConnected

public boolean isConnected()

Check if the client has a active connection.

Returns:

true if the connection is active and false otherwise.

execute

public CommandResult execute(String command)
                      throws IOException

Executes a command in the remote server.

Parameters:

command - the command

Returns:

the command's result

Throws:

IOException - Error while reading the command output

remove

public void remove(String remotePath)
            throws IOException

Removes a remote file or directory.

Parameters:

remotePath - the remote absolute path

Throws:

IOException - Error while removing file or directory

createDirectory

public void createDirectory(String remoteDirectoryPath)
                     throws IOException

Creates a remote directory.

Parameters:

remoteDirectoryPath - the remote directory absolute path

Throws:

IOException - Error while creating the directory

stat

public boolean stat(String remotePath)
             throws IOException

Verifies the existence of a remote file or directory.

Parameters:

remotePath - the remote absolute path

Returns:

true if the remote path exists and false otherwise

Throws:

IOException - Error while checking the existence of the file or directory

download

public void download(String localFilePath,
                     String remoteFilePath)
              throws IOException

Downloads a remote file or directory.

Parameters:

localFilePath - the local absolute path

remoteFilePath - the remote absolute path

Throws:

IOException - Error downloading the file or directory

upload

public void upload(String localFilePath,
                   String remoteFilePath)
            throws IOException

Uploads a local file or directory.

Parameters:

localFilePath - the local absolute path

remoteFilePath - the remote absolute path

Throws:

IOException - Error uploading the file or directory

listFiles

public Map<String,Long> listFiles(String remotePath)
                           throws IOException

Lists files with theirs modification timestamp from a remote path.

Parameters:

remotePath - the remote path

Returns:

a map with the files' names and theirs modification timestamp

Throws:

IOException - Error while reading the remote file

listFilesAndDirectories

public Map<String,Long> listFilesAndDirectories(String remotePath)
                                         throws IOException

Lists files and directories with theirs modification timestamp from a remote path.

Parameters:

remotePath - the remote path

Returns:

a map with the files' names and theirs modification timestamp

Throws:

IOException - Error while reading the remote file

isTunneled

public boolean isTunneled()

Checks if the client is using a tunnel.

Returns:

true if a tunnel is active and false otherwise