Class ScpFromMessage

java.lang.Object

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

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

Direct Known Subclasses:

ScpFromMessageBySftp

public class ScpFromMessage
extends AbstractSshMessage

A helper object representing an scp download.

Constructor Summary

Constructors

Constructor	Description
ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session)	Constructor for ScpFromMessage
ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive)	Constructor for ScpFromMessage.
ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified)	Constructor for ScpFromMessage.
ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified, boolean compressed)	Constructor for ScpFromMessage.
ScpFromMessage(com.jcraft.jsch.Session session)	Constructor for ScpFromMessage
ScpFromMessage(com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive)	Constructor for ScpFromMessage.

Method Summary

Modifier and Type	Method	Description
void	execute()	Carry out the transfer.
protected boolean	getPreserveLastModified()

Methods inherited from class AbstractSshMessage

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

Modifier and Type	Method	Description
protected final boolean	getCompressed()	Is the compressed attribute set.
protected com.jcraft.jsch.SftpProgressMonitor	getProgressMonitor()	Get the progress monitor.
protected final boolean	getVerbose()	Is the verbose attribute set.
protected void	log(String message)	Log a message to the log listener.
protected void	logStats(long timeStarted, long timeEnded, long totalLength)	Log transfer stats to the log listener.
protected com.jcraft.jsch.Channel	openExecChannel(String command)	Open an ssh channel.
protected com.jcraft.jsch.ChannelSftp	openSftpChannel()	Open an ssh sftp channel.
protected void	sendAck(OutputStream out)	Send an ack.
void	setLogListener(LogListener aListener)	Set a log listener.
protected final int	trackProgress(long filesize, long totalLength, int percentTransmitted)	Track progress every 10% if 100kb < filesize < 1Mb.
protected void	waitForAck(InputStream in)	Reads the response, throws a BuildException if the response indicates an error.

Methods inherited from class Object

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

Constructor Details

ScpFromMessage

public ScpFromMessage(com.jcraft.jsch.Session session)

Constructor for ScpFromMessage

Parameters:

session - the ssh session to use

ScpFromMessage

public ScpFromMessage(boolean verbose,
 com.jcraft.jsch.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,
 com.jcraft.jsch.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(com.jcraft.jsch.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,
 com.jcraft.jsch.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

ScpFromMessage

public ScpFromMessage(boolean verbose,
 com.jcraft.jsch.Session session,
 String aRemoteFile,
 File aLocalFile,
 boolean recursive,
 boolean preserveLastModified,
 boolean compressed)

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

compressed - if true use compression (-C option to scp) modification times

Since:

Ant 1.9.8

Method Details

execute

public void execute()
             throws IOException,
com.jcraft.jsch.JSchException

Carry out the transfer.

Specified by:

execute in class AbstractSshMessage

Throws:

IOException - on i/o errors

com.jcraft.jsch.JSchException - on errors detected by scp

getPreserveLastModified

protected boolean getPreserveLastModified()