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 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

    • ScpFromMessage

      public ScpFromMessage(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified, boolean compressed, boolean allowFilesToEscapeDest)
      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
      allowFilesToEscapeDest - if true files and directories retrieved may be places outside of the aLocalFile directory.
      Since:
      Ant 1.10.18

  • 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()

    • getAllowFilesToEscapeDest

      protected boolean getAllowFilesToEscapeDest()
      Since:
      Ant 1.10.18