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

Methods

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	createDirectory(String remotDirectoryPath) 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()
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

createTunnel

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

Creates a tunnel.

Parameters:

tunnelHost -

tunnelPort -

tunnelUserName -

tunnelPrivateKeyFilePath -

localPort -

Throws:

SSHClientException

createTunnel

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

Creates a tunnel.

Parameters:

tunnelHost -

tunnelPort -

tunnelUserName -

tunnelPrivateKeyFilePath -

localPort -

localRange -

Throws:

SSHClientException

disconnect

public void disconnect()

Disconnect the client and its tunnel.

isConnected

public boolean isConnected()

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

remove

public void remove(String remotePath)
            throws IOException

Removes a remote file or directory.

Parameters:

remotePath - the remote absolute path

Throws:

IOException

createDirectory

public void createDirectory(String remotDirectoryPath)
                     throws IOException

Creates a remote directory.

Parameters:

remotDirectoryPath - the remote directory absolute path

Throws:

IOException

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

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

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

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 filesnames and theirs modification timestamp

Throws:

IOException

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 filenames and theirs modification timestamp

Throws:

IOException

isTunneled

public boolean isTunneled()

Checks if the client is using a tunnel.