org.sdm.spa.actors.transport

Class FileCopierBase

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

Direct Known Subclasses:

BbcpCopier, LocalFileCopier, ScpCopier, SftpCopier, SrmliteCopier

public abstract class FileCopierBase
extends java.lang.Object

This class provides functionality to copy files between two machine using SSH. Remote machines should be accessible using SSH to be able to copy files. This is a base class that can be extended by Protocol specific class that generate different commands to perform the copy operation.

Whether the copy operation would by default overwrite existing files depends on the actual protocol used for file copy. Optional command line options may be used to override the default behavior in some cases depending on the protocol used. Refer to the documentation of specific sub class for details.

When both source and destination machines are local hosts, the protocol specified is ignored and file copy is done using Java.

When both source and destination are the same machine a simple cp command is used instead of any specific protocol

Author:

Chandrika Sivaramakrishnan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FileCopierBase.CopyResult Object that contains the exit code and (error) message associated with the copy operation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cmdLineOptions
protected boolean	forcedCleanup
protected java.lang.String	protocolPathDest
protected java.lang.String	protocolPathSrc
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
FileCopierBase()

Method Summary

Modifier and Type	Method and Description
protected FileCopierBase.CopyResult	copy(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Generic copy method that does the initial input validation and calls the copyTo, copyFrom or copyRemote of the appropriate FileCopier subclass.
protected abstract FileCopierBase.CopyResult	copyFrom(ConnectionDetails srcDetails, java.lang.String srcFile, java.lang.String destFile, boolean recursive) Copies file from a remote host to local machine
protected FileCopierBase.CopyResult	copyLocal(java.lang.String sourceFile, java.lang.String destinationFile, boolean recursive) Copies files to destination path on the same machine.
protected FileCopierBase.CopyResult	copyLocalOnRemoteMachine(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Connects to the remote machines and execute a 'cp' command to copy files to destination dir on the same remote machine
protected abstract FileCopierBase.CopyResult	copyRemote(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Copies files between two remote machines.
protected abstract FileCopierBase.CopyResult	copyTo(java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Copies files from local machine to a remote host
java.lang.String	getCmdLineOptions()
protected java.lang.String	getCmdWithDefaultPath(java.lang.StringBuffer cmd) This is used to set the users PATH variable, if the user has not specified the path where the protocol is installed.
protected abstract int	getDefaultPort() default port for the file transfer protocol.
java.lang.String	getProtocolPathDest()
java.lang.String	getProtocolPathSrc()
int	getTimeout()
boolean	isForcedCleanup()
void	setCleanup(boolean cleanup)
void	setCmdLineOptions(java.lang.String cmdLineOptions)
void	setProtocolPathDest(java.lang.String protocolPathDest)
void	setProtocolPathSrc(java.lang.String protocolPathSrc)
void	setTimeout(int timeout)

Methods inherited from class java.lang.Object

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

Field Detail

forcedCleanup

protected boolean forcedCleanup

timeout

protected int timeout

cmdLineOptions

protected java.lang.String cmdLineOptions

protocolPathSrc

protected java.lang.String protocolPathSrc

protocolPathDest

protected java.lang.String protocolPathDest

Constructor Detail

FileCopierBase

public FileCopierBase()

Method Detail

copyLocal

protected FileCopierBase.CopyResult copyLocal(java.lang.String sourceFile,
                                              java.lang.String destinationFile,
                                              boolean recursive)

Copies files to destination path on the same machine.

Parameters:

srcFile - - source file to be copied

destFile - - local path into which source should be copied

recursive - - flag to indicate if directories should be copied recursively

Returns:

CopyResult object containing the exit code and error message if any. exit code 0 represents successful file transfer.

copyLocalOnRemoteMachine

protected FileCopierBase.CopyResult copyLocalOnRemoteMachine(ConnectionDetails srcDetails,
                                                             java.lang.String srcFile,
                                                             ConnectionDetails destDetails,
                                                             java.lang.String destFile,
                                                             boolean recursive)
                                                      throws ExecException

Connects to the remote machines and execute a 'cp' command to copy files to destination dir on the same remote machine

Parameters:

srcFile - - source file to be copied

destFile - - local path into which source should be copied

recursive - - flag to indicate if directories should be copied recursively

Returns:

CopyResult object containing the exit code and error message if any. exit code 0 represents successful file transfer.

Throws:

ExecException

copyFrom

protected abstract FileCopierBase.CopyResult copyFrom(ConnectionDetails srcDetails,
                                                      java.lang.String srcFile,
                                                      java.lang.String destFile,
                                                      boolean recursive)
                                               throws ExecException

Copies file from a remote host to local machine

Parameters:

srcDetails - - object containing the source machine connection details

srcFile - - source file to be copied

destFile - - local path into which source should be copied

recursive - - flag to indicate if directories should be copied recursively

Returns:

CopyResult object containing the exit code and error message if any. exit code 0 represents successful file transfer.

Throws:

ExecException

copyTo

protected abstract FileCopierBase.CopyResult copyTo(java.lang.String srcFile,
                                                    ConnectionDetails destDetails,
                                                    java.lang.String destFile,
                                                    boolean recursive)
                                             throws ExecException

Copies files from local machine to a remote host

Parameters:

srcFile - - local source file to be copied

destDetails - - object containing the destination machine connection details

destFile - - path into which source should be copied

recursive - - flag to indicate if directories should be copied recursively

Returns:

CopyResult object containing the exit code and error message if any. exit code 0 represents successful file transfer.

Throws:

ExecException

copyRemote

protected abstract FileCopierBase.CopyResult copyRemote(ConnectionDetails srcDetails,
                                                        java.lang.String srcFile,
                                                        ConnectionDetails destDetails,
                                                        java.lang.String destFile,
                                                        boolean recursive)
                                                 throws ExecException

Copies files between two remote machines.

Parameters:

srcDetails - - object containing the source machine connection details

srcFile - - source file to be copied

destDetails - - object containing the destination machine connection details

destFile - - path into which source should be copied

recursive - - flag to indicate if directory should be copied recursively

Returns:

CopyResult object containing the exit code and error message if any. exit code 0 represents successful file transfer.

Throws:

ExecException

copy

protected FileCopierBase.CopyResult copy(ConnectionDetails srcDetails,
                                         java.lang.String srcFile,
                                         ConnectionDetails destDetails,
                                         java.lang.String destFile,
                                         boolean recursive)
                                  throws IllegalActionException,
                                         ExecException

Generic copy method that does the initial input validation and calls the copyTo, copyFrom or copyRemote of the appropriate FileCopier subclass. Subclasses of FileCopier implement these methods based on the protocol that it uses for file copy. If both source and destination are local host, ignores the protocol specified by the user and copies file using java

Parameters:

srcDetails - - ConnectionDetails object with source machine details

srcFile - - File to be copied

destDetails - - ConnectionDetails object with destination machine details

destFile - - Destination file or directory

recursive - - whether directory should be copied recursively

Returns:

exitCode

Throws:

IllegalActionException

ExecException

getCmdWithDefaultPath

protected java.lang.String getCmdWithDefaultPath(java.lang.StringBuffer cmd)

This is used to set the users PATH variable, if the user has not specified the path where the protocol is installed. In such cases the program will search for it in a default list of path.

Parameters:

cmd - - command to execute for file copy

Returns:

original command prefixed with command to set PATH variable.

getDefaultPort

protected abstract int getDefaultPort()

default port for the file transfer protocol. Child class should either return a specific port number or -1 if it doesn't want to enforce a specific port number

isForcedCleanup

public boolean isForcedCleanup()

setCleanup

public void setCleanup(boolean cleanup)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getCmdLineOptions

public java.lang.String getCmdLineOptions()

setCmdLineOptions

public void setCmdLineOptions(java.lang.String cmdLineOptions)

getProtocolPathSrc

public java.lang.String getProtocolPathSrc()

setProtocolPathSrc

public void setProtocolPathSrc(java.lang.String protocolPathSrc)

getProtocolPathDest

public java.lang.String getProtocolPathDest()

setProtocolPathDest

public void setProtocolPathDest(java.lang.String protocolPathDest)