org.kepler.ssh

Class GsiSshExec

java.lang.Object

org.kepler.ssh.RemoteExec

org.kepler.ssh.GsiSshExec

All Implemented Interfaces:

ExecInterface

public class GsiSshExec
extends RemoteExec

This class provides functionality to use an GSISSH session to execute remote commands and to transfer files on a remote machine.

To create a gsissh session the code needs a valid proxy certificate and a valid CA certificate/ trusted certificate for the server. The code searches for the proxy certificates and CA certificates at default locations based on the specifications of underlying jglobus package -- http://www-unix.globus.org/cog/distribution/1.6.0/docs/configuring.html By default it looks for proxy certificates in the system's temp directory and for CA certificates(trusted certificates) in ${user.home}/.globus/certificates and /etc/grid-security/certificates. You can alter the default file and search path by creating appropriate entries in $HOME/.globus/cog.properties. Please refer to http://www-unix.globus.org/cog/distribution/1.6.0/docs/configuring.html for more configuration details.

You can create several sessions to different sites and use any of them referring to it with its user@host:port. If port is not specified defaults to 2222. Once instantiated the GsiSsh object can be used by anyone anytime to copy file or execute commands without authenticating again.

Author:

Chandrika Sivaramakrishnan This uses a modified code of the open source product GSI-SSHTerm. http://www.ngs.ac.uk/tools/gsisshterm Since GSI-SSHTerm is a terminal product most of the error scenarios and user interaction scenarios are handled using GUI popups. This part of the GSI-SSHTerm code hasn't been modified and hence this code will fail when user interaction are to be handled through command prompt. For example, when kepler is run without gui. In such cases use this with an existing valid proxy certificate

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sshtools.j2ssh.configuration.SshConnectionProperties	connectionProfile
protected com.sshtools.j2ssh.SshClient	sshClient

Constructor Summary

Constructors

Constructor and Description
GsiSshExec(java.lang.String target)
GsiSshExec(java.lang.String user, java.lang.String host)
GsiSshExec(java.lang.String user, java.lang.String host, int port)

Method Summary

Modifier and Type	Method and Description
protected int	_copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copy _one_ local file to a remote directory Input: file of type File (which can be a directory) Input must not have wildcards. targetPath is either a directory or filename
void	addIdentity(java.lang.String identity) addIdentity, useless for local exec
boolean	authenticate(boolean externalkeyx)
void	closeConnection()
int	copyFrom(java.lang.String sourcePath, java.io.File localPath, boolean recursive) Copy a local/remote file into a local file Input: 'sourcePath' of type String (can be a directory or filename) 'localPath' is either a directory or filename Only if 'recursive' is set, will directories copied recursively.
int	executeCmd(java.lang.String command, java.io.OutputStream streamOut, java.io.OutputStream streamErr) Execute a command externally.
int	executeCmd(java.lang.String command, java.io.OutputStream streamOut, java.io.OutputStream streamErr, java.lang.String thirdPartyTarget) Execute a command externally where the command connects to a third party and needs to authenticate to that third party.
java.util.List	getAvailableAuthMethods()
boolean	getForcedCleanUp()
int	getTimeout()
boolean	openConnection()
boolean	openConnection(boolean authenticate)
void	setForcedCleanUp(boolean forcedCleanUp) Specify if killing of external processes (i.e. clean-up) after error or timeout is required.
void	setPortForwardingL(java.lang.String spec) port forwarding not working on local exec
void	setPortForwardingR(java.lang.String spec) port forwarding not working on local exec
void	setTimeout(int seconds) Set timeout for the operations.
void	setTimeout(int seconds, boolean stdout, boolean stderr) Set timeout for the operations.

Methods inherited from class org.kepler.ssh.RemoteExec

copyFrom, copyTo, copyTo, createDir, deleteFile, kill

Methods inherited from class java.lang.Object

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

Field Detail

sshClient

protected com.sshtools.j2ssh.SshClient sshClient

connectionProfile

protected com.sshtools.j2ssh.configuration.SshConnectionProperties connectionProfile

Constructor Detail

GsiSshExec

public GsiSshExec(java.lang.String user,
                  java.lang.String host)

GsiSshExec

public GsiSshExec(java.lang.String user,
                  java.lang.String host,
                  int port)

GsiSshExec

public GsiSshExec(java.lang.String target)

Method Detail

copyFrom

public int copyFrom(java.lang.String sourcePath,
                    java.io.File localPath,
                    boolean recursive)
             throws SshException

Description copied from interface: ExecInterface

Copy a local/remote file into a local file Input: 'sourcePath' of type String (can be a directory or filename) 'localPath' is either a directory or filename Only if 'recursive' is set, will directories copied recursively.

Specified by:

copyFrom in interface ExecInterface

Specified by:

copyFrom in class RemoteExec

Returns:

number of files copied successfully (i.e either returns true or an exception is raised)

Throws:

SshException

_copyTo

protected int _copyTo(java.io.File lfile,
                      java.lang.String targetPath,
                      boolean recursive)
               throws SshException

Copy _one_ local file to a remote directory Input: file of type File (which can be a directory) Input must not have wildcards. targetPath is either a directory or filename

Specified by:

_copyTo in class RemoteExec

Returns:

number of files copied successfully SshException is thrown in case of error.

Throws:

SshException

executeCmd

public int executeCmd(java.lang.String command,
                      java.io.OutputStream streamOut,
                      java.io.OutputStream streamErr)
               throws ExecException

Description copied from interface: ExecInterface

Execute a command externally. The streams streamOut and streamErr should be provided to get the output and errors.

Returns:

exit code of command if execution succeeded, throws ExecException, which can also be an instance of ExecTimeoutException

Throws:

ExecException

executeCmd

public int executeCmd(java.lang.String command,
                      java.io.OutputStream streamOut,
                      java.io.OutputStream streamErr,
                      java.lang.String thirdPartyTarget)
               throws ExecException

Description copied from interface: ExecInterface

Execute a command externally where the command connects to a third party and needs to authenticate to that third party. The streams streamOut should be provided to get the output and errors (merged together in case of remote targets).

Returns:

exit code of command if execution succeeded, throws ExecException, which can also be an instance of ExecTimeoutException

Throws:

ExecException

getAvailableAuthMethods

public java.util.List getAvailableAuthMethods()
                                       throws SshException

Throws:

SshException

openConnection

public boolean openConnection()
                       throws SshException

Specified by:

openConnection in interface ExecInterface

Specified by:

openConnection in class RemoteExec

Throws:

SshException

openConnection

public boolean openConnection(boolean authenticate)
                       throws SshException

Throws:

SshException

authenticate

public boolean authenticate(boolean externalkeyx)
                     throws SshException

Throws:

SshException

closeConnection

public void closeConnection()

Specified by:

closeConnection in interface ExecInterface

Specified by:

closeConnection in class RemoteExec

setForcedCleanUp

public void setForcedCleanUp(boolean forcedCleanUp)

Description copied from interface: ExecInterface

Specify if killing of external processes (i.e. clean-up) after error or timeout is required. Not implemented for local execution. Use only if you are connecting to a unix machine.

setTimeout

public void setTimeout(int seconds,
                       boolean stdout,
                       boolean stderr)

Description copied from interface: ExecInterface

Set timeout for the operations. Timeout should be given in seconds. If 'stdout' is set to true, the timer is restarted whenever there is data on stdout. If 'stderr' is set to true, the timer is restarted whenever there is data on stderr. An operation will throw an ExecException, an instance of ExecTimeoutException if the timeout limit is reached. 'seconds' = 0 means no timeout at all.

addIdentity

public void addIdentity(java.lang.String identity)

addIdentity, useless for local exec

setPortForwardingL

public void setPortForwardingL(java.lang.String spec)
                        throws ExecException

port forwarding not working on local exec

Throws:

ExecException

setPortForwardingR

public void setPortForwardingR(java.lang.String spec)
                        throws ExecException

port forwarding not working on local exec

Throws:

ExecException

getForcedCleanUp

public boolean getForcedCleanUp()

Specified by:

getForcedCleanUp in class RemoteExec

getTimeout

public int getTimeout()

Specified by:

getTimeout in class RemoteExec

setTimeout

public void setTimeout(int seconds)

Description copied from interface: ExecInterface

Set timeout for the operations.