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 Summary
Constructors 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 Summary
Modifier 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.ScpToMessage
getDirMode, getFileMode, setDirMode, setFileMode
-
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
getCompressed, getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
-
-
-
-
Constructor Detail
-
ScpToMessageBySftp
public 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 loggingsession- the scp session to useaLocalFile- the local fileaRemotePath- the remote path- Since:
- Ant 1.7
-
ScpToMessageBySftp
public 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 loggingsession- the scp session to useaLocalFile- the local fileaRemotePath- the remote pathpreserveLastModified- True if the last modified time needs to be preserved on the transferred files. False otherwise.- Since:
- Ant 1.9.10
-
ScpToMessageBySftp
public 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 loggingsession- the scp session to useaDirectoryList- a list of directoriesaRemotePath- the remote path- Since:
- Ant 1.7
-
ScpToMessageBySftp
public 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 loggingsession- the scp session to useaDirectoryList- a list of directoriesaRemotePath- the remote pathpreserveLastModified- True if the last modified time needs to be preserved on the transferred files. False otherwise.- Since:
- Ant 1.9.10
-
ScpToMessageBySftp
public ScpToMessageBySftp(com.jcraft.jsch.Session session, java.io.File aLocalFile, java.lang.String aRemotePath)Constructor for ScpToMessage.- Parameters:
session- the scp session to useaLocalFile- the local fileaRemotePath- the remote path
-
ScpToMessageBySftp
public ScpToMessageBySftp(com.jcraft.jsch.Session session, java.util.List<Directory> aDirectoryList, java.lang.String aRemotePath)Constructor for ScpToMessage.- Parameters:
session- the scp session to useaDirectoryList- a list of directoriesaRemotePath- the remote path
-
-
Method Detail
-
execute
public void execute() throws java.io.IOException, com.jcraft.jsch.JSchExceptionCarry out the transfer.- Overrides:
executein classScpToMessage- Throws:
java.io.IOException- on i/o errorscom.jcraft.jsch.JSchException- on errors detected by scp
-
getLocalFile
public java.io.File getLocalFile()
Get the local file.- Overrides:
getLocalFilein classScpToMessage- Returns:
- the local file.
-
getRemotePath
public java.lang.String getRemotePath()
Get the remote path.- Overrides:
getRemotePathin classScpToMessage- Returns:
- the remote path.
-
getPreserveLastModified
public 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 classScpToMessage- Returns:
- boolean
-
-