Class Scp
java.lang.Object
org.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
- All Implemented Interfaces:
- Cloneable,- LogListener
Ant task for sending files to remote machine over ssh/scp.
- Since:
- Ant 1.6
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidadd(ResourceCollection res) Adds a ResourceCollection of local files to transfer to remote host.voidaddFileset(FileSet set) Adds a FileSet transfer to remote host.voidexecute()Execute this task.voidinit()Initialize this task.voidsetCompressed(boolean compressed) Sets flag to determine if compression should be used for the copy.voidsetDirMode(String dirMode) Set the dir mode, defaults to "755".voidSets the file to be transferred.voidsetFileMode(String fileMode) Set the file mode, defaults to "644".voidsetLocalFile(String aFromUri) Similar tosetFilebut explicitly states that the file is a local file.voidsetLocalTodir(String aToUri) Similar tosetTodirbut 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.voidsetPreservelastmodified(boolean yesOrNo) Sets flag to determine if file timestamp is to be preserved during copy.voidsetRemoteFile(String aFromUri) Similar tosetFilebut explicitly states that the file is a remote file.voidsetRemoteTodir(String aToUri) Similar tosetTodirbut 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.voidsetSftp(boolean yesOrNo) Setting this to true to use sftp protocol.voidSets the location where files will be transferred to.Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBaseaddConfiguredAdditionalConfig, getFailonerror, getHost, getPort, getServerAliveCountMax, getServerAliveIntervalSeconds, getSshConfig, getUserInfo, getVerbose, loadSshConfig, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setServerAliveCountMax, setServerAliveIntervalSeconds, setSshConfig, setTrust, setUsername, setVerboseMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListenerlog
- 
Constructor Details- 
Scppublic Scp()
 
- 
- 
Method Details- 
setFileSets 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.
 
- 
setTodirSets 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
- 
setRemoteFile
- 
setCompressedpublic void setCompressed(boolean compressed) Sets flag to determine if compression should be used for the copy.- Parameters:
- compressed- boolean
- Since:
- Ant 1.9.8
 
- 
setLocalTodir
- 
setPreservelastmodifiedpublic void setPreservelastmodified(boolean yesOrNo) Sets flag to determine if file timestamp is to be preserved during copy.- Parameters:
- yesOrNo- boolean
- Since:
- Ant 1.8.0
 
- 
setRemoteTodir
- 
setLocalTofileChanges 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
 
- 
setRemoteTofileChanges 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
 
- 
setSftppublic void setSftp(boolean yesOrNo) Setting this to true to use sftp protocol.- Parameters:
- yesOrNo- if true sftp protocol will be used.
 
- 
setFileModeSet the file mode, defaults to "644".- Parameters:
- fileMode- String
- Since:
- Ant 1.9.5
 
- 
setDirModeSet the dir mode, defaults to "755".- Parameters:
- dirMode- String
- Since:
- Ant 1.9.5
 
- 
addFilesetAdds a FileSet transfer to remote host. NOTE: Either addFileSet() or setFile() are required. But, not both.- Parameters:
- set- FileSet to send to remote host.
 
- 
addAdds a ResourceCollection of local files to transfer to remote host.- Parameters:
- res- ResourceCollection to send to remote host.
- Since:
- Ant 1.9.7
 
- 
initInitialize this task.- Overrides:
- initin class- SSHBase
- Throws:
- BuildException- on error
 
- 
executeExecute this task.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
 
-