| java.lang.Object
 com.sshtools.ant.SshSubTask
com.sshtools.ant.Sftp
| Sftp | | public class Sftp extends SshSubTask (Code) | | Basic SFTP client. Performs the following actions:
- put - send files to a remote server. This is the
default action.
- get - retreive files from a remote server.
- del - delete files from a remote server.
- chmod - changes the mode of files on a remote server.
|
| Inner Class :protected class SftpDirectoryScanner extends DirectoryScanner | |
| Inner Class :public static class Action extends EnumeratedAttribute | |
| Method Summary | |
| public void | addFileset(FileSet set)
| | protected void | checkConfiguration()
Checks to see that all required parameters are set. | | protected void | chmod(SftpClient sftp, String filename)
| | protected void | createParents(SftpClient sftp, String filename)
Creates all parent directories specified in a complete relative
pathname. | | protected void | delFile(SftpClient sftp, String filename)
Delete a file from the remote host. | | public void | execute(SshClient ssh)
Runs the task. | | protected void | executeSFTPTask(SshClient ssh)
| | protected void | getFile(SftpClient sftp, String dir, String filename)
Retrieve a single file to the remote host. | | protected boolean | isUpToDate(SftpClient sftp, File localFile, String remoteFile)
Checks to see if the remote file is current as compared with the local
file. | | protected void | makeRemoteDir(SftpClient sftp, String dir)
Create the specified directory on the remote host. | | protected String | resolveFile(String file)
Correct a file path to correspond to the remote host requirements. | | protected void | sendFile(SftpClient sftp, String dir, String filename)
Sends a single file to the remote host. | | public void | setAction(Action action)
Sets the FTP action to be taken. | | public void | setChmod(String theMode)
Sets the file permission mode (Unix only) for files sent to the server. | | public void | setDepends(boolean depends)
Set to true to transmit only files that are new or changed from their
remote counterparts. | | public void | setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)
set the flag to skip errors on directory creation. | | public void | setNewer(boolean newer)
A synonym for depends. | | public void | setRemotedir(String remotedir)
| | public void | setSkipFailedTransfers(boolean skipFailedTransfers)
If true, enables unsuccessful file put, delete and get
operations to be skipped with a warning and the remainder
of the files still transferred. | | public void | setVerbose(boolean verbose)
Set to true to receive notification about each file as it is
transferred. | | protected int | transferFiles(SftpClient sftp, FileSet fs)
For each file in the fileset, do the appropriate action: send, get,
delete, or list. | | protected void | transferFiles(SftpClient sftp)
Sends all files specified by the configured filesets to the remote
server. |
| ACTION_STRS | | final protected static String[] ACTION_STRS(Code) | | |
| CHMOD | | final protected static int CHMOD(Code) | | |
| COMPLETED_ACTION_STRS | | final protected static String[] COMPLETED_ACTION_STRS(Code) | | |
| DEL_FILES | | final protected static int DEL_FILES(Code) | | |
| GET_FILES | | final protected static int GET_FILES(Code) | | |
| MK_DIR | | final protected static int MK_DIR(Code) | | |
| SEND_FILES | | final protected static int SEND_FILES(Code) | | |
| addFileset | | public void addFileset(FileSet set)(Code) | | A set of files to upload or download
|
| checkConfiguration | | protected void checkConfiguration() throws BuildException(Code) | | Checks to see that all required parameters are set.
|
| createParents | | protected void createParents(SftpClient sftp, String filename) throws IOException, BuildException(Code) | | Creates all parent directories specified in a complete relative
pathname. Attempts to create existing directories will not cause
errors.
|
| execute | | public void execute(SshClient ssh) throws BuildException(Code) | | Runs the task.
|
| executeSFTPTask | | protected void executeSFTPTask(SshClient ssh) throws BuildException(Code) | | |
| getFile | | protected void getFile(SftpClient sftp, String dir, String filename) throws IOException, BuildException(Code) | | Retrieve a single file to the remote host. filename may
contain a relative path specification.
The file will then be retreived using the entire relative path spec -
no attempt is made to change directories. It is anticipated that this
may eventually cause problems with some FTP servers, but it simplifies
the coding.
|
| isUpToDate | | protected boolean isUpToDate(SftpClient sftp, File localFile, String remoteFile) throws IOException, BuildException(Code) | | Checks to see if the remote file is current as compared with the local
file. Returns true if the remote file is up to date.
|
| makeRemoteDir | | protected void makeRemoteDir(SftpClient sftp, String dir) throws BuildException(Code) | | Create the specified directory on the remote host.
Parameters:
sftp - The SFTP client connection
Parameters:
dir - The directory to create |
| resolveFile | | protected String resolveFile(String file)(Code) | | Correct a file path to correspond to the remote host requirements. This
implementation currently assumes that the remote end can handle
Unix-style paths with forward-slash separators. This can be overridden
with the separator task parameter. No attempt is made to
determine what syntax is appropriate for the remote host.
|
| sendFile | | protected void sendFile(SftpClient sftp, String dir, String filename) throws IOException, BuildException(Code) | | Sends a single file to the remote host. filename may
contain a relative path specification. When this is the case, sendFile
will attempt to create any necessary parent directories before sending
the file. The file will then be sent using the entire relative path
spec - no attempt is made to change directories. It is anticipated that
this may eventually cause problems with some FTP servers, but it
simplifies the coding.
|
| setAction | | public void setAction(Action action) throws BuildException(Code) | | Sets the FTP action to be taken. Currently accepts "put", "get", "del",
"mkdir", "chmod" and "list".
|
| setChmod | | public void setChmod(String theMode)(Code) | | Sets the file permission mode (Unix only) for files sent to the server.
|
| setDepends | | public void setDepends(boolean depends)(Code) | | Set to true to transmit only files that are new or changed from their
remote counterparts. The default is to transmit all files.
|
| setIgnoreNoncriticalErrors | | public void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)(Code) | | set the flag to skip errors on directory creation.
(and maybe later other server specific errors)
|
| setNewer | | public void setNewer(boolean newer)(Code) | | A synonym for depends. Set to true to transmit only new or changed
files.
|
| setRemotedir | | public void setRemotedir(String remotedir)(Code) | | Sets the remote working directory
|
| setSkipFailedTransfers | | public void setSkipFailedTransfers(boolean skipFailedTransfers)(Code) | | If true, enables unsuccessful file put, delete and get
operations to be skipped with a warning and the remainder
of the files still transferred.
|
| setVerbose | | public void setVerbose(boolean verbose)(Code) | | Set to true to receive notification about each file as it is
transferred.
|
| transferFiles | | protected int transferFiles(SftpClient sftp, FileSet fs) throws IOException, BuildException(Code) | | For each file in the fileset, do the appropriate action: send, get,
delete, or list.
|
| transferFiles | | protected void transferFiles(SftpClient sftp) throws IOException, BuildException(Code) | | Sends all files specified by the configured filesets to the remote
server.
|
|
|