org.apache.tools.ant.taskdefs.optional.ssh

Class Scp

public class Scp extends SSHBase

Ant task for sending files to remote machine over ssh/scp.

Since: Ant 1.6

Method Summary
voidaddFileset(FileSet set)
Adds a FileSet tranfer to remote host.
voidexecute()
voidinit()
voidsetFile(String aFromUri)
Sets the file to be transferred.
voidsetLocalFile(String aFromUri)
Similiar to {@link #setFile setFile} but explicitly states that the file is a local file.
voidsetLocalTodir(String aToUri)
Similiar to {@link #setTodir setTodir} but explicitly states that the directory is a local.
voidsetLocalTofile(String aToUri)
Changes the file name to the given name while receiving it, only useful if receiving a single file.
voidsetRemoteFile(String aFromUri)
Similiar to {@link #setFile setFile} but explicitly states that the file is a remote file.
voidsetRemoteTodir(String aToUri)
Similiar to {@link #setTodir setTodir} but explicitly states that the directory is a remote.
voidsetRemoteTofile(String aToUri)
Changes the file name to the given name while sending it, only useful if sending a single file.
voidsetTodir(String aToUri)
Sets the location where files will be transferred to.

Method Detail

addFileset

public void addFileset(FileSet set)
Adds a FileSet tranfer to remote host. NOTE: Either addFileSet() or setFile() are required. But, not both.

Parameters: set FileSet to send to remote host.

execute

public void execute()

init

public void init()

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/*

Parameters: aFromUri a string representing the file to transfer.

setLocalFile

public void setLocalFile(String aFromUri)
Similiar to {@link #setFile setFile} but explicitly states that the file is a local file. This is the only way to specify a local file with a @ character.

Since: Ant 1.6.2

setLocalTodir

public void setLocalTodir(String aToUri)
Similiar to {@link #setTodir setTodir} but explicitly states that the directory is a local. This is the only way to specify a local directory with a @ character.

Since: 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.

Since: Ant 1.6.2

setRemoteFile

public void setRemoteFile(String aFromUri)
Similiar to {@link #setFile setFile} but explicitly states that the file is a remote file.

Since: Ant 1.6.2

setRemoteTodir

public void setRemoteTodir(String aToUri)
Similiar to {@link #setTodir setTodir} but explicitly states that the directory is a remote.

Since: 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.

Since: 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.

Parameters: aToUri a string representing the target of the copy.

Copyright