org.apache.tools.ant.taskdefs.optional.ssh
Class Scp
- Cloneable, LogListener
Ant task for sending files to remote machine over ssh/scp.
void | addFileset(FileSet set) - Adds a FileSet tranfer to remote host.
|
void | execute() - Execute this task.
|
void | init() - Initialize this task.
|
void | setFile(String aFromUri) - Sets the file to be transferred.
|
void | setLocalFile(String aFromUri) - Similiar to
setFile but explicitly states that
the file is a local file.
|
void | setLocalTodir(String aToUri) - Similiar to
setTodir but explicitly states
that the directory is a local.
|
void | setLocalTofile(String aToUri) - Changes the file name to the given name while receiving it,
only useful if receiving a single file.
|
void | setRemoteFile(String aFromUri) - Similiar to
setFile but explicitly states that
the file is a remote file.
|
void | setRemoteTodir(String aToUri) - Similiar to
setTodir but explicitly states
that the directory is a remote.
|
void | setRemoteTofile(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(String aToUri) - Sets the location where files will be transferred to.
|
getFailonerror , getHost , getPort , getUserInfo , getVerbose , init , openSession , setFailonerror , setHost , setKeyfile , setKnownhosts , setPassphrase , setPassword , setPort , setTrust , setUsername , setVerbose |
bindToOwner , execute , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , log , log , maybeConfigure , perform , reconfigure , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
addFileset
public void addFileset(FileSet set)
Adds a FileSet tranfer to remote host. NOTE: Either
addFileSet() or setFile() are required. But, not both.
set
- FileSet to send to remote host.
setFile
public void setFile(String aFromUri)
Sets the file to be transferred. This can either be a remote
file or a local file. Remote files take the form:
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.
setLocalFile
public void setLocalFile(String aFromUri)
Similiar to
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.
setLocalTodir
public void setLocalTodir(String aToUri)
Similiar to
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.
setLocalTofile
public void setLocalTofile(String aToUri)
Changes the file name to the given name while receiving it,
only useful if receiving a single file.
aToUri
- a string representing the target of the copy.
setRemoteFile
public void setRemoteFile(String aFromUri)
Similiar to
setFile
but explicitly states that
the file is a remote file.
aFromUri
- a string representing the source of the copy.
setRemoteTodir
public void setRemoteTodir(String aToUri)
Similiar to
setTodir
but explicitly states
that the directory is a remote.
aToUri
- a string representing the target of the copy.
setRemoteTofile
public void setRemoteTofile(String aToUri)
Changes the file name to the given name while sending it,
only useful if sending a single file.
aToUri
- a string representing the target of the copy.
setSftp
public void setSftp(boolean yesOrNo)
Setting this to true to use sftp protocol.
yesOrNo
- if true sftp protocol will be used.
setTodir
public void setTodir(String aToUri)
Sets the location where files will be transferred to.
This can either be a remote directory or a local directory.
Remote directories take the form of:
user:password@host:/directory/path/
This parameter is required.
aToUri
- a string representing the target of the copy.