| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <title>Get Task</title> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css"> |
| </head> |
| |
| <body> |
| |
| <h2><a name="get">Get</a></h2> |
| <h3>Description</h3> |
| <p>Gets a file from a URL. When the verbose option is "on", this task |
| displays a '.' for every 100 Kb retrieved. Any URL schema supported by |
| the runtime is valid here, including http:, ftp: and jar:; |
| https: is only valid if the appropriate support is added to the pre-1.4 Java |
| runtimes. |
| |
| </p> |
| <p>This task should be preferred above the <a href="cvs.html">CVS task</a> when |
| fetching remote content. CVS is significantly slower than loading a compressed |
| archive compared to http/ftp.</p> |
| |
| The <i>usetimestamp</i> option enables you to control downloads so that the remote file is |
| only fetched if newer than the local copy. If there is no local copy, the download always takes |
| place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp, |
| if the JVM is Java1.2 or later. |
| NB: This timestamp facility only works on downloads using the HTTP protocol. |
| <p> |
| A username and password can be specified, in which case basic 'slightly encoded |
| plain text' authentication is used. This is only a secure authentication |
| mechanism over an HTTPS link. |
| <p> |
| If you need to go through a firewall, use |
| <a href="../OptionalTasks/setproxy.html"><setproxy></a> |
| to set up the proxy first. |
| </p> |
| |
| <h3>Parameters</h3> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td valign="top">src</td> |
| <td valign="top">the URL from which to retrieve a file.</td> |
| <td align="center" valign="top">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">dest</td> |
| <td valign="top">the file where to store the retrieved file.</td> |
| <td align="center" valign="top">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">verbose</td> |
| <td valign="top">show verbose progress information ("on"/"off").</td> |
| <td align="center" valign="top">No; default "false"</td> |
| </tr> |
| <tr> |
| <td valign="top">ignoreerrors</td> |
| <td valign="top">Log errors but don't treat as fatal.</td> |
| <td align="center" valign="top">No; default "false"</td> |
| </tr> |
| <tr> |
| <td valign="top">usetimestamp</td> |
| <td valign="top">conditionally download a file based on the timestamp of the |
| local copy. HTTP only</td> |
| <td align="center" valign="top">No; default "false"</td> |
| </tr> |
| <tr> |
| <td valign="top">username</td> |
| <td valign="top">username for 'BASIC' http authentication</td> |
| <td align="center" valign="top">if password is set</td> |
| </tr> |
| <tr> |
| <td valign="top">password</td> |
| <td valign="top">password: required </td> |
| <td align="center" valign="top">if username is set</td> |
| </tr> |
| |
| </table> |
| <h3>Examples</h3> |
| <pre> <get src="http://ant.apache.org/" dest="help/index.html"/></pre> |
| <p>Gets the index page of http://ant.apache.org/, and stores it in the file <code>help/index.html</code>.</p> |
| |
| <pre> <get src="http://www.apache.org/dist/ant/KEYS" |
| dest="KEYS" |
| verbose="true" |
| usetimestamp="true"/></pre> |
| <p> |
| Gets the PGP keys of Ant's (current and past) release managers, if the local copy |
| is missing or out of date. Uses the verbose option |
| for progress information. |
| </p> |
| |
| <pre> <get src="https://insecure-bank.org/statement/user=1214" |
| dest="statement.html" |
| username="1214"; |
| password="secret"/></pre> |
| <p> |
| Fetches some file from a server with access control. Because https is being used the |
| fact that basic auth sends passwords in plaintext is moot. |
| <hr> |
| <p align="center">Copyright © 2000-2003 Apache Software Foundation. All rights |
| Reserved.</p> |
| |
| </body> |
| </html> |
| |
