org.apache.tools.ant.taskdefs.optional.ssh

Class ScpToMessageBySftp


public class ScpToMessageBySftp
extends ScpToMessage

Utility class to carry out an upload by sftp.

Constructor Summary

ScpToMessageBySftp(Session session, File aLocalFile, String aRemotePath)
Constructor for ScpToMessage.
ScpToMessageBySftp(Session session, List aDirectoryList, String aRemotePath)
Constructor for ScpToMessage.
ScpToMessageBySftp(boolean verbose, Session session, File aLocalFile, String aRemotePath)
Constructor for a local file to remote.
ScpToMessageBySftp(boolean verbose, Session session, List aDirectoryList, String aRemotePath)
Constructor for a local directories to remote.

Method Summary

void
execute()
Carry out the transfer.
File
getLocalFile()
Get the local file.
String
getRemotePath()
Get the remote path.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage

execute, getLocalFile, getRemotePath

Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage

execute, getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck

Constructor Details

ScpToMessageBySftp

public ScpToMessageBySftp(Session session,
                          File aLocalFile,
                          String aRemotePath)
Constructor for ScpToMessage.
Parameters:
session - the scp session to use
aLocalFile - the local file
aRemotePath - the remote path

ScpToMessageBySftp

public ScpToMessageBySftp(Session session,
                          List aDirectoryList,
                          String aRemotePath)
Constructor for ScpToMessage.
Parameters:
session - the scp session to use
aDirectoryList - a list of directories
aRemotePath - the remote path

ScpToMessageBySftp

public ScpToMessageBySftp(boolean verbose,
                          Session session,
                          File aLocalFile,
                          String aRemotePath)
Constructor for a local file to remote.
Parameters:
verbose - if true do verbose logging
session - the scp session to use
aLocalFile - the local file
aRemotePath - the remote path
Since:
Ant 1.7

ScpToMessageBySftp

public ScpToMessageBySftp(boolean verbose,
                          Session session,
                          List aDirectoryList,
                          String aRemotePath)
Constructor for a local directories to remote.
Parameters:
verbose - if true do verbose logging
session - the scp session to use
aDirectoryList - a list of directories
aRemotePath - the remote path
Since:
Ant 1.7

Method Details

execute

public void execute()
            throws IOException,
                   JSchException
Carry out the transfer.
Overrides:
execute in interface ScpToMessage

getLocalFile

public File getLocalFile()
Get the local file.
Overrides:
getLocalFile in interface ScpToMessage
Returns:
the local file.

getRemotePath

public String getRemotePath()
Get the remote path.
Overrides:
getRemotePath in interface ScpToMessage
Returns:
the remote path.