org.molgenis.util

Class Ssh

java.lang.Object

org.molgenis.util.Ssh

public class Ssh
extends Object

Wrapper arround ssh. Build on top of http://www.cleondris.ch/opensource/ssh2/javadoc/ (BSD type license) http://www.ganymed.ethz.ch/ssh2/FAQ.html

Constructor Summary

Constructors

Constructor and Description
Ssh(String host, String user, String password)
Ssh(String host, String user, String password, int port)
Ssh(String host, String user, String password, int port, String forwardHost, String forwardUser, String forwardPassword, int forwardPort)

Method Summary

Modifier and Type	Method and Description
void	close()
String	downloadFile(String remoteFile)
void	downloadFile(String remoteFile, File localFile) Download remote file to local file via scp
String	downloadFileIntoString(String remoteFile)
SshResult	executeCommand(String command)
SshResult	executeCommand(String command, int timeout) Execute one command and wait for the result to return
protected void	finalize()
void	forward(int local_port, String host_to_connect, int port_to_connect)
String	getHost()
String	getPassword()
int	getPort()
String	getUsername()
void	setHost(String host)
void	setPassword(String password)
void	setPort(int port)
void	setUsername(String username)
void	uploadFile(File localFile, String remoteFile) Download remote file to local file via scp
void	uploadStringToFile(String string, String remoteFile) Upload string to remote file.
void	uploadStringToFile(String string, String remoteFile, String remoteDir) Upload a string using scp, with seperate directory and file parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ssh

public Ssh(String host,
           String user,
           String password)
    throws IOException

Throws:

IOException

Ssh

public Ssh(String host,
           String user,
           String password,
           int port)
    throws IOException

Throws:

IOException

Ssh

public Ssh(String host,
           String user,
           String password,
           int port,
           String forwardHost,
           String forwardUser,
           String forwardPassword,
           int forwardPort)
    throws IOException

Throws:

IOException

Method Detail

forward

public void forward(int local_port,
                    String host_to_connect,
                    int port_to_connect)
             throws IOException

Throws:

IOException

executeCommand

public SshResult executeCommand(String command)
                         throws IOException

Throws:

IOException

executeCommand

public SshResult executeCommand(String command,
                                int timeout)
                         throws IOException

Execute one command and wait for the result to return

Throws:

IOException

close

public void close()

uploadFile

public void uploadFile(File localFile,
                       String remoteFile)
                throws IOException

Download remote file to local file via scp

Throws:

IOException

uploadStringToFile

public void uploadStringToFile(String string,
                               String remoteFile)
                        throws IOException

Upload string to remote file.

Parameters:

string - to upload

remoteFile - full path including directories

Throws:

IOException

uploadStringToFile

public void uploadStringToFile(String string,
                               String remoteFile,
                               String remoteDir)
                        throws IOException

Upload a string using scp, with seperate directory and file parameters.

Parameters:

string - to upload

remoteFile - only the file name

remoteDir - path to the directory

Throws:

IOException

downloadFile

public void downloadFile(String remoteFile,
                         File localFile)
                  throws IOException

Download remote file to local file via scp

Parameters:

remoteFile -

localFile -

Throws:

IOException

downloadFileIntoString

public String downloadFileIntoString(String remoteFile)
                              throws IOException

Throws:

IOException

finalize

protected void finalize()

Overrides:

finalize in class Object

getHost

public String getHost()

setHost

public void setHost(String host)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public int getPort()

setPort

public void setPort(int port)

downloadFile

public String downloadFile(String remoteFile)
                    throws IOException

Throws:

IOException