org.kepler.ssh

Class RemoteExec

java.lang.Object

org.kepler.ssh.RemoteExec

All Implemented Interfaces:

ExecInterface

Direct Known Subclasses:

GsiSshExec, SshExec

public abstract class RemoteExec
extends java.lang.Object
implements ExecInterface

Constructor Summary

Constructors

Constructor and Description
RemoteExec()

Method Summary

Modifier and Type	Method and Description
protected abstract int	_copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive)
abstract void	closeConnection()
int	copyFrom(java.lang.String targetPath, java.util.Collection files, java.io.File localPath, boolean recursive) Copy remote files from a remote directory to a local path Input: 'files' is a Collection of files of type String (!
abstract int	copyFrom(java.lang.String rfile, 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 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
int	copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copy a local file to a remote directory/path Input: file of type File (which can be a directory).
boolean	createDir(java.lang.String dir, boolean parentflag) Create directory on the remote site with "mkdir" or "mkdir -p" command.
boolean	deleteFile(java.lang.String fname, boolean recursive, boolean allowFileMask) Delete file or directory on the remote site with "rm -rf" command!
abstract boolean	getForcedCleanUp()
abstract int	getTimeout()
protected void	kill(java.lang.String pid, boolean group)
abstract boolean	openConnection()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kepler.ssh.ExecInterface

addIdentity, executeCmd, executeCmd, setForcedCleanUp, setPortForwardingL, setPortForwardingR, setTimeout, setTimeout

Constructor Detail

RemoteExec

public RemoteExec()

Method Detail

openConnection

public abstract boolean openConnection()
                                throws SshException

Specified by:

openConnection in interface ExecInterface

Throws:

SshException

closeConnection

public abstract void closeConnection()

Specified by:

closeConnection in interface ExecInterface

getForcedCleanUp

public abstract boolean getForcedCleanUp()

getTimeout

public abstract int getTimeout()

_copyTo

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

Throws:

SshException

copyFrom

public abstract int copyFrom(java.lang.String rfile,
                             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

Returns:

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

Throws:

SshException

kill

protected void kill(java.lang.String pid,
                    boolean group)

createDir

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

Create directory on the remote site with "mkdir" or "mkdir -p" command. It should be relative to the user's home dir, or an absolute path. If parentflag is true, the -p flag is used in the command so that an existing directory will not throw an error.

Specified by:

createDir in interface ExecInterface

Returns:

true if succeeded throws ExecException (instance of SshExecption or ExecTimeoutException)

Throws:

ExecException

deleteFile

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

Delete file or directory on the remote site with "rm -rf" command! BE CAREFUL It should be relative to the user's home dir, 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

Specified by:

deleteFile in interface ExecInterface

Returns:

true if succeeded throws SshException

Throws:

ExecException

copyTo

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

Copy local files to a 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

Specified by:

copyTo in interface ExecInterface

Returns:

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

Throws:

SshException

copyTo

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

Copy a local file to a remote directory/path Input: file of type File (which can be a directory). The file name can be wildcarded too (but not the path elements!). targetPath is either a directory or filename

Specified by:

copyTo in interface ExecInterface

Returns:

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

Throws:

SshException

copyFrom

public int copyFrom(java.lang.String targetPath,
                    java.util.Collection files,
                    java.io.File localPath,
                    boolean recursive)
             throws SshException

Copy remote files from a remote directory to a local path Input: 'files' is a Collection of files of type String (! not like at copyTo !), 'targetPath' is either empty string (or null) in case the 'files' contain full paths to the individual files, or it should be a remote dir, and in this case each file name in 'files' will be extended with the remote dir 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

Specified by:

copyFrom in interface ExecInterface

Returns:

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

Throws:

SshException