org.jivesoftware.openfire.container

Class PluginManager

java.lang.Object

org.jivesoftware.openfire.container.PluginManager

public class PluginManager
extends Object

Loads and manages plugins. The plugins directory is monitored for any new plugins, and they are dynamically loaded.

An instance of this class can be obtained using:

XMPPServer.getInstance().getPluginManager()

Author:

Matt Tucker

See Also:

Plugin, XMPPServer.getPluginManager()

Constructor Summary

Constructors

Constructor and Description
PluginManager(File pluginDir) Constructs a new plugin manager.

Method Summary

Modifier and Type	Method and Description
void	addPluginListener(PluginListener listener) Registers a PluginListener, which will now start receiving events regarding plugin creation and destruction.
void	addPluginManagerListener(PluginManagerListener listener) Registers a PluginManagerListener, which will now start receiving events regarding plugin management.
void	deletePlugin(String pluginName) Delete a plugin, which removes the plugin.jar/war file after which the plugin is unloaded.
String	getAuthor(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getAuthor(Plugin).
String	getDatabaseKey(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getDatabaseKey(Plugin).
int	getDatabaseVersion(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getDatabaseVersion(Plugin).
String	getDescription(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getDescription(Plugin).
PluginDevEnvironment	getDevEnvironment(Plugin plugin) Returns a plugin's dev environment if development mode is enabled for the plugin.
License	getLicense(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getLicense(Plugin).
String	getMinServerVersion(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getMinServerVersion(Plugin).
String	getName(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getName(Plugin).
Plugin	getPlugin(String name) Returns a plugin by name or null if a plugin with that name does not exist.
PluginClassLoader	getPluginClassloader(Plugin plugin) Returns the classloader of a plugin.
File	getPluginDirectory(Plugin plugin) Deprecated. Use #getPluginPath() instead.
java.nio.file.Path	getPluginPath(Plugin plugin) Returns the plugin's directory.
Collection<Plugin>	getPlugins() Returns a Collection of all installed plugins.
java.nio.file.Path	getPluginsDirectory() Returns the directory that contains all plugins.
String	getVersion(Plugin plugin) Deprecated. Moved to PluginMetadataHelper.getVersion(Plugin).
boolean	installPlugin(InputStream in, String pluginFilename) Installs or updates an existing plugin.
boolean	isExecuted() Returns true if at least one attempt to load plugins has been done.
boolean	isMonitorTaskRunning()
boolean	isPluginDownloaded(String pluginFilename) Returns true if the specified filename, that belongs to a plugin, exists.
Class	loadClass(Plugin plugin, String className) Loads a class from the classloader of a plugin.
boolean	reloadPlugin(String pluginName)
void	removePluginListener(PluginListener listener) Deregisters a PluginListener, which will no longer receive events.
void	removePluginManagerListener(PluginManagerListener listener) Deregisters a PluginManagerListener, which will no longer receive events.
void	shutdown() Shuts down all running plugins.
void	start() Starts plugins and the plugin monitoring service.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

public PluginManager(File pluginDir)

Constructs a new plugin manager.

Parameters:

pluginDir - the directory containing all Openfire plugins, typically OPENFIRE_HOME/plugins/

Method Detail

start

public void start()

Starts plugins and the plugin monitoring service.

shutdown

public void shutdown()

Shuts down all running plugins.

getPluginsDirectory

public java.nio.file.Path getPluginsDirectory()

Returns the directory that contains all plugins. This typically is OPENFIRE_HOME/plugins.

Returns:

The directory that contains all plugins.

installPlugin

public boolean installPlugin(InputStream in,
                             String pluginFilename)

Installs or updates an existing plugin.

Parameters:

in - the input stream that contains the new plugin definition.

pluginFilename - the filename of the plugin to create or update.

Returns:

true if the plugin was successfully installed or updated.

isPluginDownloaded

public boolean isPluginDownloaded(String pluginFilename)

Returns true if the specified filename, that belongs to a plugin, exists.

Parameters:

pluginFilename - the filename of the plugin to create or update.

Returns:

true if the specified filename, that belongs to a plugin, exists.

getPlugins

public Collection<Plugin> getPlugins()

Returns a Collection of all installed plugins.

Returns:

a Collection of all installed plugins.

getPlugin

public Plugin getPlugin(String name)

Returns a plugin by name or null if a plugin with that name does not exist. The name is the name of the directory that the plugin is in such as "broadcast".

Parameters:

name - the name of the plugin.

Returns:

the plugin.

getPluginDirectory

@Deprecated
public File getPluginDirectory(Plugin plugin)

Deprecated. Use #getPluginPath() instead.

getPluginPath

public java.nio.file.Path getPluginPath(Plugin plugin)

Returns the plugin's directory.

Parameters:

plugin - the plugin.

Returns:

the plugin's directory.

isExecuted

public boolean isExecuted()

Returns true if at least one attempt to load plugins has been done. A true value does not mean that available plugins have been loaded nor that plugins to be added in the future are already loaded. :)

Returns:

true if at least one attempt to load plugins has been done.

deletePlugin

public void deletePlugin(String pluginName)

Delete a plugin, which removes the plugin.jar/war file after which the plugin is unloaded.

reloadPlugin

public boolean reloadPlugin(String pluginName)

loadClass

public Class loadClass(Plugin plugin,
                       String className)
                throws ClassNotFoundException,
                       IllegalAccessException,
                       InstantiationException

Loads a class from the classloader of a plugin.

Parameters:

plugin - the plugin.

className - the name of the class to load.

Returns:

the class.

Throws:

ClassNotFoundException - if the class was not found.

IllegalAccessException - if not allowed to access the class.

InstantiationException - if the class could not be created.

getDevEnvironment

public PluginDevEnvironment getDevEnvironment(Plugin plugin)

Returns a plugin's dev environment if development mode is enabled for the plugin.

Parameters:

plugin - the plugin.

Returns:

the plugin dev environment, or null if development mode is not enabled for the plugin.

getName

@Deprecated
public String getName(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getName(Plugin).

getDescription

@Deprecated
public String getDescription(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getDescription(Plugin).

getAuthor

@Deprecated
public String getAuthor(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getAuthor(Plugin).

getVersion

@Deprecated
public String getVersion(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getVersion(Plugin).

getMinServerVersion

@Deprecated
public String getMinServerVersion(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getMinServerVersion(Plugin).

getDatabaseKey

@Deprecated
public String getDatabaseKey(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getDatabaseKey(Plugin).

getDatabaseVersion

@Deprecated
public int getDatabaseVersion(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getDatabaseVersion(Plugin).

getLicense

@Deprecated
public License getLicense(Plugin plugin)

Deprecated. Moved to PluginMetadataHelper.getLicense(Plugin).

getPluginClassloader

public PluginClassLoader getPluginClassloader(Plugin plugin)

Returns the classloader of a plugin.

Parameters:

plugin - the plugin.

Returns:

the classloader of the plugin.

addPluginListener

public void addPluginListener(PluginListener listener)

Registers a PluginListener, which will now start receiving events regarding plugin creation and destruction. When the listener was already registered, this method will have no effect.

Parameters:

listener - the listener to be notified (cannot be null).

removePluginListener

public void removePluginListener(PluginListener listener)

Deregisters a PluginListener, which will no longer receive events. When the listener was never added, this method will have no effect.

Parameters:

listener - the listener to be removed (cannot be null).

addPluginManagerListener

public void addPluginManagerListener(PluginManagerListener listener)

Registers a PluginManagerListener, which will now start receiving events regarding plugin management.

Parameters:

listener - the listener to be notified (cannot be null).

removePluginManagerListener

public void removePluginManagerListener(PluginManagerListener listener)

Deregisters a PluginManagerListener, which will no longer receive events. When the listener was never added, this method will have no effect.

Parameters:

listener - the listener to be notified (cannot be null).

isMonitorTaskRunning

public boolean isMonitorTaskRunning()