Class ScpFromMessageBySftp

java.lang.Object
org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage
org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp
public class ScpFromMessageBySftp extends ScpFromMessage
A helper object representing an scp download.

  • Constructor Details

    • ScpFromMessageBySftp

      public ScpFromMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive)
      Constructor for ScpFromMessageBySftp.
      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
      Since:
      Ant 1.7

    • ScpFromMessageBySftp

      public ScpFromMessageBySftp(com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive)
      Constructor for ScpFromMessageBySftp.
      Parameters:
      session - the Scp session to use
      aRemoteFile - the remote file name
      aLocalFile - the local file
      recursive - if true use recursion

    • ScpFromMessageBySftp

      public ScpFromMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified)
      Constructor for ScpFromMessageBySftp.
      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
      preserveLastModified - whether to preserve file modification times
      Since:
      Ant 1.8.0

    • ScpFromMessageBySftp

      public ScpFromMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, String aRemoteFile, File aLocalFile, boolean recursive, boolean preserveLastModified, boolean allowFilesToEscapeDest)
      Constructor for ScpFromMessageBySftp.
      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
      preserveLastModified - whether to preserve file 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.
      Overrides:
      execute in class ScpFromMessage
      Throws:
      IOException - on i/o errors
      com.jcraft.jsch.JSchException - on errors detected by scp