| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
org.apache.tools.ant.taskdefs.optional.ssh.Scp
public class Scp
Ant task for sending files to remote machine over ssh/scp.
| 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 setFilebut explicitly states that
 the file is a local file. | 
|  void | setLocalTodir(java.lang.String aToUri)Similiar to setTodirbut 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 setFilebut explicitly states that
 the file is a remote file. | 
|  void | setRemoteTodir(java.lang.String aToUri)Similiar to setTodirbut 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 | 
|---|
public Scp()
| Method Detail | 
|---|
public void setFile(java.lang.String aFromUri)
aFromUri - a string representing the file to transfer.public void setTodir(java.lang.String aToUri)
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 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)
public 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 addFileset(FileSet set)
set - FileSet to send to remote host.
public void init()
          throws BuildException
init in class SSHBaseBuildException - on error
public void execute()
             throws BuildException
execute in class TaskBuildException - on error| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||