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

Class ScpFromMessage

public class ScpFromMessage extends AbstractSshMessage

A helper object representing an scp download.
Constructor Summary
ScpFromMessage(Session session)
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.
ScpFromMessage(Session session, String aRemoteFile, File aLocalFile, boolean recursive)
Constructor for ScpFromMessage.
ScpFromMessage(boolean verbose, Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified)
Constructor for ScpFromMessage.
Method Summary
voidexecute()
Carry out the transfer.
protected booleangetPreserveLastModified()

Constructor Detail

ScpFromMessage

public ScpFromMessage(Session session)
Constructor for ScpFromMessage

Parameters: session the ssh session to use

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

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, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified)
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) preserveLastModified whether to preserve file modification times

Since: Ant 1.8.0

Method Detail

execute

public void execute()
Carry out the transfer.

Throws: IOException on i/o errors JSchException on errors detected by scp

getPreserveLastModified

protected boolean getPreserveLastModified()