Modifier and Type	Class and Description
protected static class	Get.Base64Converter Provide this for Backward Compatibility.
public static interface	Get.DownloadProgress Interface implemented for reporting progress of downloading.
private class	Get.GetThread
public static class	Get.NullProgress do nothing with progress info
public static class	Get.VerboseProgress verbose progress system prints to some output stream

Field Summary

Modifier and Type	Field and Description
private boolean	authenticateOnRedirect
private static final int	BIG_BUFFER_SIZE
private static final String	DEFAULT_AGENT_PREFIX
private File	destination
private static final int	DOTS_PER_LINE
private static final FileUtils	FILE_UTILS
private static final String	GZIP_CONTENT_ENCODING
private Map<String, String>	headers
private static final String	HTTP
private static final int	HTTP_MOVED_TEMP
private static final String	HTTPS
private boolean	httpUseCaches
private boolean	ignoreErrors
private Mapper	mapperElement
private long	maxTime
private static final int	NUMBER_RETRIES
private int	numberRetries
private String	pword
private boolean	quiet
private static final int	REDIRECT_LIMIT
private boolean	skipExisting
private final Resources	sources
private boolean	tryGzipEncoding
private String	uname
private String	userAgent
private boolean	useTimestamp
private boolean	verbose

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	Get()

Method Summary

Modifier and Type	Method and Description
public void	add(final ResourceCollection ResourceCollection rc) Adds URLs to get.
public void	add(final FileNameMapper the mapper to add. fileNameMapper) Add a nested filenamemapper.
public void	addConfiguredHeader(Header to be added header) Add a nested header
private void	checkAttributes() Check the attributes.
public Mapper	Returns: a mapper to be configured. createMapper() Define the mapper to map source to destination files.
public boolean	Returns: true for a successful download, false otherwise. The return value is only relevant when `ignoreErrors` is true, as when false all failures raise BuildExceptions. doGet(final int level to log at, see `Project#log(String, int)` logLevel, final Get.DownloadProgress progress callback; null for no-callbacks progress) Deprecated only gets the first configured resource make a get request, with the supplied progress and logging info.
public boolean	Returns: true for a successful download, false otherwise. The return value is only relevant when `ignoreErrors` is true, as when false all failures raise BuildExceptions. doGet(final URL the URL to get source, final File the target file dest, final int level to log at, see `Project#log(String, int)` logLevel, Get.DownloadProgress progress callback; null for no-callbacks progress) make a get request, with the supplied progress and logging info.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Does the work.
public static boolean	isMoved(final int responseCode) Does the response code represent a redirection?
public void	log(final String The message to be logged. Should not be `null`. msg, final int The message priority at which this message is to be logged. msgLevel) Overrides org.apache.tools.ant.Task.log. Logs a message with the given priority.
public void	setAuthenticateOnRedirect(final boolean "true" to enable sending the credentials on redirect; "false" otherwise v) If true, credentials are set when following a redirect to a new location.
public void	setDest(final File Path to file. dest) Where to copy the source file.
public void	setHttpUseCaches(final boolean boolean httpUseCache) HTTP connections only - control caching on the HttpUrlConnection: httpConnection.setUseCaches(); if false, do not allow caching on the HttpUrlConnection.
public void	setIgnoreErrors(final boolean if "true" then don't report download errors up to ant v) If true, log errors but do not treat as fatal.
public void	setMaxTime(final long long maxTime) The time in seconds the download is allowed to take before being terminated.
public void	setPassword(final String password for authentication p) password for the basic authentication.
public void	setQuiet(final boolean if "true" then be quiet v) If true, set default log level to Project.MSG_ERR.
public void	setRetries(final int number of attempts to make r) The number of attempts to make for opening the URI, defaults to 3.
public void	setSkipExisting(final boolean "true" to skip existing destination files s) Skip files that already exist locally.
public void	setSrc(final URL URL for the file. u) Set an URL to get.
public void	setTryGzipEncoding(boolean boolean b) Whether to transparently try to reduce bandwidth by telling the server ant would support gzip encoding.
public void	setUserAgent(final String String userAgent) HTTP connections only - set the user-agent to be used when communicating with remote server.
public void	setUsername(final String username for authentication u) Username for basic auth.
public void	setUseTimestamp(final boolean "true" to enable file time fetching v) If true, conditionally download a file based on the timestamp of the local copy.
public void	setVerbose(final boolean if "true" then be verbose v) If true, show verbose progress information.

Field Detail

authenticateOnRedirect	back to summary
private boolean authenticateOnRedirect

BIG_BUFFER_SIZE	back to summary
private static final int BIG_BUFFER_SIZE

DEFAULT_AGENT_PREFIX	back to summary
private static final String DEFAULT_AGENT_PREFIX

destination	back to summary
private File destination

DOTS_PER_LINE	back to summary
private static final int DOTS_PER_LINE

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS

GZIP_CONTENT_ENCODING	back to summary
private static final String GZIP_CONTENT_ENCODING

headers	back to summary
private Map<String, String> headers

HTTP	back to summary
private static final String HTTP

HTTP_MOVED_TEMP	back to summary
private static final int HTTP_MOVED_TEMP

HTTPS	back to summary
private static final String HTTPS

httpUseCaches	back to summary
private boolean httpUseCaches

ignoreErrors	back to summary
private boolean ignoreErrors

mapperElement	back to summary
private Mapper mapperElement

maxTime	back to summary
private long maxTime

NUMBER_RETRIES	back to summary
private static final int NUMBER_RETRIES

numberRetries	back to summary
private int numberRetries

pword	back to summary
private String pword

quiet	back to summary
private boolean quiet

REDIRECT_LIMIT	back to summary
private static final int REDIRECT_LIMIT

skipExisting	back to summary
private boolean skipExisting

sources	back to summary
private final Resources sources

tryGzipEncoding	back to summary
private boolean tryGzipEncoding

uname	back to summary
private String uname

userAgent	back to summary
private String userAgent

useTimestamp	back to summary
private boolean useTimestamp

verbose	back to summary
private boolean verbose

Constructor Detail

Get	back to summary
public Get()

Method Detail

add	back to summary
public void add(final ResourceCollection rc) Adds URLs to get. Parameters rc:ResourceCollection ResourceCollection Since Ant 1.8.0

add

back to summary

public void add(final ResourceCollection rc)

Adds URLs to get.

Parameters

rc:ResourceCollection: ResourceCollection

Since

Ant 1.8.0

add	back to summary
public void add(final FileNameMapper fileNameMapper) Add a nested filenamemapper. Parameters fileNameMapper:FileNameMapper the mapper to add. Since Ant 1.8.0

add

back to summary

public void add(final FileNameMapper fileNameMapper)

Add a nested filenamemapper.

Parameters

fileNameMapper:FileNameMapper: the mapper to add.

Since

Ant 1.8.0

addConfiguredHeader	back to summary
public void addConfiguredHeader(Header header) Add a nested header Parameters header:Header to be added

checkAttributes	back to summary
private void checkAttributes() Check the attributes.

createMapper	back to summary
public Mapper createMapper() throws BuildException Define the mapper to map source to destination files. Returns:Mapper a mapper to be configured. Exceptions BuildException: if more than one mapper is defined. Since Ant 1.8.0

createMapper

back to summary

public Mapper createMapper() throws BuildException

Define the mapper to map source to destination files.

Returns:Mapper

a mapper to be configured.

Exceptions

BuildException:: if more than one mapper is defined.

Since

Ant 1.8.0

doGet back to summary

doGet	back to summary
public boolean doGet(final int logLevel, final Get.DownloadProgress progress) throws IOException Deprecated only gets the first configured resource 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. Parameters logLevel:int level to log at, see `Project#log(String, int)` progress:Get.DownloadProgress progress callback; null for no-callbacks Returns:boolean true for a successful download, false otherwise. The return value is only relevant when `ignoreErrors` is true, as when false all failures raise BuildExceptions. Annotations @Deprecated Exceptions IOException: for network trouble BuildException: for argument errors, or other trouble when ignoreErrors is false.

public boolean doGet(final int logLevel, final Get.DownloadProgress progress) throws IOException

Deprecated

only gets the first configured resource

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.

Parameters

logLevel:int: level to log at, see Project#log(String, int)
progress:Get.DownloadProgress: progress callback; null for no-callbacks

Returns:boolean

true for a successful download, false otherwise. The return value is only relevant when ignoreErrors is true, as when false all failures raise BuildExceptions.

Annotations

@Deprecated

Exceptions

IOException:: for network trouble
BuildException:: for argument errors, or other trouble when ignoreErrors is false.

doGet back to summary

doGet	back to summary
public boolean doGet(final URL source, final File dest, final int logLevel, Get.DownloadProgress progress) throws IOException make a get request, with the supplied progress and logging info. All the other config parameters like ignoreErrors are set at the task level. Parameters source:URL the URL to get dest:File the target file logLevel:int level to log at, see `Project#log(String, int)` progress:Get.DownloadProgress progress callback; null for no-callbacks Returns:boolean true for a successful download, false otherwise. The return value is only relevant when `ignoreErrors` is true, as when false all failures raise BuildExceptions. Exceptions IOException: for network trouble BuildException: for argument errors, or other trouble when ignoreErrors is false. Since Ant 1.8.0

public boolean doGet(final URL source, final File dest, final int logLevel, Get.DownloadProgress progress) throws IOException

make a get request, with the supplied progress and logging info. All the other config parameters like ignoreErrors are set at the task level.

Parameters

source:URL: the URL to get
dest:File: the target file
logLevel:int: level to log at, see Project#log(String, int)
progress:Get.DownloadProgress: progress callback; null for no-callbacks

Returns:boolean

true for a successful download, false otherwise. The return value is only relevant when ignoreErrors is true, as when false all failures raise BuildExceptions.

Exceptions

IOException:: for network trouble
BuildException:: for argument errors, or other trouble when ignoreErrors is false.

Since

Ant 1.8.0

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Does the work. Annotations @Override Exceptions BuildException: Thrown in unrecoverable error.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Does the work.

Annotations

@Override

Exceptions

BuildException:: Thrown in unrecoverable error.

isMoved	back to summary
public static boolean isMoved(final int responseCode) Does the response code represent a redirection? Since 1.10.10

isMoved

back to summary

public static boolean isMoved(final int responseCode)

Does the response code represent a redirection?

Since: 1.10.10

log back to summary

log	back to summary
public void log(final String msg, final int msgLevel) Overrides org.apache.tools.ant.Task.log. Doc from org.apache.tools.ant.Task.log. Logs a message with the given priority. This delegates the actual logging to the project. Parameters msg:String The message to be logged. Should not be `null`. msgLevel:int The message priority at which this message is to be logged. Annotations @Override

public void log(final String msg, final int msgLevel)

Overrides org.apache.tools.ant.Task.log.

Doc from org.apache.tools.ant.Task.log.

Logs a message with the given priority. This delegates the actual logging to the project.

Parameters

msg:String: The message to be logged. Should not be null.
msgLevel:int: The message priority at which this message is to be logged.

Annotations

@Override

setAuthenticateOnRedirect	back to summary
public void setAuthenticateOnRedirect(final boolean v) If true, credentials are set when following a redirect to a new location. Parameters v:boolean "true" to enable sending the credentials on redirect; "false" otherwise Since Ant 1.10.13

setAuthenticateOnRedirect

back to summary

public void setAuthenticateOnRedirect(final boolean v)

If true, credentials are set when following a redirect to a new location.

Parameters

v:boolean: "true" to enable sending the credentials on redirect; "false" otherwise

Since

Ant 1.10.13

setDest	back to summary
public void setDest(final File dest) Where to copy the source file. Parameters dest:File Path to file.

setDest

back to summary

public void setDest(final File dest)

Where to copy the source file.

Parameters

dest:File: Path to file.

setHttpUseCaches	back to summary
public void setHttpUseCaches(final boolean httpUseCache) HTTP connections only - control caching on the HttpUrlConnection: httpConnection.setUseCaches(); if false, do not allow caching on the HttpUrlConnection. Defaults to true (allow caching, which is also the HttpUrlConnection default value. Parameters httpUseCache:boolean boolean Since Ant 1.8.0

setHttpUseCaches

back to summary

public void setHttpUseCaches(final boolean httpUseCache)

HTTP connections only - control caching on the HttpUrlConnection: httpConnection.setUseCaches(); if false, do not allow caching on the HttpUrlConnection.

Defaults to true (allow caching, which is also the HttpUrlConnection default value.

Parameters

httpUseCache:boolean: boolean

Since

Ant 1.8.0

setIgnoreErrors	back to summary
public void setIgnoreErrors(final boolean v) If true, log errors but do not treat as fatal. Parameters v:boolean if "true" then don't report download errors up to ant

setIgnoreErrors

back to summary

public void setIgnoreErrors(final boolean v)

If true, log errors but do not treat as fatal.

Parameters

v:boolean: if "true" then don't report download errors up to ant

setMaxTime	back to summary
public void setMaxTime(final long maxTime) The time in seconds the download is allowed to take before being terminated. Parameters maxTime:long long Since Ant 1.8.0

setMaxTime

back to summary

public void setMaxTime(final long maxTime)

The time in seconds the download is allowed to take before being terminated.

Parameters

maxTime:long: long

Since

Ant 1.8.0

setPassword	back to summary
public void setPassword(final String p) password for the basic authentication. Parameters p:String password for authentication

setPassword

back to summary

public void setPassword(final String p)

password for the basic authentication.

Parameters

p:String: password for authentication

setQuiet	back to summary
public void setQuiet(final boolean v) If true, set default log level to Project.MSG_ERR. Parameters v:boolean if "true" then be quiet Since Ant 1.9.4

setQuiet

back to summary

public void setQuiet(final boolean v)

If true, set default log level to Project.MSG_ERR.

Parameters

v:boolean: if "true" then be quiet

Since

Ant 1.9.4

setRetries	back to summary
public void setRetries(final int r) The number of attempts to make for opening the URI, defaults to 3. The name of the method is misleading as a value of 1 means "don't retry on error" and a value of 0 meant don't even try to reach the URI at all. Parameters r:int number of attempts to make Since Ant 1.8.0

setRetries

back to summary

public void setRetries(final int r)

The number of attempts to make for opening the URI, defaults to 3.

The name of the method is misleading as a value of 1 means "don't retry on error" and a value of 0 meant don't even try to reach the URI at all.

Parameters

r:int: number of attempts to make

Since

Ant 1.8.0

setSkipExisting

back to summary

public void setSkipExisting(final boolean s)

Skip files that already exist locally.

Parameters

s:boolean: "true" to skip existing destination files

Since

Ant 1.8.0

setSrc

back to summary

public void setSrc(final URL u)

Set an URL to get.

Parameters

u:URL: URL for the file.

setTryGzipEncoding back to summary

public void setTryGzipEncoding(boolean b)

Whether to transparently try to reduce bandwidth by telling the server ant would support gzip encoding.

Setting this to true also means Ant will uncompress .tar.gz and similar files automatically.

Parameters

b:boolean: boolean

Since

Ant 1.9.5

setUserAgent

back to summary

public void setUserAgent(final String userAgent)

HTTP connections only - set the user-agent to be used when communicating with remote server. if null, then the value is considered unset and the behaviour falls back to the default of the http API.

Parameters

userAgent:String: String

Since

Ant 1.9.3

setUsername

back to summary

public void setUsername(final String u)

Username for basic auth.

Parameters

u:String: username for authentication

setUseTimestamp

back to summary

public void setUseTimestamp(final 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.

Parameters

v:boolean: "true" to enable file time fetching

setVerbose

back to summary

public void setVerbose(final boolean v)

If true, show verbose progress information.

Parameters

v:boolean: if "true" then be verbose

org.apache.tools.ant.taskdefs back to summary

public Interface Get.DownloadProgress

Known Direct Implementers: org.apache.tools.ant.taskdefs.Get.NullProgress, org.apache.tools.ant.taskdefs.Get.VerboseProgress

Interface implemented for reporting progress of downloading.

Method Summary

Modifier and Type	Method and Description
public void	beginDownload() begin a download
public void	endDownload() end a download
public void	onTick() tick handler

Method Detail

beginDownload	back to summary
public void beginDownload() begin a download

endDownload	back to summary
public void endDownload() end a download

onTick	back to summary
public void onTick() tick handler

org.apache.tools.ant.taskdefs back to summary

private Class Get.GetThread

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.apache.tools.ant.taskdefs.Get.GetThread

Field Summary

Modifier and Type	Field and Description
private URLConnection	connection
private final File	dest
private BuildException	exception
private final boolean	hasTimestamp
private IOException	ioexception
private InputStream	is
private final int	logLevel
private OutputStream	os
private final Get.DownloadProgress	progress
private int	redirections
private final URL	source
private boolean	success
private final long	timestamp
private String	userAgent

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
pack-priv	GetThread(final URL source, final File dest, final boolean h, final long t, final Get.DownloadProgress p, final int l, final String userAgent)

Method Summary

Modifier and Type	Method and Description
pack-priv void	closeStreams() Closes streams, interrupts the download, may delete the output file.
private boolean	downloadFile()
private boolean	get()
private URLConnection	openConnection(final URL aSource, final String uname, final String pword)
private boolean	redirectionAllowed(final URL aSource, final URL aDest)
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.
private void	updateTimeStamp()
pack-priv boolean	wasSuccessful() Has the download completed successfully?

Field Detail

connection	back to summary
private URLConnection connection

dest	back to summary
private final File dest

exception	back to summary
private BuildException exception

hasTimestamp	back to summary
private final boolean hasTimestamp

ioexception	back to summary
private IOException ioexception

is	back to summary
private InputStream is

logLevel	back to summary
private final int logLevel

os	back to summary
private OutputStream os

progress	back to summary
private final Get.DownloadProgress progress

redirections	back to summary
private int redirections

source	back to summary
private final URL source

success	back to summary
private boolean success

timestamp	back to summary
private final long timestamp

userAgent	back to summary
private String userAgent

Constructor Detail

GetThread	back to summary
pack-priv GetThread(final URL source, final File dest, final boolean h, final long t, final Get.DownloadProgress p, final int l, final String userAgent)

Method Detail

closeStreams	back to summary
pack-priv void closeStreams() Closes streams, interrupts the download, may delete the output file.

downloadFile	back to summary
private boolean downloadFile() throws IOException

get	back to summary
private boolean get() throws IOException, BuildException

openConnection	back to summary
private URLConnection openConnection(final URL aSource, final String uname, final String pword) throws IOException

redirectionAllowed	back to summary
private boolean redirectionAllowed(final URL aSource, final URL aDest)

run back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override

updateTimeStamp	back to summary
private void updateTimeStamp()

wasSuccessful

back to summary

pack-priv boolean wasSuccessful() throws IOException, BuildException

Has the download completed successfully?

Re-throws any exception caught during execution.

org.apache.tools.ant.taskdefs back to summary

public Class Get.NullProgress

Class Inheritance

extends Object
implements DownloadProgress

java.lang.Object
org.apache.tools.ant.taskdefs.Get.NullProgress

All Implemented Interfaces

org.apache.tools.ant.taskdefs.Get.DownloadProgress

do nothing with progress info

Constructor Summary

Access	Constructor and Description
public	NullProgress()

Method Summary

Modifier and Type	Method and Description
public void	beginDownload() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.beginDownload. begin a download
public void	endDownload() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.endDownload. end a download
public void	onTick() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.onTick. tick handler

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NullProgress	back to summary
public NullProgress()

Method Detail

beginDownload

back to summary

public void beginDownload()

Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.beginDownload.

begin a download

Annotations

@Override

endDownload

back to summary

public void endDownload()

Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.endDownload.

end a download

Annotations

@Override

onTick

back to summary

public void onTick()

Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.onTick.

tick handler

Annotations

@Override

org.apache.tools.ant.taskdefs back to summary

public Class Get.VerboseProgress

Class Inheritance

extends Object
implements DownloadProgress

java.lang.Object
org.apache.tools.ant.taskdefs.Get.VerboseProgress

All Implemented Interfaces

org.apache.tools.ant.taskdefs.Get.DownloadProgress

verbose progress system prints to some output stream

Field Summary

Modifier and Type	Field and Description
private int	dots
pack-priv PrintStream	out

Constructor Summary

Access	Constructor and Description
public	VerboseProgress(final PrintStream the output stream. out) Construct a verbose progress reporter.

Method Summary

Modifier and Type	Method and Description
public void	beginDownload() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.beginDownload. begin a download
public void	endDownload() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.endDownload. end a download
public void	onTick() Implements org.apache.tools.ant.taskdefs.Get.DownloadProgress.onTick. tick handler