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

Class ScpFromMessage

Known Direct Subclasses:
ScpFromMessageBySftp

public class ScpFromMessage
extends AbstractSshMessage

A helper object representing an scp download.

Constructor Summary

ScpFromMessage(Session session)
Constructor for ScpFromMessage
ScpFromMessage(Session session, String aRemoteFile, File aLocalFile, boolean recursive)
Constructor for ScpFromMessage.
ScpFromMessage(boolean verbose, Session session)
Constructor for ScpFromMessage
ScpFromMessage(boolean verbose, Session session, String aRemoteFile, File aLocalFile, boolean recursive)
Constructor for ScpFromMessage.

Method Summary

void
execute()
Carry out the transfer.

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

ScpFromMessage

public ScpFromMessage(Session session)
Constructor for ScpFromMessage
Parameters:
session - the ssh session to use

ScpFromMessage

public ScpFromMessage(Session session,
                      String aRemoteFile,
                      File aLocalFile,
                      boolean recursive)
Constructor for ScpFromMessage.
Parameters:
session - the Scp session to use
aRemoteFile - the remote file name
aLocalFile - the local file
recursive - if true use recursion (-r option to scp)

ScpFromMessage

public ScpFromMessage(boolean verbose,
                      Session session)
Constructor for ScpFromMessage
Parameters:
verbose - if true do verbose logging
session - the ssh session to use
Since:
Ant 1.7

ScpFromMessage

public ScpFromMessage(boolean verbose,
                      Session session,
                      String aRemoteFile,
                      File aLocalFile,
                      boolean recursive)
Constructor for ScpFromMessage.
Parameters:
verbose - if true log extra information
session - the Scp session to use
aRemoteFile - the remote file name
aLocalFile - the local file
recursive - if true use recursion (-r option to scp)
Since:
Ant 1.6.2

Method Details

execute

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