org.sdm.spa.actors.transport

Class LocalFileCopier

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

org.sdm.spa.actors.transport.LocalFileCopier

public class LocalFileCopier
extends FileCopierBase

Default class for copying files within the localhost.This class doesn't have have any specific implementation. All methods in turn call the Parent class' copyLocal method.

Author:

D3X140

Nested Class Summary

Nested classes/interfaces inherited from class org.sdm.spa.actors.transport.FileCopierBase

FileCopierBase.CopyResult

Field Summary

Fields inherited from class org.sdm.spa.actors.transport.FileCopierBase

cmdLineOptions, forcedCleanup, protocolPathDest, protocolPathSrc, timeout

Constructor Summary

Constructors

Constructor and Description
LocalFileCopier()

Method Summary

Modifier and Type	Method and Description
protected 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	copyRemote(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Copies files between two remote machines.
protected FileCopierBase.CopyResult	copyTo(java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive) Copies files from local machine to a remote host
protected int	getDefaultPort() default port for the file transfer protocol.

Methods inherited from class org.sdm.spa.actors.transport.FileCopierBase

copy, copyLocal, copyLocalOnRemoteMachine, getCmdLineOptions, getCmdWithDefaultPath, getProtocolPathDest, getProtocolPathSrc, getTimeout, isForcedCleanup, setCleanup, setCmdLineOptions, setProtocolPathDest, setProtocolPathSrc, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalFileCopier

public LocalFileCopier()

Method Detail

copyFrom

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

Description copied from class: FileCopierBase

Copies file from a remote host to local machine

Specified by:

copyFrom in class FileCopierBase

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 FileCopierBase.CopyResult copyTo(java.lang.String srcFile,
                                           ConnectionDetails destDetails,
                                           java.lang.String destFile,
                                           boolean recursive)
                                    throws ExecException

Description copied from class: FileCopierBase

Copies files from local machine to a remote host

Specified by:

copyTo in class FileCopierBase

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 FileCopierBase.CopyResult copyRemote(ConnectionDetails srcDetails,
                                               java.lang.String srcFile,
                                               ConnectionDetails destDetails,
                                               java.lang.String destFile,
                                               boolean recursive)
                                        throws ExecException

Description copied from class: FileCopierBase

Copies files between two remote machines.

Specified by:

copyRemote in class FileCopierBase

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

getDefaultPort

protected int getDefaultPort()

Description copied from class: FileCopierBase

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

Specified by:

getDefaultPort in class FileCopierBase