org.sdm.spa.actors.transport

Class SrmliteCopier

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

org.sdm.spa.actors.transport.SrmliteCopier

public class SrmliteCopier
extends FileCopierBase

This class copies files/directories from one machine to another using the srmlite protocol. It uses the LocalExec to copy file/directory between local host and a remote host. To copy files between remote machines, uses SshExec, connects to source machine using ssh and execute srmlite command to copy to remote machine

scp is used as the default protocol passed to srmlite. It can be overriden by setting the srmProtocol variable

Copy operation will overwrite existing files by default. Retry feature of srmlite is not currently supported.

On the source machine, if srmlite is not on standard path and if the variable protocolPathSrc is not set, the class attempts to search in the most common locations - user's home directory, /usr/bin, /bin, and /usr/local/bin

Author:

Chandrika Sivaramakrishnan Anand: We assume that target location is always a directory.

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

Method Summary

Modifier and Type	Method and Description
void	build_xml_ForLocalSource(java.lang.String fileName, java.lang.String[] fileList, java.lang.String destFile)
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	fileListCopyFrom(java.lang.String cmdWithPath, java.lang.String HostStr)
protected int	getDefaultPort() default port for the file transfer protocol.
java.lang.String	getSrmProtocol()
void	setSrmProtocol(java.lang.String srmProtocol)

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

SrmliteCopier

public SrmliteCopier()

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

build_xml_ForLocalSource

public void build_xml_ForLocalSource(java.lang.String fileName,
                                     java.lang.String[] fileList,
                                     java.lang.String destFile)
                              throws java.io.IOException

Throws:

java.io.IOException

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

getSrmProtocol

public java.lang.String getSrmProtocol()

setSrmProtocol

public void setSrmProtocol(java.lang.String srmProtocol)

fileListCopyFrom

protected int fileListCopyFrom(java.lang.String cmdWithPath,
                               java.lang.String HostStr)
                        throws java.lang.Exception

Throws:

java.lang.Exception