org.apache.tools.ant.taskdefs.optional.net
Class FTP

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.optional.net.FTP

public class FTP
extends Task

Basic FTP client. Performs the following actions:

Note: Some FTP servers - notably the Solaris server - seem to hold data ports open after a "retr" operation, allowing them to timeout instead of shutting them down cleanly. This happens in active or passive mode, and the ports will remain open even after ending the FTP session. FTP "send" operations seem to close ports immediately. This behavior may cause problems on some systems when downloading large sets of files.

Since:
Ant 1.3

Nested Class Summary
static class FTP.Action
          an action to perform, one of "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", "rmdir"
protected  class FTP.FTPDirectoryScanner
          internal class allowing to read the contents of a remote file system using the FTP protocol used in particular for ftp get operations differences with DirectoryScanner "" (the root of the fileset) is never included in the included directories followSymlinks defaults to false
 
Field Summary
protected static java.lang.String[] ACTION_STRS
           
protected static java.lang.String[] ACTION_TARGET_STRS
           
protected static int CHMOD
           
protected static java.lang.String[] COMPLETED_ACTION_STRS
           
static int DEFAULT_FTP_PORT
          Default port for FTP
protected static int DEL_FILES
           
protected static int GET_FILES
           
protected static int LIST_FILES
           
protected static int MK_DIR
           
protected static int RM_DIR
           
protected static int SEND_FILES
           
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
FTP()
           
 
Method Summary
 void addFileset(FileSet set)
          A set of files to upload or download
protected  void checkConfiguration()
          Checks to see that all required parameters are set.
protected  void createParents(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String filename)
          Creates all parent directories specified in a complete relative pathname.
protected  void delFile(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String filename)
          Delete a file from the remote host.
protected  void doSiteCommand(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String theCMD)
          Sends a site command to the ftp server
 void execute()
          Runs the task.
protected  void getFile(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String dir, java.lang.String filename)
          Retrieve a single file from the remote host.
protected  boolean isUpToDate(org.apache.commons.net.ftp.FTPClient ftp, java.io.File localFile, java.lang.String remoteFile)
          Checks to see if the remote file is current as compared with the local file.
protected  void listFile(org.apache.commons.net.ftp.FTPClient ftp, java.io.BufferedWriter bw, java.lang.String filename)
          List information about a single file from the remote host.
protected  void makeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String dir)
          Create the specified directory on the remote host.
protected  java.lang.String resolveFile(java.lang.String file)
          Correct a file path to correspond to the remote host requirements.
protected  void rmDir(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String dirname)
          Delete a directory, if empty, from the remote host.
protected  void sendFile(org.apache.commons.net.ftp.FTPClient ftp, java.lang.String dir, java.lang.String filename)
          Sends a single file to the remote host.
 void setAction(FTP.Action action)
          Sets the FTP action to be taken.
 void setAction(java.lang.String action)
          Deprecated. setAction(String) is deprecated and is replaced with setAction(FTP.Action) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.
 void setBinary(boolean binary)
          If true, uses binary mode, otherwise text mode (default is binary).
 void setChmod(java.lang.String theMode)
          Sets the file permission mode (Unix only) for files sent to the server.
 void setDepends(boolean depends)
          Set to true to transmit only files that are new or changed from their remote counterparts.
 void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)
          set the flag to skip errors on directory creation.
 void setListing(java.io.File listing)
          The output file for the "list" action.
 void setNewer(boolean newer)
          A synonym for depends.
 void setPassive(boolean passive)
          Specifies whether to use passive mode.
 void setPassword(java.lang.String password)
          Sets the login password for the given user id.
 void setPort(int port)
          Sets the FTP port used by the remote server.
 void setPreserveLastModified(boolean preserveLastModified)
          Set to true to preserve modification times for "gotten" files.
 void setRemotedir(java.lang.String dir)
          Sets the remote directory where files will be placed.
 void setSeparator(java.lang.String separator)
          Sets the remote file separator character.
 void setServer(java.lang.String server)
          Sets the FTP server to send files to.
 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.
 void setTimeDiffAuto(boolean timeDiffAuto)
          "true" to find out automatically the time difference between local and remote machine.
 void setTimeDiffMillis(long timeDiffMillis)
          number of milliseconds to add to the time on the remote machine to get the time on the local machine.
 void setUmask(java.lang.String theUmask)
          Sets the default mask for file creation on a unix server.
 void setUserid(java.lang.String userid)
          Sets the login user id to use on the specified server.
 void setVerbose(boolean verbose)
          Set to true to receive notification about each file as it is transferred.
protected  void transferFiles(org.apache.commons.net.ftp.FTPClient ftp)
          Sends all files specified by the configured filesets to the remote server.
protected  int transferFiles(org.apache.commons.net.ftp.FTPClient ftp, FileSet fs)
          For each file in the fileset, do the appropriate action: send, get, delete, or list.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEND_FILES

protected static final int SEND_FILES
See Also:
Constant Field Values

GET_FILES

protected static final int GET_FILES
See Also:
Constant Field Values

DEL_FILES

protected static final int DEL_FILES
See Also:
Constant Field Values

LIST_FILES

protected static final int LIST_FILES
See Also:
Constant Field Values

MK_DIR

protected static final int MK_DIR
See Also:
Constant Field Values

CHMOD

protected static final int CHMOD
See Also:
Constant Field Values

RM_DIR

protected static final int RM_DIR
See Also:
Constant Field Values

DEFAULT_FTP_PORT

public static final int DEFAULT_FTP_PORT
Default port for FTP

See Also:
Constant Field Values

ACTION_STRS

protected static final java.lang.String[] ACTION_STRS

COMPLETED_ACTION_STRS

protected static final java.lang.String[] COMPLETED_ACTION_STRS

ACTION_TARGET_STRS

protected static final java.lang.String[] ACTION_TARGET_STRS
Constructor Detail

FTP

public FTP()
Method Detail

setRemotedir

public void setRemotedir(java.lang.String dir)
Sets the remote directory where files will be placed. This may be a relative or absolute path, and must be in the path syntax expected by the remote server. No correction of path syntax will be performed.

Parameters:
dir - the remote directory name.

setServer

public void setServer(java.lang.String server)
Sets the FTP server to send files to.

Parameters:
server - the remote server name.

setPort

public void setPort(int port)
Sets the FTP port used by the remote server.

Parameters:
port - the port on which the remote server is listening.

setUserid

public void setUserid(java.lang.String userid)
Sets the login user id to use on the specified server.

Parameters:
userid - remote system userid.

setPassword

public void setPassword(java.lang.String password)
Sets the login password for the given user id.

Parameters:
password - the password on the remote system.

setBinary

public void setBinary(boolean binary)
If true, uses binary mode, otherwise text mode (default is binary).

Parameters:
binary - if true use binary mode in transfers.

setPassive

public void setPassive(boolean passive)
Specifies whether to use passive mode. Set to true if you are behind a firewall and cannot connect without it. Passive mode is disabled by default.

Parameters:
passive - true is passive mode should be used.

setVerbose

public void setVerbose(boolean verbose)
Set to true to receive notification about each file as it is transferred.

Parameters:
verbose - true if verbose notifications are required.

setNewer

public void setNewer(boolean newer)
A synonym for depends. Set to true to transmit only new or changed files. See the related attributes timediffmillis and timediffauto.

Parameters:
newer - if true only transfer newer files.

setTimeDiffMillis

public void setTimeDiffMillis(long timeDiffMillis)
number of milliseconds to add to the time on the remote machine to get the time on the local machine. use in conjunction with newer

Parameters:
timeDiffMillis - number of milliseconds
Since:
ant 1.6

setTimeDiffAuto

public void setTimeDiffAuto(boolean timeDiffAuto)
"true" to find out automatically the time difference between local and remote machine. This requires right to create and delete a temporary file in the remote directory.

Parameters:
timeDiffAuto - true = find automatically the time diff
Since:
ant 1.6

setPreserveLastModified

public void setPreserveLastModified(boolean preserveLastModified)
Set to true to preserve modification times for "gotten" files.

Parameters:
preserveLastModified - if true preserver modification times.

setDepends

public void setDepends(boolean depends)
Set to true to transmit only files that are new or changed from their remote counterparts. The default is to transmit all files.

Parameters:
depends - if true only transfer newer files.

setSeparator

public void setSeparator(java.lang.String separator)
Sets the remote file separator character. This normally defaults to the Unix standard forward slash, but can be manually overridden using this call if the remote server requires some other separator. Only the first character of the string is used.

Parameters:
separator - the file separator on the remote system.

setChmod

public void setChmod(java.lang.String theMode)
Sets the file permission mode (Unix only) for files sent to the server.

Parameters:
theMode - unix style file mode for the files sent to the remote system.

setUmask

public void setUmask(java.lang.String theUmask)
Sets the default mask for file creation on a unix server.

Parameters:
theUmask - unix style umask for files created on the remote server.

addFileset

public void addFileset(FileSet set)
A set of files to upload or download

Parameters:
set - the set of files to be added to the list of files to be transferred.

setAction

public void setAction(java.lang.String action)
               throws BuildException
Deprecated. setAction(String) is deprecated and is replaced with setAction(FTP.Action) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.

Sets the FTP action to be taken. Currently accepts "put", "get", "del", "mkdir" and "list".

Parameters:
action - the FTP action to be performed.
Throws:
BuildException - if the action is not a valid action.

setAction

public void setAction(FTP.Action action)
               throws BuildException
Sets the FTP action to be taken. Currently accepts "put", "get", "del", "mkdir", "chmod" and "list".

Parameters:
action - the FTP action to be performed.
Throws:
BuildException - if the action is not a valid action.

setListing

public void setListing(java.io.File listing)
The output file for the "list" action. This attribute is ignored for any other actions.

Parameters:
listing - file in which to store the listing.

setSkipFailedTransfers

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.

Parameters:
skipFailedTransfers - true if failures in transfers are ignored.

setIgnoreNoncriticalErrors

public void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)
set the flag to skip errors on directory creation. (and maybe later other server specific errors)

Parameters:
ignoreNoncriticalErrors - true if non-critical errors should not cause a failure.

checkConfiguration

protected void checkConfiguration()
                           throws BuildException
Checks to see that all required parameters are set.

Throws:
BuildException - if the configuration is not valid.

transferFiles

protected int transferFiles(org.apache.commons.net.ftp.FTPClient ftp,
                            FileSet fs)
                     throws java.io.IOException,
                            BuildException
For each file in the fileset, do the appropriate action: send, get, delete, or list.

Parameters:
ftp - the FTPClient instance used to perform FTP actions
fs - the fileset on which the actions are performed.
Returns:
the number of files to be transferred.
Throws:
java.io.IOException - if there is a problem reading a file
BuildException - if there is a problem in the configuration.

transferFiles

protected void transferFiles(org.apache.commons.net.ftp.FTPClient ftp)
                      throws java.io.IOException,
                             BuildException
Sends all files specified by the configured filesets to the remote server.

Parameters:
ftp - the FTPClient instance used to perform FTP actions
Throws:
java.io.IOException - if there is a problem reading a file
BuildException - if there is a problem in the configuration.

resolveFile

protected java.lang.String resolveFile(java.lang.String file)
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.

Parameters:
file - the remote file name to be resolved
Returns:
the filename as it will appear on the server.

createParents

protected void createParents(org.apache.commons.net.ftp.FTPClient ftp,
                             java.lang.String filename)
                      throws java.io.IOException,
                             BuildException
Creates all parent directories specified in a complete relative pathname. Attempts to create existing directories will not cause errors.

Parameters:
ftp - the FTP client instance to use to execute FTP actions on the remote server.
filename - the name of the file whose parents should be created.
Throws:
java.io.IOException - under non documented circumstances
BuildException - if it is impossible to cd to a remote directory

isUpToDate

protected boolean isUpToDate(org.apache.commons.net.ftp.FTPClient ftp,
                             java.io.File localFile,
                             java.lang.String remoteFile)
                      throws java.io.IOException,
                             BuildException
Checks to see if the remote file is current as compared with the local file. Returns true if the target file is up to date.

Parameters:
ftp - ftpclient
localFile - local file
remoteFile - remote file
Returns:
true if the target file is up to date
Throws:
java.io.IOException - in unknown circumstances
BuildException - if the date of the remote files cannot be found and the action is GET_FILES

doSiteCommand

protected void doSiteCommand(org.apache.commons.net.ftp.FTPClient ftp,
                             java.lang.String theCMD)
                      throws java.io.IOException,
                             BuildException
Sends a site command to the ftp server

Parameters:
ftp - ftp client
theCMD - command to execute
Throws:
java.io.IOException - in unknown circumstances
BuildException - in unknown circumstances

sendFile

protected void sendFile(org.apache.commons.net.ftp.FTPClient ftp,
                        java.lang.String dir,
                        java.lang.String filename)
                 throws java.io.IOException,
                        BuildException
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.

Parameters:
ftp - ftp client
dir - base directory of the file to be sent (local)
filename - relative path of the file to be send locally relative to dir remotely relative to the remotedir attribute
Throws:
java.io.IOException - in unknown circumstances
BuildException - in unknown circumstances

delFile

protected void delFile(org.apache.commons.net.ftp.FTPClient ftp,
                       java.lang.String filename)
                throws java.io.IOException,
                       BuildException
Delete a file from the remote host.

Parameters:
ftp - ftp client
filename - file to delete
Throws:
java.io.IOException - in unknown circumstances
BuildException - if skipFailedTransfers is set to false and the deletion could not be done

rmDir

protected void rmDir(org.apache.commons.net.ftp.FTPClient ftp,
                     java.lang.String dirname)
              throws java.io.IOException,
                     BuildException
Delete a directory, if empty, from the remote host.

Parameters:
ftp - ftp client
dirname - directory to delete
Throws:
java.io.IOException - in unknown circumstances
BuildException - if skipFailedTransfers is set to false and the deletion could not be done

getFile

protected void getFile(org.apache.commons.net.ftp.FTPClient ftp,
                       java.lang.String dir,
                       java.lang.String filename)
                throws java.io.IOException,
                       BuildException
Retrieve a single file from 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.

Parameters:
ftp - the ftp client
dir - local base directory to which the file should go back
filename - relative path of the file based upon the ftp remote directory and/or the local base directory (dir)
Throws:
java.io.IOException - in unknown circumstances
BuildException - if skipFailedTransfers is false and the file cannot be retrieved.

listFile

protected void listFile(org.apache.commons.net.ftp.FTPClient ftp,
                        java.io.BufferedWriter bw,
                        java.lang.String filename)
                 throws java.io.IOException,
                        BuildException
List information about a single file from the remote host. filename may contain a relative path specification.

The file listing will then be retrieved 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.

Parameters:
ftp - ftp client
bw - buffered writer
filename - the directory one wants to list
Throws:
java.io.IOException - in unknown circumstances
BuildException - in unknown circumstances

makeRemoteDir

protected void makeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp,
                             java.lang.String dir)
                      throws java.io.IOException,
                             BuildException
Create the specified directory on the remote host.

Parameters:
ftp - The FTP client connection
dir - The directory to create (format must be correct for host type)
Throws:
java.io.IOException - in unknown circumstances
BuildException - if ignoreNoncriticalErrors has not been set to true and a directory could not be created, for instance because it was already existing. Precisely, the codes 521, 550 and 553 will trigger a BuildException

execute

public void execute()
             throws BuildException
Runs the task.

Overrides:
execute in class Task
Throws:
BuildException - if the task fails or is not configured correctly.


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.