org.kepler.ssh

Class LocalExec

java.lang.Object

org.kepler.ssh.LocalExec

All Implemented Interfaces:

ExecInterface

public class LocalExec
extends java.lang.Object
implements ExecInterface

Local command execution. This class implements the ExecInterface to provide the same functionality for local operations as what Ssh does for remote ones. Thus, other classes can hide the difference between an ssh execution and local execution.

Constructor Summary

Constructors

Constructor and Description
LocalExec()

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 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 file into a local file Input: 'sfile' 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
int	copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copy a local file to a local directory/path Input: file of type File (which can be a directory).
boolean	createDir(java.lang.String dir, boolean parentflag) Create a directory given as String parameter.
boolean	deleteFile(java.lang.String fname, boolean recursive, boolean allowFileMask) To be implemented.
int	executeCmd(java.lang.String command, java.io.OutputStream streamOut, java.io.OutputStream streamErr) Execute a command on the local machine 'command' is the full command with arguments to be executed return: the exit code of the command additional effects: streamOut is continuously written during execution the stdout of the command.
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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalExec

public LocalExec()

Method Detail

addIdentity

public void addIdentity(java.lang.String identity)

addIdentity, useless for local exec

Specified by:

addIdentity in interface ExecInterface

setPortForwardingL

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

port forwarding not working on local exec

Specified by:

setPortForwardingL in interface ExecInterface

Throws:

ExecException

setPortForwardingR

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

port forwarding not working on local exec

Specified by:

setPortForwardingR in interface ExecInterface

Throws:

ExecException

openConnection

public boolean openConnection()
                       throws ExecException

Specified by:

openConnection in interface ExecInterface

Throws:

ExecException

closeConnection

public void closeConnection()

Specified by:

closeConnection in interface ExecInterface

setForcedCleanUp

public 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.

Specified by:

setForcedCleanUp in interface ExecInterface

setTimeout

public 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. executeCmd will throw an ExecException, an instance of ExecTimeoutException if the timeout limit is reached. 'seconds' = 0 means no timeout at all.

Specified by:

setTimeout in interface ExecInterface

setTimeout

public void setTimeout(int seconds)

Description copied from interface: ExecInterface

Set timeout for the operations.

Specified by:

setTimeout in interface ExecInterface

executeCmd

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

Execute a command on the local machine 'command' is the full command with arguments to be executed return: the exit code of the command additional effects: streamOut is continuously written during execution the stdout of the command. Similarly, streamErr is continuously written during exec the stderr. It forwards all Exceptions that arise during java exec.

Specified by:

executeCmd in interface ExecInterface

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).

Specified by:

executeCmd in interface ExecInterface

Returns:

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

Throws:

ExecException

createDir

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

Create a directory given as String parameter. It calls File.mkdir() or File.mkdirs() depending on the parentflag. Returns true iff directory is created. False is not returned but an exception otherwise. It catches SecurityException (from File.mkdir() or File.mkdirs()) and rethrows it as ExecException. The method works equivalently with SshExec.createDir(). That is, if the directory exists and parentflag is set, true is returned; if parentflag is not set, an exception is thrown.

Specified by:

createDir in interface ExecInterface

Returns:

true if succeeded

Throws:

ExecException

deleteFile

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

To be implemented. Delete files or directories! BE CAREFUL It should be relative to the current 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 ExecException

Throws:

ExecException

copyTo

public 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

Specified by:

copyTo in interface ExecInterface

Returns:

number of files copied successfully

Throws:

ExecException

copyTo

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

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

ExecException

copyFrom

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

Copy files from a 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 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

Throws:

ExecException

copyFrom

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

Copy a local file into a local file Input: 'sfile' 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) Note: on local filesystem, this method does the same as copyTo

Throws:

ExecException