java.lang.Cloneable, LogListenerpublic class Scp extends SSHBase
description, location, project| Constructor | Description |
|---|---|
Scp() |
| Modifier and Type | Method | Description |
|---|---|---|
void |
add(ResourceCollection res) |
Adds a ResourceCollection of local files to transfer to remote host.
|
void |
addFileset(FileSet set) |
Adds a FileSet transfer to remote host.
|
void |
execute() |
Execute this task.
|
void |
init() |
Initialize this task.
|
void |
setCompressed(boolean compressed) |
Sets flag to determine if compression should
be used for the copy.
|
void |
setDirMode(java.lang.String dirMode) |
Set the dir mode, defaults to "755".
|
void |
setFile(java.lang.String aFromUri) |
Sets the file to be transferred.
|
void |
setFileMode(java.lang.String fileMode) |
Set the file mode, defaults to "644".
|
void |
setLocalFile(java.lang.String aFromUri) |
Similar to
setFile but explicitly states that
the file is a local file. |
void |
setLocalTodir(java.lang.String aToUri) |
Similar to
setTodir but explicitly states
that the directory is a local. |
void |
setLocalTofile(java.lang.String aToUri) |
Changes the file name to the given name while receiving it,
only useful if receiving a single file.
|
void |
setPreservelastmodified(boolean yesOrNo) |
Sets flag to determine if file timestamp
is to be preserved during copy.
|
void |
setRemoteFile(java.lang.String aFromUri) |
Similar to
setFile but explicitly states that
the file is a remote file. |
void |
setRemoteTodir(java.lang.String aToUri) |
Similar to
setTodir but explicitly states
that the directory is a remote. |
void |
setRemoteTofile(java.lang.String aToUri) |
Changes the file name to the given name while sending it,
only useful if sending a single file.
|
void |
setSftp(boolean yesOrNo) |
Setting this to true to use sftp protocol.
|
void |
setTodir(java.lang.String aToUri) |
Sets the location where files will be transferred to.
|
logequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getDescription, getLocation, getProject, setDescription, setLocation, setProjectgetFailonerror, getHost, getPort, getServerAliveCountMax, getServerAliveIntervalSeconds, getUserInfo, getVerbose, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setServerAliveCountMax, setServerAliveIntervalSeconds, setTrust, setUsername, setVerbosebindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypepublic void setFile(java.lang.String aFromUri)
user:password@host:/directory/path/file.example
Files to transfer can also include a wildcard to include all files in a remote directory. For example:user:password@host:/directory/path/*
aFromUri - a string representing the file to transfer.public void setTodir(java.lang.String aToUri)
user:password@host:/directory/path/
This parameter is required.aToUri - a string representing the target of the copy.public void setLocalFile(java.lang.String aFromUri)
setFile but explicitly states that
the file is a local file. This is the only way to specify a
local file with a @ character.aFromUri - a string representing the source of the copy.public void setRemoteFile(java.lang.String aFromUri)
setFile but explicitly states that
the file is a remote file.aFromUri - a string representing the source of the copy.public void setCompressed(boolean compressed)
compressed - booleanpublic void setLocalTodir(java.lang.String aToUri)
setTodir but explicitly states
that the directory is a local. This is the only way to specify
a local directory with a @ character.aToUri - a string representing the target of the copy.public void setPreservelastmodified(boolean yesOrNo)
yesOrNo - booleanpublic void setRemoteTodir(java.lang.String aToUri)
setTodir but explicitly states
that the directory is a remote.aToUri - a string representing the target of the copy.public void setLocalTofile(java.lang.String aToUri)
aToUri - a string representing the target of the copy.public void setRemoteTofile(java.lang.String aToUri)
aToUri - a string representing the target of the copy.public void setSftp(boolean yesOrNo)
yesOrNo - if true sftp protocol will be used.public void setFileMode(java.lang.String fileMode)
fileMode - Stringpublic void setDirMode(java.lang.String dirMode)
dirMode - Stringpublic void addFileset(FileSet set)
set - FileSet to send to remote host.public void add(ResourceCollection res)
res - ResourceCollection to send to remote host.public void init()
throws BuildException
init in class SSHBaseBuildException - on errorpublic void execute()
throws BuildException
execute in class TaskBuildException - on error