org.apache.tools.ant.taskdefs.optional.ssh
Class Scp
- LogListener
Ant task for sending files to remote machine over ssh/scp.
- Ant 1.6
void | addFileset(FileSet set) - Adds a FileSet tranfer to remote host.
|
void | execute() - Called by the project to let the task do its work.
|
void | init() - Called by the project to let the task initialize properly.
|
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 | 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 |
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , 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.
execute
public void execute()
throws BuildException
Called by the project to let the task do its work. This method may be
called more than once, if the task is invoked more than once.
For example,
if target1 and target2 both depend on target3, then running
"ant target1 target2" will run all tasks in target3 twice.
- execute in interface Task
BuildException
- if something goes wrong with the build
init
public void init()
throws BuildException
Called by the project to let the task initialize properly.
The default implementation is a no-op.
- init in interface SSHBase
BuildException
- if something goes wrong with the build
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.
- Ant 1.6.2
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.
- Ant 1.6.2
setLocalTofile
public void setLocalTofile(String aToUri)
Changes the file name to the given name while receiving it,
only useful if receiving a single file.
- Ant 1.6.2
setRemoteFile
public void setRemoteFile(String aFromUri)
Similiar to
setFile
but explicitly states that
the file is a remote file.
- Ant 1.6.2
setRemoteTodir
public void setRemoteTodir(String aToUri)
Similiar to
setTodir
but explicitly states
that the directory is a remote.
- Ant 1.6.2
setRemoteTofile
public void setRemoteTofile(String aToUri)
Changes the file name to the given name while sending it,
only useful if sending a single file.
- Ant 1.6.2
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.
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.