org.apache.tools.ant.taskdefs
Class Get
Gets a particular file from a URL source.
Options include verbose reporting, timestamp based fetches and controlling
actions on failures. NB: access through a firewall only works if the whole
Java runtime is correctly configured.
boolean | doGet(int logLevel, Get.DownloadProgress progress) - make a get request, with the supplied progress and logging info.
|
void | execute() - Does the work.
|
void | setDest(File dest) - Where to copy the source file.
|
void | setIgnoreErrors(boolean v) - If true, log errors but do not treat as fatal.
|
void | setPassword(String p) - password for the basic authentication.
|
void | setSrc(URL u) - Set the URL to get.
|
void | setUseTimestamp(boolean v) - If true, conditionally download a file based on the timestamp
of the local copy.
|
void | setUsername(String u) - Username for basic auth.
|
void | setVerbose(boolean v) - If true, show verbose progress information.
|
execute , 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 |
doGet
public boolean doGet(int logLevel,
Get.DownloadProgress progress)
throws IOException
make a get request, with the supplied progress and logging info.
All the other config parameters are set at the task level,
source, dest, ignoreErrors, etc.
- true for a successful download, false otherwise.
The return value is only relevant when
ignoreErrors
is true, as
when false all failures raise BuildExceptions.
setDest
public void setDest(File dest)
Where to copy the source file.
setIgnoreErrors
public void setIgnoreErrors(boolean v)
If true, log errors but do not treat as fatal.
v
- if "true" then don't report download errors up to ant
setPassword
public void setPassword(String p)
password for the basic authentication.
p
- password for authentication
setSrc
public void setSrc(URL u)
Set the URL to get.
setUseTimestamp
public void setUseTimestamp(boolean v)
If true, conditionally download a file based on the timestamp
of the local copy.
In this situation, the if-modified-since header is set so
that the file is only fetched if it is newer than the local
file (or there is no local file) This flag is only valid on
HTTP connections, it is ignored in other cases. When the flag
is set, the local copy of the downloaded file will also have
its timestamp set to the remote file time.
Note that remote files of date 1/1/1970 (GMT) are treated as
'no timestamp', and web servers often serve files with a
timestamp in the future by replacing their timestamp with that
of the current time. Also, inter-computer clock differences can
cause no end of grief.
v
- "true" to enable file time fetching
setUsername
public void setUsername(String u)
Username for basic auth.
u
- username for authentication
setVerbose
public void setVerbose(boolean v)
If true, show verbose progress information.
v
- if "true" then be verbose
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.