Package ca.phon.plugin

Class PluginManager

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

ca.phon.plugin.PluginManager

All Implemented Interfaces:

Closeable, AutoCloseable

public class PluginManager
extends URLClassLoader

Reads the plugin def xml files and provides methods for adding plugin defined menu entries to window menus.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_FOLDER	Plugin folder

Method Summary

Modifier and Type	Method	Description
void	addClassLoader(ClassLoader classloader)
void	addFile(String path)	Add a zip/jar file to the dynamic class loader
void	addURL(URL url)
IPluginEntryPoint	getEntryPoint(String name)	Get the entry point identified by the given plugin id.
List<String>	getEntryPoints()	Get entry point names
<T> List<IPluginExtensionPoint<T>>	getExtensionPoints(Class<T> clazz)	Get the extension points for the given class.
<T> List<T>	getExtensions(Class<T> clazz)	Get initilized extension points for the given class.
static PluginManager	getInstance()	Get singleton instance
URL	getResource(String name)
URL	getResource(String name, boolean deep)
InputStream	getResourceAsStream(String name)
InputStream	getResourceAsStream(String name, boolean deep)
Enumeration<URL>	getResources(String name)
Enumeration<URL>	getResources(String name, boolean deep)
void	removeClassLoader(ClassLoader classloader)
void	scanPluginFolder()	Tell the plugin manager to scan plugins folder.
void	scanPluginFolder(File pluginFolder)

Methods inherited from class java.net.URLClassLoader

close, definePackage, findClass, findResource, findResources, getPermissions, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Field Details

PLUGIN_FOLDER

public static final String PLUGIN_FOLDER

Plugin folder

See Also:

• Constant Field Values

Method Details

getInstance

public static PluginManager getInstance()

Get singleton instance

addClassLoader

public void addClassLoader(ClassLoader classloader)

removeClassLoader

public void removeClassLoader(ClassLoader classloader)

scanPluginFolder

public void scanPluginFolder()

Tell the plugin manager to scan plugins folder.

scanPluginFolder

public void scanPluginFolder(File pluginFolder)

addFile

public void addFile(String path)
             throws MalformedURLException

Add a zip/jar file to the dynamic class loader

Parameters:

path -

Throws:

MalformedURLException

addURL

public void addURL(URL url)

Overrides:

addURL in class URLClassLoader

getResource

public URL getResource(String name)

Overrides:

getResource in class ClassLoader

getResource

public URL getResource(String name,
 boolean deep)

getResources

public Enumeration<URL> getResources(String name)
                              throws IOException

Overrides:

getResources in class ClassLoader

Throws:

IOException

getResources

public Enumeration<URL> getResources(String name,
 boolean deep)
                              throws IOException

Throws:

IOException

getResourceAsStream

public InputStream getResourceAsStream(String name)

Overrides:

getResourceAsStream in class URLClassLoader

getResourceAsStream

public InputStream getResourceAsStream(String name,
 boolean deep)

getEntryPoints

public List<String> getEntryPoints()

Get entry point names

Returns:

list of entry point ids

getEntryPoint

public IPluginEntryPoint getEntryPoint(String name)

Get the entry point identified by the given plugin id.

Parameters:

name - the name of the entry point to retrieve

Returns:

the plugin entry point or NULL if not found

getExtensions

public <T> List<T> getExtensions(Class<T> clazz)
                          throws PluginException

Get initilized extension points for the given class. This method should only be used when there is a default constructor available for the given class.

Parameters:

clazz -

Throws:

PluginException - if there is a problem with creating the list of objects.

getExtensionPoints

public <T> List<IPluginExtensionPoint<T>> getExtensionPoints(Class<T> clazz)

Get the extension points for the given class.

Parameters:

clazz - the class for extensions

Returns:

the list of loaded extension points for the given class