org.kepler.ssh

Interface ExecInterface

All Known Implementing Classes:

GsiSshExec, LocalExec, RemoteExec, SftpExec, SshExec

public interface ExecInterface

This interface defines functionality to execute local/remote commands and to transfer files. It is implemented by LocalExec and RemoteExec classes.

Author:

Norbert Podhorszki

Method Summary

Modifier and Type	Method and Description
void	addIdentity(java.lang.String identity) addIdentity, useless for local exec
void	closeConnection()
int	copyFrom(java.lang.String sourcePath, java.util.Collection files, java.io.File localPath, boolean recursive) Copy files from a local/remote directory to a local path Input: 'files' is a Collection of files of type String (!
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	copyTo(java.util.Collection files, java.lang.String targetPath, boolean recursive) Copy local files to a local/remote directory Input: files is a Collection of files of type File, targetPath is either a directory in case of several files, or it is either a dir or filename in case of one single local file recursive: true if you want traverse directories The files can have wildcards in their names but not in their path.
int	copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copy a local file to a local/remote directory Input: file of type File (which can be a directory) The input can have wildcards in its name but not in its path. targetPath is either a directory or filename
boolean	createDir(java.lang.String dir, boolean parentflag) Create directory.
boolean	deleteFile(java.lang.String fname, boolean recursive, boolean allowFileMask) Delete file or directory on the local/remote site It should be relative to the user's home dir in case of remote machines, or to the current dir in case of local machine, or an absolute path For safety, * and ?
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 thirdParty) Execute a command externally where the command connects to a third party and needs to authenticate to that third party.
boolean	openConnection()
void	setForcedCleanUp(boolean foo) 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.

Method Detail

executeCmd

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

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

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

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

createDir

boolean createDir(java.lang.String dir,
                  boolean parentflag)
           throws ExecException

Create directory. It should be relative to the user's home dir in case of remote machines, or to the current dir in case of local machine, or an absolute path. If parentflag is true, parent directories in the path should be created as well if necessary. Moreover, in this case, if the directory already exists, this method should return true (otherwise it returns an error).

Returns:

true if succeeded

Throws:

ExecException

deleteFile

boolean deleteFile(java.lang.String fname,
                   boolean recursive,
                   boolean allowFileMask)
            throws ExecException

Delete file or directory on the local/remote site It should be relative to the user's home dir in case of remote machines, or to the current dir in case of local machine, or an absolute path For safety, * and ? is allowed in filename string only if explicitely asked with allowFileMask = true If you want to delete a directory, recursive should be set to true

Returns:

true if succeeded

Throws:

ExecException

copyTo

int copyTo(java.util.Collection files,
           java.lang.String targetPath,
           boolean recursive)
    throws ExecException

Copy local files to a local/remote directory Input: files is a Collection of files of type File, targetPath is either a directory in case of several files, or it is either a dir or filename in case of one single local file recursive: true if you want traverse directories The files can have wildcards in their names but not in their path.

Returns:

number of files copied successfully

Throws:

ExecException

copyTo

int copyTo(java.io.File lfile,
           java.lang.String targetPath,
           boolean recursive)
    throws ExecException

Copy a local file to a local/remote directory Input: file of type File (which can be a directory) The input can have wildcards in its name but not in its path. targetPath is either a directory or filename

Returns:

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

Throws:

ExecException

copyFrom

int copyFrom(java.lang.String sourcePath,
             java.util.Collection files,
             java.io.File localPath,
             boolean recursive)
      throws ExecException

Copy files from a local/remote directory to a local path Input: 'files' is a Collection of files of type String (! not like at copyTo !), 'sourcePath' is either empty string (or null) in case the 'files' contain full paths to the individual files, or it should be a directory, and in this case each file name in 'files' will be extended with the directory name before copy. 'localPath' should be a directory name in case of several files. It can be a filename in case of a single file to be copied. This is a convenience method for copyFrom on several remote files. recursive: true if you want traverse directories

Returns:

number of files copied successfully

Throws:

ExecException

copyFrom

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

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.

Returns:

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

Throws:

ExecException

setForcedCleanUp

void setForcedCleanUp(boolean foo)

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

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

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.

setTimeout

void setTimeout(int seconds)

Set timeout for the operations.

addIdentity

void addIdentity(java.lang.String identity)

addIdentity, useless for local exec

setPortForwardingL

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

port forwarding not working on local exec

Throws:

ExecException

setPortForwardingR

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

port forwarding not working on local exec

Throws:

ExecException

openConnection

boolean openConnection()
                throws ExecException

Throws:

ExecException

closeConnection

void closeConnection()