org.sdm.spa.actors.transport

Class BbcpCopier

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

org.sdm.spa.actors.transport.BbcpCopier

public class BbcpCopier
extends FileCopierBase

This class provides methods to copy files across two remote machines using bbcp. It generates the command based on the user input, connects to the source machine using ssh and executes the commands. Internally uses SshExec methods to execute command.

Copy operation would fail if file with the same name already exists. Command line options can be set to override the default behavior

The path of bbcp executable on the remote machine should be set in the class variable 'protocolPathDest', if bbcp is installed on a non standard path. On the local machine or remote source machine, if the variable protocolPathSrc is not set, attempt is made to search the most common locations user's home directory, /usr/bin, /bin, and /usr/local/bin. If the executable is not found in the above paths, an error is reported

Author:

Chandrika Sivaramakrishnan

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
BbcpCopier()

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

BbcpCopier

public BbcpCopier()

Method Detail

copyFrom

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

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:

SshException

copyTo

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

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:

SshException

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