Class ScpToMessageBySftp
- java.lang.Object
- 
- org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
- 
- org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage
- 
- org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp
 
 
 
- 
 public class ScpToMessageBySftp extends ScpToMessage Utility class to carry out an upload by sftp.
- 
- 
Constructor SummaryConstructors Constructor Description ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath)Constructor for a local file to remote.ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath, boolean preserveLastModified)Constructor for a local file to remote.ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath)Constructor for a local directories to remote.ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath, boolean preserveLastModified)Constructor for a local directories to remote.ScpToMessageBySftp(com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath)Constructor for ScpToMessage.ScpToMessageBySftp(com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath)Constructor for ScpToMessage.
 - 
Method SummaryModifier and Type Method Description voidexecute()Carry out the transfer.java.io.FilegetLocalFile()Get the local file.booleangetPreserveLastModified()Returns true if the last modified time needs to be preserved on the file(s) that get transferred.java.lang.StringgetRemotePath()Get the remote path.- 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessagegetDirMode, getFileMode, setDirMode, setFileMode
 - 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessagegetCompressed, getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
 
- 
 
- 
- 
- 
Constructor Detail- 
ScpToMessageBySftppublic ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath)Constructor for a local file to remote.- Parameters:
- verbose- if true do verbose logging
- session- the scp session to use
- aLocalFile- the local file
- aRemotePath- the remote path
- Since:
- Ant 1.7
 
 - 
ScpToMessageBySftppublic ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath, boolean preserveLastModified)Constructor for a local file to remote.- Parameters:
- verbose- if true do verbose logging
- session- the scp session to use
- aLocalFile- the local file
- aRemotePath- the remote path
- preserveLastModified- True if the last modified time needs to be preserved on the transferred files. False otherwise.
- Since:
- Ant 1.9.10
 
 - 
ScpToMessageBySftppublic ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath)Constructor for a local directories to remote.- Parameters:
- verbose- if true do verbose logging
- session- the scp session to use
- aDirectoryList- a list of directories
- aRemotePath- the remote path
- Since:
- Ant 1.7
 
 - 
ScpToMessageBySftppublic ScpToMessageBySftp(boolean verbose, com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath, boolean preserveLastModified)Constructor for a local directories to remote.- Parameters:
- verbose- if true do verbose logging
- session- the scp session to use
- aDirectoryList- a list of directories
- aRemotePath- the remote path
- preserveLastModified- True if the last modified time needs to be preserved on the transferred files. False otherwise.
- Since:
- Ant 1.9.10
 
 - 
ScpToMessageBySftppublic ScpToMessageBySftp(com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath)Constructor for ScpToMessage.- Parameters:
- session- the scp session to use
- aLocalFile- the local file
- aRemotePath- the remote path
 
 - 
ScpToMessageBySftppublic ScpToMessageBySftp(com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath)Constructor for ScpToMessage.- Parameters:
- session- the scp session to use
- aDirectoryList- a list of directories
- aRemotePath- the remote path
 
 
- 
 - 
Method Detail- 
executepublic void execute() throws java.io.IOException, com.jcraft.jsch.JSchExceptionCarry out the transfer.- Overrides:
- executein class- ScpToMessage
- Throws:
- java.io.IOException- on i/o errors
- com.jcraft.jsch.JSchException- on errors detected by scp
 
 - 
getLocalFilepublic java.io.File getLocalFile() Get the local file.- Overrides:
- getLocalFilein class- ScpToMessage
- Returns:
- the local file.
 
 - 
getRemotePathpublic java.lang.String getRemotePath() Get the remote path.- Overrides:
- getRemotePathin class- ScpToMessage
- Returns:
- the remote path.
 
 - 
getPreserveLastModifiedpublic boolean getPreserveLastModified() Returns true if the last modified time needs to be preserved on the file(s) that get transferred. Returns false otherwise.- Overrides:
- getPreserveLastModifiedin class- ScpToMessage
- Returns:
- boolean
 
 
- 
 
-