org.sdm.spa.actors.transport

Class ScpCopier

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

org.sdm.spa.actors.transport.ScpCopier

public class ScpCopier
extends FileCopierBase

Copies files using SCP protocol. Uses the SshExec class to run the scp command.

Copy operation will overwrite existing files by default. Copy between a local host and a remote host ignores the variables forcedCleanup, and timeout.

When transferring files between local machine and a remote machine, if the remote machine does not have scp in standard path, you can set it using the variables protocolPathSrc/protocolPathDest.

When transferring files between two remote machines, the scp command is run from the source machine. Is scp is not in standard path on source machine, set the path in protocolPathSrc variable. If this variable is not set, class attempts to search in the most common locations - /usr/bin, /bin, /usr/local/bin, . , and ~

Author:

Chandrika Sivaramakrishnan

Nested Class Summary

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

FileCopierBase.CopyResult

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jcraft.jsch.Session	jschSession
protected SshSession	session

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

cmdLineOptions, forcedCleanup, protocolPathDest, protocolPathSrc, timeout

Constructor Summary

Constructors

Constructor and Description
ScpCopier()

Method Summary

Modifier and Type	Method and Description
java.lang.StringBuffer	buildSCPRemoteDestinationCommand(java.lang.String fileName, int destPort, java.lang.String destFile, boolean recursive)
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.
protected boolean	isScpPresent(ConnectionDetails srcDetails, ConnectionDetails destDetails)

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

Field Detail

session

protected SshSession session

jschSession

protected com.jcraft.jsch.Session jschSession

Constructor Detail

ScpCopier

public ScpCopier()

Method Detail

copyFrom

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

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.

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

buildSCPRemoteDestinationCommand

public java.lang.StringBuffer buildSCPRemoteDestinationCommand(java.lang.String fileName,
                                                               int destPort,
                                                               java.lang.String destFile,
                                                               boolean recursive)

isScpPresent

protected boolean isScpPresent(ConnectionDetails srcDetails,
                               ConnectionDetails destDetails)

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