org.sdm.spa.actors.transport

Class SftpCopier

java.lang.Object

org.sdm.spa.actors.transport.FileCopierBase

org.sdm.spa.actors.transport.SftpCopier

public class SftpCopier
extends FileCopierBase

SFTP provides functionality to copy files, regular expressions, directories(with dir: option). It does not provide list of file/dir/regular expression. To achieve that we loop through list of files and execute sftp copy for each statement.\

Author:

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildSftpCommand(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive, SftpExec sshObject, java.lang.String cmdFile) Anand: Create a batch file for a file or directory and give that to sftp to perform copy This function creates batch file, and builds sftp copy command and returns it to calling function.
java.lang.String	buildSftpWildcardBatch(ConnectionDetails srcDetails, java.lang.String srcFile, ConnectionDetails destDetails, java.lang.String destFile, boolean recursive, SftpExec sshObject, java.lang.String cmdFile) Anand: Create a command for remote to remote SFTP copy.
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

SftpCopier

public SftpCopier()

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

buildSftpWildcardBatch

public java.lang.String buildSftpWildcardBatch(ConnectionDetails srcDetails,
                                               java.lang.String srcFile,
                                               ConnectionDetails destDetails,
                                               java.lang.String destFile,
                                               boolean recursive,
                                               SftpExec sshObject,
                                               java.lang.String cmdFile)
                                        throws java.lang.Exception

Anand: Create a command for remote to remote SFTP copy. This function does not copy the command file to remote directory. It just creates echo statement to copy the command file and the command. command format : bash -c 'export PATH=/usr/bin:/bin:/usr/local/bin:~:.:$PATH; echo -e "put " \n "put " > batchfile; sftp -o "batchmode no" -b -oPort=22 gs3dev@130.20.107.80' The batch file contains series of put/get commands to be executed of sftp prompt.

Parameters:

srcDetails - - Source connection details

srcFile - - Source file name

destDetails - - Destination connection details

destFile - - destination file name

recursive - - true/false for directory

sshObject - - used to connect to remote machine to get file list matching wildcard

cmdFile - - batch file name

Returns:

String - command which is to be run to copy files

Throws:

java.lang.Exception

buildSftpCommand

public java.lang.String buildSftpCommand(ConnectionDetails srcDetails,
                                         java.lang.String srcFile,
                                         ConnectionDetails destDetails,
                                         java.lang.String destFile,
                                         boolean recursive,
                                         SftpExec sshObject,
                                         java.lang.String cmdFile)
                                  throws java.lang.Exception

Anand: Create a batch file for a file or directory and give that to sftp to perform copy This function creates batch file, and builds sftp copy command and returns it to calling function.

Parameters:

srcDetails - - Source connection details

srcFile - - Source file name

destDetails - - Destination connection details

destFile - - destination file name

recursive - - true/false for directory

sshObject - - used to connect to remote machine to get file list matching wildcard

cmdFile - - batch file name

Returns:

String : command which is to be run to copy files

Throws:

java.lang.Exception

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