Task

<ftp2>

This task is a copy of the standard <ftp> task of APACHE ANT, extended with the capability to use FTP proxies, and makes use of Java's Authenticator for authentication.

Everything else is as with the original task, including the documentation that follows.

Basic FTP client. Performs the following actions:

• send - send files to a remote server. This is the default action.
• get - retrieve files from a remote server.
• del - delete files from a remote server.
• list - create a file listing.
• chmod - change unix file permissions.
• rmdir - remove directories, if empty, from a remote server.

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.

Attribute Summary

Attributes

Name	Description
account="..."	Sets the login account to use on the specified server.
action="..."	Deprecated. since 1.5.x. 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.
action="..."	Sets the FTP action to be taken.
binary="..."	If true, uses binary mode, otherwise text mode (default is binary).
chmod="..."	Sets the file permission mode (Unix only) for files sent to the server.
defaultDateFormatConfig="..."	Sets the defaultDateFormatConfig attribute.
depends="..."	Set to true to transmit only files that are new or changed from their remote counterparts.
enableRemoteVerification="..."	Whether to verify that data and control connections are connected to the same remote host.
ignoreNoncriticalErrors="..."	set the flag to skip errors on directory creation.
initialSiteCommand="..."	Sets the initialSiteCommand attribute.
listing="..."	The output file for the "list" action.
newer="..."	A synonym for depends.
passive="..."	Specifies whether to use passive mode.
password="..."	Sets the login password for the given user id.
port="..."	Sets the FTP port used by the remote server.
preserveLastModified="..."	Set to true to preserve modification times for "gotten" files.
proxyPort="..."	The port of the proxyServer="..." to use.
proxyServer="..."	If set, then the connection to the server="..." is not established directly, but through the designated FTP proxy server.
proxyUserid="...", proxyPassword="..."	If set, then authentication to the FTP proxy server is attempted with the designated user id and password.
recentDateFormatConfig="..."	Sets the recentDateFormatConfig attribute.
remotedir="..."	Sets the remote directory where files will be placed.
retriesAllowed="..."	Defines how many times to retry executing FTP command before giving up.
separator="..."	Sets the remote file separator character.
server="..."	Sets the FTP server to send files to.
serverLanguageCodeConfig="..."	Sets the serverLanguageCode attribute.
serverTimeZoneConfig="..."	Sets the serverTimeZoneConfig attribute.
shortMonthNamesConfig="..."	Sets the shortMonthNamesConfig attribute
siteCommand="..."	Sets the siteCommand attribute.
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.
systemTypeKey="..."	Sets the systemTypeKey attribute.
timeDiffAuto="..."	"true" to find out automatically the time difference between local and remote machine.
timeDiffMillis="..."	number of milliseconds to add to the time on the remote machine to get the time on the local machine.
timestampGranularity="..."	Sets the timestampGranularity attribute
umask="..."	Sets the default mask for file creation on a unix server.
userid="..."	Sets the login user id to use on the specified server.
verbose="..."	Set to true to receive notification about each file as it is transferred.

Subelement Summary

Subelements

Name	Description
<fileset>	A set of files to upload or download

Attribute Detail

Default values are underlined.

remotedir="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.

server="server"

Sets the FTP server to send files to.

port="port"

Sets the FTP port used by the remote server.

userid="userid"

Sets the login user id to use on the specified server.

password="password"

Sets the login password for the given user id.

account="p-account"

Sets the login account to use on the specified server.

proxyServer="host-name"

If set, then the connection to the server="..." is not established directly, but through the designated FTP proxy server.

See also:

InetAddress.getByName(String)

proxyPort="port-number|21"

The port of the proxyServer="..." to use.

proxyUserid="user-id", proxyPassword="password"

If set, then authentication to the FTP proxy server is attempted with the designated user id and password.

binary="true|false"

If true, uses binary mode, otherwise text mode (default is binary).

passive="true|false"

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.

verbose="true|false"

Set to true to receive notification about each file as it is transferred.

newer="true|false"

A synonym for depends. Set to true to transmit only new or changed files. See the related attributes timediffmillis and timediffauto.

timeDiffMillis="time-diff-millis"

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

timeDiffAuto="true|false"

"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.

preserveLastModified="true|false"

Set to true to preserve modification times for "gotten" files.

depends="true|false"

Set to true to transmit only files that are new or changed from their remote counterparts. The default is to transmit all files.

separator="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.

chmod="the-mode"

Sets the file permission mode (Unix only) for files sent to the server.

umask="the-umask"

Sets the default mask for file creation on a unix server.

action="action"

Deprecated. since 1.5.x. 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", "chmod", "list", and "site".

action="send|put|recv|get|del|delete|list|mkdir|chmod|rmdir|site"

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

listing="listing"

The output file for the "list" action. This attribute is ignored for any other actions.

skipFailedTransfers="true|false"

If true, enables unsuccessful file put, delete and get operations to be skipped with a warning and the remainder of the files still transferred.

ignoreNoncriticalErrors="true|false"

set the flag to skip errors on directory creation. (and maybe later other server specific errors)

systemTypeKey="UNIX|VMS|WINDOWS|OS/2|OS/400|MVS"

Sets the systemTypeKey attribute. Method for setting FTPClientConfig remote system key.

See also:

FTPClientConfig

defaultDateFormatConfig="default-date-format"

Sets the defaultDateFormatConfig attribute.

See also:

FTPClientConfig

recentDateFormatConfig="recent-date-format"

Sets the recentDateFormatConfig attribute.

See also:

FTPClientConfig

serverLanguageCodeConfig="da|de|en|es|fr|it|nl|no|pt|ro|sh|sk|sl|sq|sv"

Sets the serverLanguageCode attribute.

See also:

FTPClientConfig

serverTimeZoneConfig="server-time-zone-id"

Sets the serverTimeZoneConfig attribute.

See also:

FTPClientConfig

shortMonthNamesConfig="short-month-names"

Sets the shortMonthNamesConfig attribute

See also:

FTPClientConfig

retriesAllowed="retries-allowed"

Defines how many times to retry executing FTP command before giving up. Default is 0 - try once and if failure then give up.

timestampGranularity="MINUTE|NONE"

Sets the timestampGranularity attribute

siteCommand="site-command"

Sets the siteCommand attribute. This attribute names the command that will be executed if the action is "site".

initialSiteCommand="initial-command"

Sets the initialSiteCommand attribute. This attribute names a site command that will be executed immediately after connection.

enableRemoteVerification="true|false"

Whether to verify that data and control connections are connected to the same remote host.

Subelement Detail

<fileset>

A set of files to upload or download