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 SummaryConstructors Constructor Description ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session)Constructor for ScpFromMessageScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.File aLocalFile, boolean recursive)Constructor for ScpFromMessage.ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.File aLocalFile, boolean recursive, boolean preserveLastModified)Constructor for ScpFromMessage.ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.File aLocalFile, boolean recursive, boolean preserveLastModified, boolean compressed)Constructor for ScpFromMessage.ScpFromMessage(com.jcraft.jsch.Session session)Constructor for ScpFromMessageScpFromMessage(com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.File aLocalFile, boolean recursive)Constructor for ScpFromMessage.
 - 
Method SummaryModifier and Type Method Description voidexecute()Carry out the transfer.protected booleangetPreserveLastModified()- 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessagegetCompressed, getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
 
- 
 
- 
- 
- 
Constructor Detail- 
ScpFromMessagepublic ScpFromMessage(com.jcraft.jsch.Session session) Constructor for ScpFromMessage- Parameters:
- session- the ssh session to use
 
 - 
ScpFromMessagepublic 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
 
 - 
ScpFromMessagepublic ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.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
 
 - 
ScpFromMessagepublic ScpFromMessage(com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.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)
 
 - 
ScpFromMessagepublic ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.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
 
 - 
ScpFromMessagepublic ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, java.lang.String aRemoteFile, java.io.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 Detail- 
executepublic void execute() throws java.io.IOException, com.jcraft.jsch.JSchExceptionCarry out the transfer.- Specified by:
- executein class- AbstractSshMessage
- Throws:
- java.io.IOException- on i/o errors
- com.jcraft.jsch.JSchException- on errors detected by scp
 
 - 
getPreserveLastModifiedprotected boolean getPreserveLastModified() 
 
- 
 
-