PluginStopper

java.lang.Object

net.i2p.router.web.PluginStarter

net.i2p.router.web.PluginStopper

All Implemented Interfaces:: Runnable

class PluginStopperextends PluginStarter

Stop all plugins that are installed and running.

Field Summary
Fields
Modifier and Type
Field
Description
private final Server
_server
The webapp server being stopped.
Fields inherited from class PluginStarter
_context, DELETED, ENABLED, java9Blacklist, jetty9Blacklist, PLUGIN_DIR, PREFIX
Modifier and Type
Field
Description
protected RouterContext
_context
The router context the plugins are started in.
static final String
DELETED
Value of the enabled property marking a plugin as deleted.
static final String
ENABLED
Suffix of the property recording whether a plugin starts at load, false, true, or deleted.
static final Map<String,String>
java9Blacklist
Plugin name to plugin version of plugins that do not work with Java 9+ Unmodifiable.
static final Map<String,String>
jetty9Blacklist
Plugin name to plugin version of plugins that do not work with Jetty 9, but do not have a max-jetty-version=8.9999 set.
static final String
PLUGIN_DIR
Directory under the router base holding the installed plugins.
static final String
PREFIX
Prefix of every plugin property key.
Constructor Summary
Constructors
Constructor
Description
PluginStopper(RouterContext ctx, Server server)
Remembers the jetty server whose plugins are to be stopped.
Method Summary
Modifier and Type
Method
Description
void
run()
Stops every running plugin.
private void
stopPlugins()
Stop all running plugins
Methods inherited from class PluginStarter
deletePlugin, disablePlugin, getPluginKeys, getPlugins, isPluginEnabled, isPluginRunning, isPluginRunning, pluginProperties, pluginProperties, pluginsEnabled, startPlugin, startPlugins, stopPlugin, stopPlugin, storePluginProperties, stripHTML, updateAll
Modifier and Type
Method
Description
static boolean
deletePlugin(RouterContext ctx, String appName)
Uninstall a plugin: run its client apps' uninstall commands, unregister its themes (falling back to the default theme if it is the current one), remove its directory and drop its plugins.config entries.
static void
disablePlugin(String appName)
Disable in plugins.config.
static Map<String,String>
getPluginKeys(I2PAppContext ctx)
The signing keys from all the plugins.
static List<String>
getPlugins()
All installed plugins whether enabled or not, but does NOT include plugins marked as deleted.
static boolean
isPluginEnabled(String appName)
Is the plugin enabled in plugins.config? Default true.
static boolean
isPluginRunning(String pluginName, RouterContext ctx)
Is any part of the plugin still up? Client threads, console webapps, queued client apps and registered client apps all count.
protected static boolean
isPluginRunning(String pluginName, RouterContext ctx, Server s)
Is any part of the plugin still up? Client threads, console webapps, queued client apps and registered client apps all count.
static Properties
pluginProperties()
Read the plugins.config file, this auto-adds a property for every dir in the plugin directory.
static Properties
pluginProperties(I2PAppContext ctx, String appName)
Read the plugin.config file for a single plugin.
static boolean
pluginsEnabled(I2PAppContext ctx)
Has the user allowed plugins to be started at all?
static boolean
startPlugin(RouterContext ctx, String appName)
Start a plugin: extract a pending update, enforce the min/max I2P, Java and Jetty version requirements, register its themes, client apps, console webapps, translation jars and summary bar link.
(package private) static void
startPlugins(RouterContext ctx)
Start every plugin whose plugins.config entry is "true", skipping any that an update already started.
static boolean
stopPlugin(RouterContext ctx, String appName)
Stop a plugin: shut down its client apps and console webapps, drop its summary bar link, and release its thread group, pending timers and ClassLoader cache.
protected static boolean
stopPlugin(RouterContext ctx, Server s, String appName)
Stop a plugin using an already-located console server, so this also works during shutdown after the server has been unregistered.
static void
storePluginProperties(Properties props)
Write the plugins.config file.
static String
stripHTML(Properties props, String key)
Like in DataHelper but doesn't convert null to "" There's a lot worse things a plugin could do but...
static void
updateAll(RouterContext ctx)
Starts the plugin update on a daemon thread, so the caller does not block.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _server
  private final Server _server
  The webapp server being stopped.
Constructor Details
- PluginStopper
  public PluginStopper(RouterContext ctx, Server server)
  Remembers the jetty server whose plugins are to be stopped.
  Parameters:
  ctx - the router context the plugin starter works against
  server - the jetty server whose running plugins are to be stopped
Method Details
- run
  public void run()
  Stops every running plugin.
  Specified by:
  run in interface Runnable
  Overrides:
  run in class PluginStarter
- stopPlugins
  private void stopPlugins()
  Stop all running plugins
  this shouldn't throw anything.

Field Summary

Fields inherited from class PluginStarter

Constructor Summary

Method Summary

Methods inherited from class PluginStarter

Methods inherited from class Object

Field Details

_server

Constructor Details

Method Details

run

stopPlugins