org.kepler.ssh

Class SftpExec

java.lang.Object

org.kepler.ssh.RemoteExec

org.kepler.ssh.SshExec

org.kepler.ssh.SftpExec

All Implemented Interfaces:

ExecInterface

public class SftpExec
extends SshExec

Class to handle file transfer based on sftp protocol. It uses the Jsch package to transfer files from local to remote host or remote host to local machine. It extends SshExec and uses its method to execute a sftp command in batch mode to transfer files between two remote machines

Author:

Chandrika Sivaramakrishnan Based on - JSch examples http://www.jcraft.com/jsch and SshExec code written by Norbert Podhorszki

See Also:

SshExec

Field Summary

Fields inherited from class org.kepler.ssh.SshExec

jschSession, session

Constructor Summary

Constructors

Constructor and Description
SftpExec(java.lang.String user, java.lang.String host) Creates session with give user and host name and default port
SftpExec(java.lang.String user, java.lang.String host, int port) Creates a session with given user name, host and port

Method Summary

Modifier and Type	Method and Description
int	copyFrom(java.lang.String rfile, java.io.File localPath, boolean recursive) Copies file/directory from a remote machine to local machine using Jsch sftp channel.
int	copyTo(java.io.File lfile, java.lang.String targetPath, boolean recursive) Copies files/directories from local machine to remote host
java.lang.String	getRecursiveCopyCmd(java.lang.String srcFile, java.lang.String destFile, boolean isConnectionOrigin) Returns the list of sftp commands (combination of "mkdir" and "put" commands) that are required to recursively copy a directory.
java.util.Vector<java.lang.String>	getWildcardFileListing(java.lang.String remoteFile, java.lang.String seperator) Anand: Receives the remote wildcard and returns list of files matching the pattern
boolean	isRegularOrLinkFile(java.lang.String srcFile) Checks if a given file is a regular file.

Methods inherited from class org.kepler.ssh.SshExec

_copyTo, addIdentity, addIdentity, addPortForwardL, addPortForwardR, checkAck, closeConnection, executeCmd, executeCmd, getForcedCleanUp, getTimeout, getwildcardFileListingBBCP, isRemoteFileDirectory, openConnection, removePortForwardL, removePortForwardR, setcmdLineOptions, setForcedCleanUp, setPortForwardingL, setPortForwardingR, setProtocolPath, setPseudoTerminal, setTimeout, setTimeout

Methods inherited from class org.kepler.ssh.RemoteExec

copyFrom, copyTo, createDir, deleteFile, kill

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpExec

public SftpExec(java.lang.String user,
                java.lang.String host)

Creates session with give user and host name and default port

Parameters:

user -

host -

SftpExec

public SftpExec(java.lang.String user,
                java.lang.String host,
                int port)

Creates a session with given user name, host and port

Parameters:

user -

host -

port -

Method Detail

copyFrom

public int copyFrom(java.lang.String rfile,
                    java.io.File localPath,
                    boolean recursive)
             throws SshException

Copies file/directory from a remote machine to local machine using Jsch sftp channel. Since the sftp command is not directly used any command line options set in the super class will be ignored.

Specified by:

copyFrom in interface ExecInterface

Overrides:

copyFrom in class SshExec

Parameters:

rfile - - remote file that should be copied to local machine

localPath - - path into to which the source file should be copied

recursive - - flag to represent recursive copy of a directory

Returns:

number of files copied successfully SshException is thrown in case of error.

Throws:

SshException

getWildcardFileListing

public java.util.Vector<java.lang.String> getWildcardFileListing(java.lang.String remoteFile,
                                                                 java.lang.String seperator)
                                                          throws java.lang.Exception

Anand: Receives the remote wildcard and returns list of files matching the pattern

Parameters:

remoteFile - : Wildcard pattern with path

seperator - : OS path seperator

Returns:

String array containing list of files matching pattern

Throws:

java.lang.Exception

copyTo

public int copyTo(java.io.File lfile,
                  java.lang.String targetPath,
                  boolean recursive)
           throws SshException

Copies files/directories from local machine to remote host

Specified by:

copyTo in interface ExecInterface

Overrides:

copyTo in class RemoteExec

Parameters:

lfile - - local file that should be copied to remote machine

targetPath - - path on remote host into to which the file should be copied

recursive - - flag to represent recursive copy of a directory

Returns:

number of files copied successfully (i.e either returns true or an exception is raised)

Throws:

SshException

getRecursiveCopyCmd

public java.lang.String getRecursiveCopyCmd(java.lang.String srcFile,
                                            java.lang.String destFile,
                                            boolean isConnectionOrigin)
                                     throws SshException

Returns the list of sftp commands (combination of "mkdir" and "put" commands) that are required to recursively copy a directory.

Parameters:

srcFile - - source file to be copied

destFile - - destination directory

isConnectionOrigin -

Returns:

command - String representing the list of commands seperated by \n character

Throws:

SshException

isRegularOrLinkFile

public boolean isRegularOrLinkFile(java.lang.String srcFile)
                            throws SshException,
                                   com.jcraft.jsch.JSchException

Checks if a given file is a regular file.

Parameters:

srcFile - - file that is to be checked for its type

Returns:

flag - true if the input is a regular file, false otherwise

Throws:

SshException

com.jcraft.jsch.JSchException