org.openstreetmap.josm.plugins

Class ReadRemotePluginInformationTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.plugins.ReadRemotePluginInformationTask

All Implemented Interfaces:

java.lang.Runnable, ProgressMonitor.CancelListener

public class ReadRemotePluginInformationTask
extends PleaseWaitRunnable

An asynchronous task for downloading plugin lists from the configured plugin download sites.

Since:

2817

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<PluginInformation>	availablePlugins
private boolean	canceled
private HttpClient	connection
private boolean	displayErrMsg
private java.util.Collection<java.lang.String>	sites

Fields inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

progressMonitor

Constructor Summary

Constructors

Constructor and Description
ReadRemotePluginInformationTask(java.util.Collection<java.lang.String> sites) Constructs a new ReadRemotePluginInformationTask.
ReadRemotePluginInformationTask(ProgressMonitor monitor, java.util.Collection<java.lang.String> sites, boolean displayErrMsg) Constructs a new ReadRemotePluginInformationTask.

Method Summary

Modifier and Type	Method and Description
protected void	cachePluginList(java.lang.String site, java.lang.String list) Writes the list of plugins to a cache file
protected void	cancel() User pressed cancel button.
protected java.io.File	createSiteCacheFile(java.io.File pluginDir, java.lang.String site) Creates the file name for the cached plugin list and the icon cache file.
private static void	displayErrorMessage(ProgressMonitor monitor, java.lang.String msg, java.lang.String details, java.lang.String title, java.lang.String firstMessage)
protected java.lang.String	downloadPluginList(java.lang.String site, ProgressMonitor monitor) Downloads the list from a remote location
protected java.util.List<PluginInformation>	filterDeprecatedPlugins(java.util.List<PluginInformation> plugins) Filter information about deprecated plugins from the list of downloaded plugins
protected java.util.List<PluginInformation>	filterIrrelevantPlugins(java.util.List<PluginInformation> plugins)
protected void	finish() Finish up the data work.
java.util.List<PluginInformation>	getAvailablePlugins() Replies the list of plugins described in the downloaded plugin lists
private void	handleIOException(ProgressMonitor monitor, java.io.IOException e, java.lang.String details)
protected void	init(java.util.Collection<java.lang.String> sites, boolean displayErrMsg)
boolean	isCanceled() Replies true if the task was canceled
protected void	parsePluginListDocument(java.lang.String site, java.lang.String doc) Parses the plugin list
protected void	realRun() Called in the worker thread to do the actual work.

Methods inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

afterFinish, canRunInBackground, getProgressMonitor, operationCanceled, run

Methods inherited from class java.lang.Object

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

Field Detail

sites

private java.util.Collection<java.lang.String> sites

canceled

private boolean canceled

connection

private HttpClient connection

availablePlugins

private java.util.List<PluginInformation> availablePlugins

displayErrMsg

private boolean displayErrMsg

Constructor Detail

ReadRemotePluginInformationTask

public ReadRemotePluginInformationTask(java.util.Collection<java.lang.String> sites)

Constructs a new ReadRemotePluginInformationTask.

Parameters:

sites - the collection of download sites. Defaults to the empty collection if null.

ReadRemotePluginInformationTask

public ReadRemotePluginInformationTask(ProgressMonitor monitor,
                                       java.util.Collection<java.lang.String> sites,
                                       boolean displayErrMsg)

Constructs a new ReadRemotePluginInformationTask.

Parameters:

monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null

sites - the collection of download sites. Defaults to the empty collection if null.

displayErrMsg - if true, a blocking error message is displayed in case of I/O exception.

Method Detail

init

protected final void init(java.util.Collection<java.lang.String> sites,
                          boolean displayErrMsg)

cancel

protected void cancel()

Description copied from class: PleaseWaitRunnable

User pressed cancel button.

Specified by:

cancel in class PleaseWaitRunnable

finish

protected void finish()

Description copied from class: PleaseWaitRunnable

Finish up the data work. Is guaranteed to be called if realRun is called. Finish is called in the gui thread just after the dialog disappeared.

Specified by:

finish in class PleaseWaitRunnable

createSiteCacheFile

protected java.io.File createSiteCacheFile(java.io.File pluginDir,
                                           java.lang.String site)

Creates the file name for the cached plugin list and the icon cache file.

Parameters:

pluginDir - directory of plugin for data storage

site - the name of the site

Returns:

the file name for the cache file

downloadPluginList

protected java.lang.String downloadPluginList(java.lang.String site,
                                              ProgressMonitor monitor)

Downloads the list from a remote location

Parameters:

site - the site URL

monitor - a progress monitor

Returns:

the downloaded list

handleIOException

private void handleIOException(ProgressMonitor monitor,
                               java.io.IOException e,
                               java.lang.String details)

displayErrorMessage

private static void displayErrorMessage(ProgressMonitor monitor,
                                        java.lang.String msg,
                                        java.lang.String details,
                                        java.lang.String title,
                                        java.lang.String firstMessage)

cachePluginList

protected void cachePluginList(java.lang.String site,
                               java.lang.String list)

Writes the list of plugins to a cache file

Parameters:

site - the site from where the list was downloaded

list - the downloaded list

filterDeprecatedPlugins

protected java.util.List<PluginInformation> filterDeprecatedPlugins(java.util.List<PluginInformation> plugins)

Filter information about deprecated plugins from the list of downloaded plugins

Parameters:

plugins - the plugin informations

Returns:

the plugin informations, without deprecated plugins

filterIrrelevantPlugins

protected java.util.List<PluginInformation> filterIrrelevantPlugins(java.util.List<PluginInformation> plugins)

parsePluginListDocument

protected void parsePluginListDocument(java.lang.String site,
                                       java.lang.String doc)

Parses the plugin list

Parameters:

site - the site from where the list was downloaded

doc - the document with the plugin list

realRun

protected void realRun()
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       OsmTransferException

Description copied from class: PleaseWaitRunnable

Called in the worker thread to do the actual work. When any of the exception is thrown, a message box will be displayed and closeDialog is called. finish() is called in any case.

Specified by:

realRun in class PleaseWaitRunnable

Throws:

org.xml.sax.SAXException - if a SAX error occurs

java.io.IOException - if an I/O error occurs

OsmTransferException - if a communication error with the OSM server occurs

isCanceled

public boolean isCanceled()

Replies true if the task was canceled

Returns:

true if the task was stopped by the user

getAvailablePlugins

public java.util.List<PluginInformation> getAvailablePlugins()

Replies the list of plugins described in the downloaded plugin lists

Returns:

the list of plugins

Since:

5601