icy.plugin

Class PluginLoader

java.lang.Object

icy.plugin.PluginLoader

public class PluginLoader
extends java.lang.Object

Plugin Loader class.
This class is used to load plugins from "plugins" package and "plugins" directory

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginLoader.PluginClassLoader
static class	PluginLoader.PluginLoaderEvent
static interface	PluginLoader.PluginLoaderListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NEWER_JAVA_REQUIRED
static java.lang.String	PLUGIN_KERNEL_PACKAGE
static java.lang.String	PLUGIN_PACKAGE
static java.lang.String	PLUGIN_PATH

Method Summary

Methods

Modifier and Type	Method and Description
static void	addListener(PluginLoader.PluginLoaderListener listener) Add a listener
static void	checkPlugins(boolean showProgress) Check for missing plugins and install them if needed.
static java.util.ArrayList<PluginDescriptor>	getActionablePlugins() Return the list of "actionable" plugins (mean we can launch them from GUI).
static java.util.ArrayList<PluginDescriptor>	getActionablePlugins(boolean wantBundled) Return the list of "actionable" plugins (mean we can launch them from GUI).
static java.util.ArrayList<PluginDaemon>	getActiveDaemons() Returns the list of active daemon plugins.
static java.util.Map<java.lang.String,java.lang.Class<?>>	getAllClasses() Deprecated. Use getLoadedClasses() instead as we load classes on demand.
static java.util.Map<java.lang.String,java.net.URL>	getAllResources() Return all resources present in the Plugin class loader.
static java.util.ArrayList<PluginDescriptor>	getDaemonPlugins() Returns the list of daemon type plugins.
static java.util.Map<java.lang.String,java.lang.Class<?>>	getLoadedClasses() Return all loaded classes.
static java.util.Map<java.lang.String,byte[]>	getLoadedResources() Return content of all loaded resources.
static java.lang.ClassLoader	getLoader() Return the loader
static boolean	getLogError() Deprecated.
static PluginDescriptor	getPlugin(PluginDescriptor.PluginIdent ident, boolean acceptNewer) Returns the plugin corresponding to the specified plugin identity structure.
static PluginDescriptor	getPlugin(java.lang.String className) Returns the plugin corresponding to the specified plugin class name.
static java.lang.Class<? extends Plugin>	getPluginClass(java.lang.String className) Returns the plugin class corresponding to the specified plugin class name.
static java.util.ArrayList<PluginDescriptor>	getPlugins() Return the list of loaded plugins.
static java.util.ArrayList<PluginDescriptor>	getPlugins(boolean wantBundled) Return the list of loaded plugins.
static java.util.ArrayList<PluginDescriptor>	getPlugins(java.lang.Class<?> clazz) Return the list of loaded plugins which derive from the specified class.
static java.util.ArrayList<PluginDescriptor>	getPlugins(java.lang.Class<?> clazz, boolean wantBundled, boolean wantAbstract, boolean wantInterface) Return the list of loaded plugins which derive from the specified class.
static java.io.InputStream	getResourceAsStream(java.lang.String name) Return a resource as data stream from given resource name
static boolean	isJCLDisabled() Load all classes from specified path
static boolean	isLoaded(PluginDescriptor plugin, boolean acceptNewer) Returns true if the specified plugin exists in the PluginLoader.
static boolean	isLoaded(java.lang.String className) Returns true if the specified plugin class exists in the PluginLoader.
static boolean	isLoading()
static java.lang.Class<?>	loadClass(java.lang.String className) Try to load and returns the specified class from the PluginLoader.
static void	reload() Reload the list of installed plugins (wait for completion).
static void	reload(boolean forceNow) Deprecated. Use reload() instead.
static void	reloadAsynch() Reload the list of installed plugins (asynchronous version).
static void	removeListener(PluginLoader.PluginLoaderListener listener) Remove a listener
static void	resetDaemons() Stop and restart all daemons plugins.
static void	setJCLDisabled(boolean value)
static void	setLogError(boolean value) Deprecated.
static void	stopDaemons() Stop daemons plugins.
static java.lang.String	verifyPlugin(PluginDescriptor plugin) Verify the specified plugin is correctly installed.
static void	waitWhileLoading() wait until loading completed

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_PACKAGE

public static final java.lang.String PLUGIN_PACKAGE

See Also:

Constant Field Values

PLUGIN_KERNEL_PACKAGE

public static final java.lang.String PLUGIN_KERNEL_PACKAGE

See Also:

Constant Field Values

PLUGIN_PATH

public static final java.lang.String PLUGIN_PATH

See Also:

Constant Field Values

NEWER_JAVA_REQUIRED

public static final java.lang.String NEWER_JAVA_REQUIRED

See Also:

Constant Field Values

Method Detail

reloadAsynch

public static void reloadAsynch()

Reload the list of installed plugins (asynchronous version).

reload

public static void reload()

Reload the list of installed plugins (wait for completion).

reload

@Deprecated
public static void reload(boolean forceNow)

Deprecated. Use reload() instead.

resetDaemons

public static void resetDaemons()

Stop and restart all daemons plugins.

getDaemonPlugins

public static java.util.ArrayList<PluginDescriptor> getDaemonPlugins()

Returns the list of daemon type plugins.

getActiveDaemons

public static java.util.ArrayList<PluginDaemon> getActiveDaemons()

Returns the list of active daemon plugins.

stopDaemons

public static void stopDaemons()

Stop daemons plugins.

getLoader

public static java.lang.ClassLoader getLoader()

Return the loader

getAllResources

public static java.util.Map<java.lang.String,java.net.URL> getAllResources()

Return all resources present in the Plugin class loader.

getLoadedResources

public static java.util.Map<java.lang.String,byte[]> getLoadedResources()

Return content of all loaded resources.

getLoadedClasses

public static java.util.Map<java.lang.String,java.lang.Class<?>> getLoadedClasses()

Return all loaded classes.

getAllClasses

@Deprecated
public static java.util.Map<java.lang.String,java.lang.Class<?>> getAllClasses()

Deprecated. Use getLoadedClasses() instead as we load classes on demand.

Return all classes.

getResourceAsStream

public static java.io.InputStream getResourceAsStream(java.lang.String name)

Return a resource as data stream from given resource name

Parameters:

name - resource name

getPlugins

public static java.util.ArrayList<PluginDescriptor> getPlugins()

Return the list of loaded plugins.

getPlugins

public static java.util.ArrayList<PluginDescriptor> getPlugins(boolean wantBundled)

Return the list of loaded plugins.

Parameters:

wantBundled - specify if we also want plugin implementing the PluginBundled interface.

getPlugins

public static java.util.ArrayList<PluginDescriptor> getPlugins(java.lang.Class<?> clazz)

Return the list of loaded plugins which derive from the specified class.

Parameters:

clazz - The class object defining the class we want plugin derive from.

getPlugins

public static java.util.ArrayList<PluginDescriptor> getPlugins(java.lang.Class<?> clazz,
                                               boolean wantBundled,
                                               boolean wantAbstract,
                                               boolean wantInterface)

Return the list of loaded plugins which derive from the specified class.

Parameters:

clazz - The class object defining the class we want plugin derive from.

wantBundled - specify if we also want plugin implementing the PluginBundled interface

wantAbstract - specify if we also want abstract classes

wantInterface - specify if we also want interfaces

getActionablePlugins

public static java.util.ArrayList<PluginDescriptor> getActionablePlugins(boolean wantBundled)

Return the list of "actionable" plugins (mean we can launch them from GUI).

Parameters:

wantBundled - specify if we also want plugin implementing the PluginBundled interface

getActionablePlugins

public static java.util.ArrayList<PluginDescriptor> getActionablePlugins()

Return the list of "actionable" plugins (mean we can launch them from GUI).
By default plugin implementing the PluginBundled interface are also returned.

isLoading

public static boolean isLoading()

Returns:

the loading

waitWhileLoading

public static void waitWhileLoading()

wait until loading completed

isLoaded

public static boolean isLoaded(PluginDescriptor plugin,
               boolean acceptNewer)

Returns true if the specified plugin exists in the PluginLoader.

Parameters:

plugin - the plugin we are looking for.

acceptNewer - allow newer version of the plugin

isLoaded

public static boolean isLoaded(java.lang.String className)

Returns true if the specified plugin class exists in the PluginLoader.

Parameters:

className - class name of the plugin we are looking for.

getPlugin

public static PluginDescriptor getPlugin(PluginDescriptor.PluginIdent ident,
                         boolean acceptNewer)

Returns the plugin corresponding to the specified plugin identity structure.
Returns null if the plugin does not exists in the PluginLoader.

Parameters:

ident - plugin identity

acceptNewer - allow newer version of the plugin

getPlugin

public static PluginDescriptor getPlugin(java.lang.String className)

Returns the plugin corresponding to the specified plugin class name.
Returns null if the plugin does not exists in the PluginLoader.

Parameters:

className - class name of the plugin we are looking for.

getPluginClass

public static java.lang.Class<? extends Plugin> getPluginClass(java.lang.String className)

Returns the plugin class corresponding to the specified plugin class name.
Returns null if the plugin does not exists in the PluginLoader.

Parameters:

className - class name of the plugin we are looking for.

loadClass

public static java.lang.Class<?> loadClass(java.lang.String className)
                                    throws java.lang.ClassNotFoundException

Try to load and returns the specified class from the PluginLoader.
This method is equivalent to call getLoader() then call loadClass(String) method from it.

Parameters:

className - class name of the class we want to load.

Throws:

java.lang.ClassNotFoundException

verifyPlugin

public static java.lang.String verifyPlugin(PluginDescriptor plugin)

Verify the specified plugin is correctly installed.
Returns an empty string if the plugin is valid otherwise it returns the error message.

isJCLDisabled

public static boolean isJCLDisabled()

Load all classes from specified path

setJCLDisabled

public static void setJCLDisabled(boolean value)

getLogError

@Deprecated
public static boolean getLogError()

Deprecated.

setLogError

@Deprecated
public static void setLogError(boolean value)

Deprecated.

checkPlugins

public static void checkPlugins(boolean showProgress)

Check for missing plugins and install them if needed.

addListener

public static void addListener(PluginLoader.PluginLoaderListener listener)

Add a listener

Parameters:

listener -

removeListener

public static void removeListener(PluginLoader.PluginLoaderListener listener)

Remove a listener

Parameters:

listener -