PluginHandler (JOSM)

java.lang.Object
- org.openstreetmap.josm.plugins.PluginHandler

```
public final class PluginHandler
extends Object
```
PluginHandler is basically a collection of static utility functions used to bootstrap and manage the loaded plugins.

Since:

1326

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PluginHandler.DeprecatedPlugin` Description of a deprecated plugin
`private static class`	`PluginHandler.UpdatePluginsMessagePanel`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TIME_BASED_UPDATE_INTERVAL` Default time-based update interval, in days (pluginmanager.time-based-update.interval)
`static Collection<PluginHandler.DeprecatedPlugin>`	`DEPRECATED_PLUGINS` Deprecated plugins that are removed on start
`static Collection<PluginProxy>`	`pluginList` All installed and loaded plugins (resp. their main classes)
`private static List<ClassLoader>`	`sources` Add here all ClassLoader whose resource should be searched.
`static String[]`	`UNMAINTAINED_PLUGINS` List of unmaintained plugins.

Constructor Summary

Constructors
Modifier Constructor and Description

private PluginHandler()

Constructors
Modifier	Constructor and Description
`private`	`PluginHandler()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addDownloadSelection(List<DownloadSelection> downloadSelections)`
`private static void`	`alertFailedPluginUpdate(Component parent, Collection<PluginInformation> plugins)`
`private static void`	`alertJOSMUpdateRequired(Component parent, String plugin, int requiredVersion)`
`private static void`	`alertMissingPluginInformation(Component parent, Collection<String> plugins)`
`private static void`	`alertMissingRequiredPlugin(Component parent, String plugin, Set<String> missingRequiredPlugin)` Alerts the user if a plugin required by another plugin is missing
`static List<PluginInformation>`	`buildListOfPluginsToLoad(Component parent, ProgressMonitor monitor)` Builds the set of plugins to load.
`static boolean`	`checkAndConfirmPluginUpdate(Component parent)` Checks whether the locally available plugins should be updated and asks the user if running an update is OK.
`static boolean`	`checkLoadPreconditions(Component parent, Collection<PluginInformation> plugins, PluginInformation plugin)` Checks whether all preconditions for loading the plugin `plugin` are met.
`static boolean`	`checkRequiredPluginsPreconditions(Component parent, Collection<PluginInformation> plugins, PluginInformation plugin, boolean local)` Checks if required plugins preconditions for loading the plugin `plugin` are met.
`private static boolean`	`confirmDeactivatingPluginAfterException(PluginProxy plugin)`
`static boolean`	`confirmDisablePlugin(Component parent, String reason, String name)` Ask the user for confirmation that a plugin shall be disabled.
`static ClassLoader`	`createClassLoader(Collection<PluginInformation> plugins)` Creates a class loader for loading plugin code.
`static void`	`disablePluginAfterException(Throwable e)` Checks whether the exception `e` was thrown by a plugin.
`private static void`	`filterDeprecatedPlugins(Component parent, Collection<String> plugins)` Removes deprecated plugins from a collection of plugins.
`private static void`	`filterUnmaintainedPlugins(Component parent, Collection<String> plugins)` Removes unmaintained plugins from a collection of plugins.
`private static Set<PluginInformation>`	`findRequiredPluginsToDownload(Collection<PluginInformation> pluginsToUpdate, List<PluginInformation> allPlugins, Set<PluginInformation> pluginsToDownload)`
`static File`	`findUpdatedJar(String name)` Replies the updated jar file for the given plugin name.
`static String`	`getBugReportText()` Returns the list of loaded plugins as a `String` to be displayed in status report.
`static JPanel`	`getInfoPanel()` Returns the list of loaded plugins as a `JPanel` to be displayed in About dialog.
`static Object`	`getPlugin(String name)` Returns the plugin of the specified name.
`private static PluginProxy`	`getPluginCausingException(Throwable ex)` Replies the plugin which most likely threw the exception `ex`.
`static void`	`getPreferenceSetting(Collection<PreferenceSettingFactory> settings)`
`static Collection<ClassLoader>`	`getResourceClassLoaders()`
`static void`	`installDownloadedPlugins(boolean dowarn)` Installs downloaded plugins.
`static boolean`	`isValidJar(File jar)` Determines if the specified file is a valid and accessible JAR file.
`static void`	`loadEarlyPlugins(Component parent, Collection<PluginInformation> plugins, ProgressMonitor monitor)` Loads plugins from `plugins` which have the flag `PluginInformation.early` set to true.
`static void`	`loadLatePlugins(Component parent, Collection<PluginInformation> plugins, ProgressMonitor monitor)` Loads plugins from `plugins` which have the flag `PluginInformation.early` set to false.
`private static Map<String,PluginInformation>`	`loadLocallyAvailablePluginInformation(ProgressMonitor monitor)` Loads locally available plugin information from local plugin jars and from cached plugin lists.
`static void`	`loadPlugin(Component parent, PluginInformation plugin, ClassLoader pluginClassLoader)` Loads and instantiates the plugin described by `plugin` using the class loader `pluginClassLoader`.
`static void`	`loadPlugins(Component parent, Collection<PluginInformation> plugins, ProgressMonitor monitor)` Loads the plugin in `plugins` from locally available jar files into memory.
`static void`	`refreshLocalUpdatedPluginInfo(Collection<PluginInformation> updatedPlugins)` Refreshes the given PluginInformation objects with new contents read from their corresponding jar file.
`static List<PluginInformation>`	`updatePlugins(Component parent, List<PluginInformation> plugins, ProgressMonitor monitor)` Updates the plugins in `plugins`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEPRECATED_PLUGINS
```
public static final Collection<PluginHandler.DeprecatedPlugin> DEPRECATED_PLUGINS
```
    Deprecated plugins that are removed on start
  - UNMAINTAINED_PLUGINS
```
public static final String[] UNMAINTAINED_PLUGINS
```
    List of unmaintained plugins. Not really up-to-date as the vast majority of plugins are not really maintained after a few months, sadly...
  - DEFAULT_TIME_BASED_UPDATE_INTERVAL
```
public static final int DEFAULT_TIME_BASED_UPDATE_INTERVAL
```
    Default time-based update interval, in days (pluginmanager.time-based-update.interval)
    
    See Also:
    
    Constant Field Values
  - pluginList
```
public static final Collection<PluginProxy> pluginList
```
    All installed and loaded plugins (resp. their main classes)
  - sources
```
private static final List<ClassLoader> sources
```
    Add here all ClassLoader whose resource should be searched.
- Constructor Detail
  - PluginHandler
```
private PluginHandler()
```
- Method Detail
  - getResourceClassLoaders
```
public static Collection<ClassLoader> getResourceClassLoaders()
```
  - filterDeprecatedPlugins
```
private static void filterDeprecatedPlugins(Component parent,
                                            Collection<String> plugins)
```
    Removes deprecated plugins from a collection of plugins. Modifies the collection plugins. Also notifies the user about removed deprecated plugins
    
    Parameters:
    
    parent - The parent Component used to display warning popup
    
    plugins - the collection of plugins
  - filterUnmaintainedPlugins
```
private static void filterUnmaintainedPlugins(Component parent,
                                              Collection<String> plugins)
```
    Removes unmaintained plugins from a collection of plugins. Modifies the collection plugins. Also removes the plugin from the list of plugins in the preferences, if necessary. Asks the user for every unmaintained plugin whether it should be removed.
    
    Parameters:
    
    plugins - the collection of plugins
  - checkAndConfirmPluginUpdate
```
public static boolean checkAndConfirmPluginUpdate(Component parent)
```
    Checks whether the locally available plugins should be updated and asks the user if running an update is OK. An update is advised if JOSM was updated to a new version since the last plugin updates or if the plugins were last updated a long time ago.
    
    Parameters:
    
    parent - the parent component relative to which the confirmation dialog is to be displayed
    
    Returns:
    
    true if a plugin update should be run; false, otherwise
  - alertMissingRequiredPlugin
```
private static void alertMissingRequiredPlugin(Component parent,
                                               String plugin,
                                               Set<String> missingRequiredPlugin)
```
    Alerts the user if a plugin required by another plugin is missing
    
    Parameters:
    
    parent - The parent Component used to display error popup
    
    plugin - the plugin
    
    missingRequiredPlugin - the missing required plugin
  - alertJOSMUpdateRequired
```
private static void alertJOSMUpdateRequired(Component parent,
                                            String plugin,
                                            int requiredVersion)
```
  - checkLoadPreconditions
```
public static boolean checkLoadPreconditions(Component parent,
                                             Collection<PluginInformation> plugins,
                                             PluginInformation plugin)
```
    Checks whether all preconditions for loading the plugin plugin are met. The current JOSM version must be compatible with the plugin and no other plugins this plugin depends on should be missing.
    
    Parameters:
    
    parent - The parent Component used to display error popup
    
    plugins - the collection of all loaded plugins
    
    plugin - the plugin for which preconditions are checked
    
    Returns:
    
    true, if the preconditions are met; false otherwise
  - checkRequiredPluginsPreconditions
```
public static boolean checkRequiredPluginsPreconditions(Component parent,
                                                        Collection<PluginInformation> plugins,
                                                        PluginInformation plugin,
                                                        boolean local)
```
    Checks if required plugins preconditions for loading the plugin plugin are met. No other plugins this plugin depends on should be missing.
    
    Parameters:
    
    parent - The parent Component used to display error popup
    
    plugins - the collection of all loaded plugins
    
    plugin - the plugin for which preconditions are checked
    
    local - Determines if the local or up-to-date plugin dependencies are to be checked.
    
    Returns:
    
    true, if the preconditions are met; false otherwise
    
    Since:
    
    5601
  - createClassLoader
```
public static ClassLoader createClassLoader(Collection<PluginInformation> plugins)
```
    Creates a class loader for loading plugin code.
    
    Parameters:
    
    plugins - the collection of plugins which are going to be loaded with this class loader
    
    Returns:
    
    the class loader
  - loadPlugin
```
public static void loadPlugin(Component parent,
                              PluginInformation plugin,
                              ClassLoader pluginClassLoader)
```
    Loads and instantiates the plugin described by plugin using the class loader pluginClassLoader.
    
    Parameters:
    
    parent - The parent component to be used for the displayed dialog
    
    plugin - the plugin
    
    pluginClassLoader - the plugin class loader
  - loadPlugins
```
public static void loadPlugins(Component parent,
                               Collection<PluginInformation> plugins,
                               ProgressMonitor monitor)
```
    Loads the plugin in plugins from locally available jar files into memory.
    
    Parameters:
    
    parent - The parent component to be used for the displayed dialog
    
    plugins - the list of plugins
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
  - loadEarlyPlugins
```
public static void loadEarlyPlugins(Component parent,
                                    Collection<PluginInformation> plugins,
                                    ProgressMonitor monitor)
```
    Loads plugins from plugins which have the flag PluginInformation.early set to true.
    
    Parameters:
    
    plugins - the collection of plugins
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
  - loadLatePlugins
```
public static void loadLatePlugins(Component parent,
                                   Collection<PluginInformation> plugins,
                                   ProgressMonitor monitor)
```
    Loads plugins from plugins which have the flag PluginInformation.early set to false.
    
    Parameters:
    
    parent - The parent component to be used for the displayed dialog
    
    plugins - the collection of plugins
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
  - loadLocallyAvailablePluginInformation
```
private static Map<String,PluginInformation> loadLocallyAvailablePluginInformation(ProgressMonitor monitor)
```
    Loads locally available plugin information from local plugin jars and from cached plugin lists.
    
    Parameters:
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
    
    Returns:
    
    the list of locally available plugin information
  - alertMissingPluginInformation
```
private static void alertMissingPluginInformation(Component parent,
                                                  Collection<String> plugins)
```
  - buildListOfPluginsToLoad
```
public static List<PluginInformation> buildListOfPluginsToLoad(Component parent,
                                                               ProgressMonitor monitor)
```
    Builds the set of plugins to load. Deprecated and unmaintained plugins are filtered out. This involves user interaction. This method displays alert and confirmation messages.
    
    Parameters:
    
    parent - The parent component to be used for the displayed dialog
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
    
    Returns:
    
    the set of plugins to load (as set of plugin names)
  - alertFailedPluginUpdate
```
private static void alertFailedPluginUpdate(Component parent,
                                            Collection<PluginInformation> plugins)
```
  - findRequiredPluginsToDownload
```
private static Set<PluginInformation> findRequiredPluginsToDownload(Collection<PluginInformation> pluginsToUpdate,
                                                                    List<PluginInformation> allPlugins,
                                                                    Set<PluginInformation> pluginsToDownload)
```
  - updatePlugins
```
public static List<PluginInformation> updatePlugins(Component parent,
                                                    List<PluginInformation> plugins,
                                                    ProgressMonitor monitor)
                                             throws IllegalArgumentException
```
    Updates the plugins in plugins.
    
    Parameters:
    
    parent - the parent component for message boxes
    
    plugins - the collection of plugins to update. Must not be null.
    
    monitor - the progress monitor. Defaults to NullProgressMonitor.INSTANCE if null.
    
    Throws:
    
    IllegalArgumentException - thrown if plugins is null
  - confirmDisablePlugin
```
public static boolean confirmDisablePlugin(Component parent,
                                           String reason,
                                           String name)
```
    Ask the user for confirmation that a plugin shall be disabled.
    
    Parameters:
    
    parent - The parent component to be used for the displayed dialog
    
    reason - the reason for disabling the plugin
    
    name - the plugin name
    
    Returns:
    
    true, if the plugin shall be disabled; false, otherwise
  - getPlugin
```
public static Object getPlugin(String name)
```
    Returns the plugin of the specified name.
    
    Parameters:
    
    name - The plugin name
    
    Returns:
    
    The plugin of the specified name, if installed and loaded, or null otherwise.
  - addDownloadSelection
```
public static void addDownloadSelection(List<DownloadSelection> downloadSelections)
```
  - getPreferenceSetting
```
public static void getPreferenceSetting(Collection<PreferenceSettingFactory> settings)
```
  - installDownloadedPlugins
```
public static void installDownloadedPlugins(boolean dowarn)
```
    Installs downloaded plugins. Moves files with the suffix ".jar.new" to the corresponding ".jar" files. If dowarn is true, this methods emits warning messages on the console if a downloaded but not yet installed plugin .jar can't be be installed. If dowarn is false, the installation of the respective plugin is sillently skipped.
    
    Parameters:
    
    dowarn - if true, warning messages are displayed; false otherwise
  - isValidJar
```
public static boolean isValidJar(File jar)
```
    Determines if the specified file is a valid and accessible JAR file.
    
    Parameters:
    
    jar - The fil to check
    
    Returns:
    
    true if file can be opened as a JAR file.
    
    Since:
    
    5723
  - findUpdatedJar
```
public static File findUpdatedJar(String name)
```
    Replies the updated jar file for the given plugin name.
    
    Parameters:
    
    name - The plugin name to find.
    
    Returns:
    
    the updated jar file for the given plugin name. null if not found or not readable.
    
    Since:
    
    5601
  - refreshLocalUpdatedPluginInfo
```
public static void refreshLocalUpdatedPluginInfo(Collection<PluginInformation> updatedPlugins)
```
    Refreshes the given PluginInformation objects with new contents read from their corresponding jar file.
    
    Parameters:
    
    updatedPlugins - The PluginInformation objects to update.
    
    Since:
    
    5601
  - confirmDeactivatingPluginAfterException
```
private static boolean confirmDeactivatingPluginAfterException(PluginProxy plugin)
```
  - getPluginCausingException
```
private static PluginProxy getPluginCausingException(Throwable ex)
```
    Replies the plugin which most likely threw the exception ex.
    
    Parameters:
    
    ex - the exception
    
    Returns:
    
    the plugin; null, if the exception probably wasn't thrown from a plugin
  - disablePluginAfterException
```
public static void disablePluginAfterException(Throwable e)
```
    Checks whether the exception e was thrown by a plugin. If so, conditionally deactivates the plugin, but asks the user first.
    
    Parameters:
    
    e - the exception
  - getBugReportText
```
public static String getBugReportText()
```
    Returns the list of loaded plugins as a String to be displayed in status report. Useful for bug reports.
    
    Returns:
    
    The list of loaded plugins (one plugin per line)
  - getInfoPanel
```
public static JPanel getInfoPanel()
```
    Returns the list of loaded plugins as a JPanel to be displayed in About dialog.
    
    Returns:
    
    The list of loaded plugins (one "line" of Swing components per plugin)

Class PluginHandler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEPRECATED_PLUGINS

UNMAINTAINED_PLUGINS

DEFAULT_TIME_BASED_UPDATE_INTERVAL

pluginList

sources

Constructor Detail

PluginHandler

Method Detail

getResourceClassLoaders

filterDeprecatedPlugins

filterUnmaintainedPlugins

checkAndConfirmPluginUpdate

alertMissingRequiredPlugin

alertJOSMUpdateRequired

checkLoadPreconditions

checkRequiredPluginsPreconditions

createClassLoader

loadPlugin

loadPlugins

loadEarlyPlugins

loadLatePlugins

loadLocallyAvailablePluginInformation

alertMissingPluginInformation

buildListOfPluginsToLoad

alertFailedPluginUpdate

findRequiredPluginsToDownload

updatePlugins

confirmDisablePlugin

getPlugin

addDownloadSelection

getPreferenceSetting

installDownloadedPlugins

isValidJar

findUpdatedJar

refreshLocalUpdatedPluginInfo

confirmDeactivatingPluginAfterException

getPluginCausingException

disablePluginAfterException

getBugReportText

getInfoPanel