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

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
              extended by org.apache.tools.ant.taskdefs.optional.ssh.Scp
All Implemented Interfaces:
java.lang.Cloneable, LogListener

public class Scp
extends SSHBase

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

Since:
Ant 1.6

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
Scp()
           
 
Method Summary
 void addFileset(FileSet set)
          Adds a FileSet transfer to remote host.
 void execute()
          Execute this task.
 void init()
          Initialize this task.
 void setFile(java.lang.String aFromUri)
          Sets the file to be transferred.
 void setLocalFile(java.lang.String aFromUri)
          Similiar to setFile but explicitly states that the file is a local file.
 void setLocalTodir(java.lang.String aToUri)
          Similiar 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 from remote system is to be preserved during copy.
 void setRemoteFile(java.lang.String aFromUri)
          Similiar to setFile but explicitly states that the file is a remote file.
 void setRemoteTodir(java.lang.String aToUri)
          Similiar 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.
 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
getFailonerror, getHost, getPort, getUserInfo, getVerbose, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener
log
 

Constructor Detail

Scp

public Scp()
Method Detail

setFile

public void setFile(java.lang.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.

setTodir

public void setTodir(java.lang.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.

setLocalFile

public void setLocalFile(java.lang.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.

Parameters:
aFromUri - a string representing the source of the copy.
Since:
Ant 1.6.2

setRemoteFile

public void setRemoteFile(java.lang.String aFromUri)
Similiar to setFile but explicitly states that the file is a remote file.

Parameters:
aFromUri - a string representing the source of the copy.
Since:
Ant 1.6.2

setLocalTodir

public void setLocalTodir(java.lang.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.

Parameters:
aToUri - a string representing the target of the copy.
Since:
Ant 1.6.2

setPreservelastmodified

public void setPreservelastmodified(boolean yesOrNo)
Sets flag to determine if file timestamp from remote system is to be preserved during copy.

Since:
Ant 1.8.0

setRemoteTodir

public void setRemoteTodir(java.lang.String aToUri)
Similiar to setTodir but explicitly states that the directory is a remote.

Parameters:
aToUri - a string representing the target of the copy.
Since:
Ant 1.6.2

setLocalTofile

public void setLocalTofile(java.lang.String aToUri)
Changes the file name to the given name while receiving it, only useful if receiving a single file.

Parameters:
aToUri - a string representing the target of the copy.
Since:
Ant 1.6.2

setRemoteTofile

public void setRemoteTofile(java.lang.String aToUri)
Changes the file name to the given name while sending it, only useful if sending a single file.

Parameters:
aToUri - a string representing the target of the copy.
Since:
Ant 1.6.2

setSftp

public void setSftp(boolean yesOrNo)
Setting this to true to use sftp protocol.

Parameters:
yesOrNo - if true sftp protocol will be used.

addFileset

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

Parameters:
set - FileSet to send to remote host.

init

public void init()
          throws BuildException
Initialize this task.

Overrides:
init in class SSHBase
Throws:
BuildException - on error

execute

public void execute()
             throws BuildException
Execute this task.

Overrides:
execute in class Task
Throws:
BuildException - on error