Interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

All Known Implementing Classes:

DefaultPluginManager

public interface PluginManager<App extends PluggableApplication, Plug extends Plugin>

Author:

Taha Ben Salah (taha.bensalah@gmail.com) %creationtime 27 août 2007 19:39:24

Method Summary

Modifier and Type	Method	Description
void	addPluginRepository(PluginRepository r)
void	close()
Plug[]	getAllPlugins()
App	getApplication()
Version	getApplicationVersion()	returns the SystemPlugin similar to getSystemPlugins()[0].
PluginDescriptor[]	getAvailablePluginDescriptors()
ClassLoader	getCoreClassLoader()
Plug[]	getEnabledPlugins()	only valid plugins
ExtensionDescriptor[]	getExtensions()
LocalRepository	getLocalRepository()
Plug	getPlugin(String pluginId)
PluginDescriptor	getPluginDescriptor(String id)
PluginRepository[]	getPluginRepositories()
Plug[]	getPlugins(PluginFilter<Plug> filter)
BlendedFile	getPluginsFolder()
PluginDescriptor.Status	getPluginStatus(String pluginId)
File	getPluginsVarFolder()
File	getPluginVarFolder(String pluginId)
SoftClassLoader	getSoftCoreClassLoader()
Plug[]	getSystemPlugins()	All System/Core Plugins
Plug	getValidPlugin(String pluginId)
void	init(App application, 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	registerPlugins(PluginDescriptor... infos)
void	removePluginRepository(PluginRepository r)
void	uninstallPlugin(String pluginId)
void	unregisterAvailablePlugins()
void	unregisterPlugin(String pluginId)

Method Details

getAllPlugins

Plug[] getAllPlugins()

getEnabledPlugins

Plug[] getEnabledPlugins()

only valid plugins

Returns:

all plugins

getPlugins

Plug[] getPlugins(PluginFilter<Plug> filter)

init

void init(App application,
 Version applicationVersion)

registerPlugins

boolean registerPlugins(PluginDescriptor... infos)
                 throws InvalidPluginException

Parameters:

infos -

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

void unregisterPlugin(String pluginId)
               throws PluginException

Throws:

PluginException

getPlugin

Plug getPlugin(String pluginId)

getValidPlugin

Plug getValidPlugin(String pluginId)

getPluginStatus

PluginDescriptor.Status getPluginStatus(String pluginId)

isPluginEnabled

boolean isPluginEnabled(String pluginId)

unregisterAvailablePlugins

void unregisterAvailablePlugins()
                         throws PluginException

Throws:

PluginException

getApplication

App getApplication()

close

void close()

installPlugin

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

Parameters:

plugin - pluginId to look for in plugin repositories

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

Throws:

PluginException - if problem

installPlugin

void installPlugin(URL newPluginUrl,
 boolean installDependencies)
            throws PluginException

Throws:

PluginException

uninstallPlugin

void uninstallPlugin(String pluginId)
              throws PluginException

Throws:

PluginException

addPluginRepository

void addPluginRepository(PluginRepository r)

removePluginRepository

void removePluginRepository(PluginRepository r)

getPluginRepositories

PluginRepository[] getPluginRepositories()

getAvailablePluginDescriptors

PluginDescriptor[] getAvailablePluginDescriptors()

getSystemPlugins

Plug[] getSystemPlugins()

All System/Core Plugins

Returns:

Array of all registred System Plugins

getApplicationVersion

Version getApplicationVersion()

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

Returns:

the SystemPlugin

getPluginDescriptor

PluginDescriptor getPluginDescriptor(String id)

getPluginVarFolder

File getPluginVarFolder(String pluginId)
                 throws PluginException

Throws:

PluginException

initializeInstance

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

getPluginsVarFolder

File getPluginsVarFolder()
                  throws PluginException

Throws:

PluginException

getPluginsFolder

BlendedFile getPluginsFolder()
                      throws PluginException

Throws:

PluginException

getExtensions

ExtensionDescriptor[] getExtensions()

getLocalRepository

LocalRepository getLocalRepository()

getSoftCoreClassLoader

SoftClassLoader getSoftCoreClassLoader()

getCoreClassLoader

ClassLoader getCoreClassLoader()