Class DefaultPluginManager<App extends PluggableApplication, Plug extends Plugin>

java.lang.Object

net.thevpc.common.prs.plugin.DefaultPluginManager<App,Plug>

All Implemented Interfaces:

PluginManager<App,Plug>

public abstract class DefaultPluginManager<App extends PluggableApplication, Plug extends Plugin>
extends Object
implements PluginManager<App,Plug>

Author:

Taha BEN SALAH (taha.bensalah@gmail.com) %creationtime 15 nov. 2006 23:39:30

Constructor Summary

Constructors

Constructor	Description
DefaultPluginManager()

Method Summary

Modifier and Type	Method	Description
void	addPluginRepository(PluginRepository r)
void	build(ProgressMonitor monitor)
void	buildCreatePlugins(ProgressMonitor monitor)
protected void	buildEnd(ProgressMonitor monitor)
protected void	buildLookupExtensions(ProgressMonitor monitor)
protected void	buildLookupPlugins(ProgressMonitor monitor)
protected Map<String, ClassLoader>	buildPluginsHardClassLoaders()
protected Map<String, SoftClassLoader>	buildPluginSoftClassLoaders()
protected void	buildPostCreatePlugins(ProgressMonitor monitor)
protected void	buildPostLookupExtensions(ProgressMonitor monitor)
protected void	buildPostLookupPlugins(ProgressMonitor monitor)
protected void	buildPostPrepare(ProgressMonitor monitor)
protected void	buildPrepare(ProgressMonitor monitor)
protected void	buildStart(ProgressMonitor monitor)
void	checkValidPlugin(String plugin)
void	close()
protected String	computeDescriptorsCRC()
protected Plug	createPlugin(PluginDescriptor descriptor)
protected abstract Plug	createPluginImpl(PluginDescriptor descriptor)
String[]	getAllDependencies(String pluginId)
Plug[]	getAllPlugins()
App	getApplication()
Version	getApplicationVersion()	returns the SystemPlugin similar to getSystemPlugins()[0].
PluginDescriptor[]	getAvailablePluginDescriptors()
protected PluginManagerCache	getCache()
ClassLoader	getCoreClassLoader()
List<URL>	getCoreURLs()
protected String	getDescriptorsCRC()
Plug[]	getEnabledPlugins()	only valid plugins
ExtensionDescriptor[]	getExtensions()
LocalRepository	getLocalRepository()
Plug	getPlugin(String pluginId)
abstract Class<Plug>	getPluginClass()
PluginDescriptor	getPluginDescriptor(String id)
Collection<PluginDescriptor>	getPluginDescriptors()
PluginLoader	getPluginLoader()
PluginRepository[]	getPluginRepositories()
Plug[]	getPlugins(PluginFilter<Plug> filter)
Collection<Plug>	getPluginsList()
PluginDescriptor.Status	getPluginStatus(String pluginId)
File	getPluginVarFolder(String pluginId)
SoftClassLoader	getSoftCoreClassLoader()
Plug[]	getSystemPlugins()	All System/Core Plugins
Plug	getValidPlugin(String pluginId)
void	init(App app, Version applicationVersion)
void	initializeInstance(Object instance, FieldValueProviderManager fieldValueProviderManager, String pluginId)
void	installPlugin(String plugin, VersionInterval ve, boolean installDependencies)
void	installPlugin(URL newPluginUrl, boolean installDependencies)
boolean	isPluginEnabled(String pluginId)
boolean	isSafeMode()
PluginDescriptor	loadPluginDescriptor(URL url)
final PluginDescriptor	loadPluginDescriptor(URL url, ClassLoader parent)
void	registerPlugins()
boolean	registerPlugins(PluginDescriptor... descriptors)
void	removePluginRepository(PluginRepository r)
protected void	setCoreClassLoader(ClassLoader coreClassLoader)
protected void	setCoreURLs(List<URL> coreURLs)
protected void	setDescriptorsCRC(String CRC)
void	setLocalRepository(LocalRepository localRepository)
void	setSafeMode(boolean safeMode)	when safe mode new plugins will not be installed and all loaded plugions will be disabled
void	uninstallPlugin(String pluginId)
void	unregisterAvailablePlugins()
void	unregisterPlugin(String pluginId)

Methods inherited from class Object

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

Methods inherited from interface PluginManager

getPluginsFolder, getPluginsVarFolder

Constructor Details

DefaultPluginManager

public DefaultPluginManager()

Method Details

addPluginRepository

public void addPluginRepository(PluginRepository r)

Specified by:

addPluginRepository in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

removePluginRepository

public void removePluginRepository(PluginRepository r)

Specified by:

removePluginRepository in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getPluginRepositories

public PluginRepository[] getPluginRepositories()

Specified by:

getPluginRepositories in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getAvailablePluginDescriptors

public PluginDescriptor[] getAvailablePluginDescriptors()

Specified by:

getAvailablePluginDescriptors in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getSystemPlugins

public Plug[] getSystemPlugins()

Description copied from interface: PluginManager

All System/Core Plugins

Specified by:

getSystemPlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Returns:

Array of all registred System Plugins

init

public void init(App app,
 Version applicationVersion)
          throws PluginException

Specified by:

init in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

buildStart

protected void buildStart(ProgressMonitor monitor)
                   throws PluginException

Throws:

PluginException

buildEnd

protected void buildEnd(ProgressMonitor monitor)
                 throws PluginException

Throws:

PluginException

buildPostPrepare

protected void buildPostPrepare(ProgressMonitor monitor)
                         throws PluginException

Throws:

PluginException

buildPostLookupPlugins

protected void buildPostLookupPlugins(ProgressMonitor monitor)
                               throws PluginException

Throws:

PluginException

buildPostLookupExtensions

protected void buildPostLookupExtensions(ProgressMonitor monitor)
                                  throws PluginException

Throws:

PluginException

buildPostCreatePlugins

protected void buildPostCreatePlugins(ProgressMonitor monitor)
                               throws PluginException

Throws:

PluginException

buildPrepare

protected void buildPrepare(ProgressMonitor monitor)
                     throws PluginException

Throws:

PluginException

close

public void close()
           throws PluginException

Specified by:

close in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

registerPlugins

public void registerPlugins()
                     throws PluginException

Throws:

PluginException

installPlugin

public void installPlugin(URL newPluginUrl,
 boolean installDependencies)
                   throws PluginException

Specified by:

installPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

installPlugin

public void installPlugin(String plugin,
 VersionInterval ve,
 boolean installDependencies)
                   throws PluginException

Specified by:

installPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Parameters:

plugin - pluginId to look for in plugin repositories

installDependencies - if true, all dependent plugins will be installed too

Throws:

PluginException - if problem

uninstallPlugin

public void uninstallPlugin(String pluginId)
                     throws PluginException

Specified by:

uninstallPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

loadPluginDescriptor

public PluginDescriptor loadPluginDescriptor(URL url)
                                      throws PluginException

Throws:

PluginException

getPluginVarFolder

public File getPluginVarFolder(String pluginId)
                        throws PluginException

Specified by:

getPluginVarFolder in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

loadPluginDescriptor

public final PluginDescriptor loadPluginDescriptor(URL url,
 ClassLoader parent)
                                            throws PluginException

Throws:

PluginException

getPluginLoader

public PluginLoader getPluginLoader()

unregisterAvailablePlugins

public void unregisterAvailablePlugins()
                                throws PluginException

Specified by:

unregisterAvailablePlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

registerPlugins

public boolean registerPlugins(PluginDescriptor... descriptors)
                        throws InvalidPluginException

Specified by:

registerPlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Parameters:

descriptors -

Returns:

false if plugin is not yet registred but registration failes (class not found, etc) throws InvalidPluginException when desc is null throws PluginAlreadyRegistredException if already registred

Throws:

InvalidPluginException - when plugin is invalid

unregisterPlugin

public void unregisterPlugin(String pluginId)
                      throws PluginException

Specified by:

unregisterPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Throws:

PluginException

getEnabledPlugins

public Plug[] getEnabledPlugins()

Description copied from interface: PluginManager

only valid plugins

Specified by:

getEnabledPlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Returns:

all plugins

buildCreatePlugins

public void buildCreatePlugins(ProgressMonitor monitor)

getPluginClass

public abstract Class<Plug> getPluginClass()

getPluginsList

public Collection<Plug> getPluginsList()

getAllPlugins

public Plug[] getAllPlugins()

Specified by:

getAllPlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getPlugins

public Plug[] getPlugins(PluginFilter<Plug> filter)

Specified by:

getPlugins in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getPlugin

public Plug getPlugin(String pluginId)

Specified by:

getPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getValidPlugin

public Plug getValidPlugin(String pluginId)

Specified by:

getValidPlugin in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getPluginStatus

public PluginDescriptor.Status getPluginStatus(String pluginId)

Specified by:

getPluginStatus in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

isPluginEnabled

public boolean isPluginEnabled(String pluginId)

Specified by:

isPluginEnabled in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

createPlugin

protected Plug createPlugin(PluginDescriptor descriptor)

createPluginImpl

protected abstract Plug createPluginImpl(PluginDescriptor descriptor)

getApplication

public App getApplication()

Specified by:

getApplication in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getApplicationVersion

public Version getApplicationVersion()

Description copied from interface: PluginManager

returns the SystemPlugin similar to getSystemPlugins()[0]. should return null il no plugin specified. TODO? should add Specific Exception?

Specified by:

getApplicationVersion in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Returns:

the SystemPlugin

isSafeMode

public boolean isSafeMode()

setSafeMode

public void setSafeMode(boolean safeMode)

when safe mode new plugins will not be installed and all loaded plugions will be disabled

Parameters:

safeMode - true if no plugins hve to be loaded

checkValidPlugin

public void checkValidPlugin(String plugin)

getPluginDescriptors

public Collection<PluginDescriptor> getPluginDescriptors()

getPluginDescriptor

public PluginDescriptor getPluginDescriptor(String id)

Specified by:

getPluginDescriptor in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

computeDescriptorsCRC

protected String computeDescriptorsCRC()
                                throws IOException

Throws:

IOException

getDescriptorsCRC

protected String getDescriptorsCRC()

setDescriptorsCRC

protected void setDescriptorsCRC(String CRC)

buildLookupPlugins

protected void buildLookupPlugins(ProgressMonitor monitor)

getSoftCoreClassLoader

public SoftClassLoader getSoftCoreClassLoader()

Specified by:

getSoftCoreClassLoader in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

buildPluginSoftClassLoaders

protected Map<String, SoftClassLoader> buildPluginSoftClassLoaders()

buildPluginsHardClassLoaders

protected Map<String, ClassLoader> buildPluginsHardClassLoaders()

getCache

protected PluginManagerCache getCache()

build

public void build(ProgressMonitor monitor)

buildLookupExtensions

protected void buildLookupExtensions(ProgressMonitor monitor)

initializeInstance

public void initializeInstance(Object instance,
 FieldValueProviderManager fieldValueProviderManager,
 String pluginId)

Specified by:

initializeInstance in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getCoreURLs

public List<URL> getCoreURLs()

setCoreURLs

protected void setCoreURLs(List<URL> coreURLs)

getCoreClassLoader

public ClassLoader getCoreClassLoader()

Specified by:

getCoreClassLoader in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

setCoreClassLoader

protected void setCoreClassLoader(ClassLoader coreClassLoader)

getExtensions

public ExtensionDescriptor[] getExtensions()

Specified by:

getExtensions in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

setLocalRepository

public void setLocalRepository(LocalRepository localRepository)

getLocalRepository

public LocalRepository getLocalRepository()

Specified by:

getLocalRepository in interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

getAllDependencies

public String[] getAllDependencies(String pluginId)