org.openstreetmap.josm.actions.downloadtasks

Class AbstractDownloadTask<T>

java.lang.Object

org.openstreetmap.josm.actions.downloadtasks.AbstractDownloadTask<T>

Type Parameters:

T - The downloaded data type

All Implemented Interfaces:

DownloadTask

Direct Known Subclasses:

DownloadGpsTask, DownloadNotesTask, DownloadOsmTask, DownloadSessionTask

public abstract class AbstractDownloadTask<T>
extends Object
implements DownloadTask

Common abstract implementation of other download tasks

Since:

2322

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	canceled
protected T	downloadedData
private List<Object>	errorMessages
private boolean	failed

Constructor Summary

Constructors

Constructor and Description
AbstractDownloadTask()

Method Summary

Modifier and Type	Method and Description
String	acceptsDocumentationSummary() Returns a short HTML documentation string, describing acceptable URLs.
boolean	acceptsUrl(String url)
boolean	acceptsUrl(String url, boolean isRemotecontrol) Returns true if the task is able to open the given URL, false otherwise.
T	getDownloadedData() Replies the downloaded data.
List<Object>	getErrorObjects() Replies the error objects of the task.
String[]	getPatterns() Returns regular expressions that match the URLs
String	getTitle() Returns human-readable description of the task
boolean	isCanceled()
boolean	isFailed()
boolean	isSafeForRemotecontrolRequests() Check / decide if the task is safe for remotecontrol.
protected void	rememberDownloadedData(T data)
protected void	rememberErrorMessage(String message)
protected void	rememberException(Exception exception)
void	setCanceled(boolean canceled)
void	setFailed(boolean failed)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openstreetmap.josm.actions.downloadtasks.DownloadTask

cancel, download, getConfirmationMessage, loadUrl

Field Detail

errorMessages

private final List<Object> errorMessages

canceled

private boolean canceled

failed

private boolean failed

downloadedData

protected T downloadedData

Constructor Detail

AbstractDownloadTask

public AbstractDownloadTask()

Method Detail

isCanceled

public boolean isCanceled()

setCanceled

public void setCanceled(boolean canceled)

isFailed

public boolean isFailed()

setFailed

public void setFailed(boolean failed)

rememberErrorMessage

protected final void rememberErrorMessage(String message)

rememberException

protected final void rememberException(Exception exception)

rememberDownloadedData

protected final void rememberDownloadedData(T data)

getDownloadedData

public final T getDownloadedData()

Replies the downloaded data.

Returns:

The downloaded data.

getErrorObjects

public List<Object> getErrorObjects()

Description copied from interface: DownloadTask

Replies the error objects of the task. Empty list, if no error messages are available. Error objects are either Strings with error messages or Exceptions.

Specified by:

getErrorObjects in interface DownloadTask

Returns:

the list of error objects

acceptsDocumentationSummary

public String acceptsDocumentationSummary()

Description copied from interface: DownloadTask

Returns a short HTML documentation string, describing acceptable URLs.

Specified by:

acceptsDocumentationSummary in interface DownloadTask

Returns:

The HTML documentation

acceptsUrl

public boolean acceptsUrl(String url)

isSafeForRemotecontrolRequests

public boolean isSafeForRemotecontrolRequests()

Check / decide if the task is safe for remotecontrol. Keep in mind that a potential attacker has full control over the content of the file that will be downloaded. If it is possible to run arbitrary code or write to the local file system, then the task is (obviously) not save for remote execution. The default value is false = unsafe. Override in a subclass to allow running the task via remotecontol.

Returns:

true if it is safe to download and open any file of the corresponding format, false otherwise

acceptsUrl

public boolean acceptsUrl(String url,
                          boolean isRemotecontrol)

Description copied from interface: DownloadTask

Returns true if the task is able to open the given URL, false otherwise.

Specified by:

acceptsUrl in interface DownloadTask

Parameters:

url - the url to download from

isRemotecontrol - True if download request comes from remotecontrol.

Returns:

True if the task is able to open the given URL, false otherwise. Return false, if the request comes from remotecontrol, but the task is not safe for remotecontrol. A task is not safe for remotecontrol if it is possible to prepare a file for download which does something unintended, e.g. gain access to the local file system.

getTitle

public String getTitle()

Description copied from interface: DownloadTask

Returns human-readable description of the task

Specified by:

getTitle in interface DownloadTask

Returns:

The task description

toString

public String toString()

Overrides:

toString in class Object

getPatterns

public String[] getPatterns()

Description copied from interface: DownloadTask

Returns regular expressions that match the URLs

Specified by:

getPatterns in interface DownloadTask

Returns:

The array of accepted URL patterns