com.jalios.jcms.plugin

Class PluginManager

java.lang.Object

com.jalios.jcms.plugin.PluginManager

public final class PluginManager
extends java.lang.Object

Singleton used to manage plugin's life cycle. It also contains utility methods and constants for plugins. 1. Initialization of PluginManager 2. Loading Plugins 3. Initialize dependencies 4. Initializing deployed Plugins 5. Setup deployed plugins

Since:

jcms-5.7.0

Version:

$Revision: 53244 $

Author:

Jean-Philippe Encausse

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isMainPluginInit
static java.lang.String	MAIN_PLUGIN_CHECK_PROP
static java.lang.String	MAIN_PLUGIN_PROP
protected Plugin	mainPlugin
protected LangProperties	mainPluginCoreProperties
static java.lang.String	PLUGIN_BACKUP
static java.lang.String	PLUGIN_BUILD
static java.lang.String	PLUGIN_EXTENSION
static java.lang.String	PLUGIN_PRIVATE_PATH
static java.lang.String	PLUGIN_PUBLIC_PATH
static java.lang.String	PLUGIN_XML
protected java.util.Collection<Plugin>	pluginCollection
protected java.util.Map<java.lang.String,Plugin>	pluginMap
protected java.io.File	pluginPrivateFolder
static java.lang.String	REVISION

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deletePluginFiles(Plugin plugin) Delete all deployed files of the given plugin.
boolean	deployPlugin(Plugin plugin, java.lang.String archiveName) Deploy all files from a given archive to the current JCMS directory tree.
java.util.Set<java.lang.String>	getAllPathSet(boolean sources) Returns a Set of relative path to all plugins declared files
java.util.Set<java.lang.String>	getAllPathSet(boolean sources, boolean generated, boolean signature, boolean pkg, boolean jar, java.lang.String prefix, boolean directory) Returns a Set of relative path to all plugins declared files
void	getCssFiles(java.util.Collection<java.io.File> cssPaths, java.util.Collection<Plugin> collection, java.io.FileFilter filter) Fill given cssPaths collection with plugins css path used for portals
void	getCssFiles(java.util.Collection<java.io.File> cssPaths, java.io.FileFilter filter) Fill given cssPaths collection with plugins css path used for portals
java.util.Set<java.lang.String>	getJarsPath() Returns a Set of relative Path to all webapp's jar
Plugin	getMainPlugin() Returns the main plugin (or null if there is no main plugin)
LangProperties	getMainPluginCoreProperties() Returns the core properties the main plugin override.
java.lang.String	getMainPluginName() Returns the name of the main plugin (or null if there is no main plugin)
Plugin	getPlugin(java.lang.String pluginName) Returns the plugin for the given name or null if it does not exists.
org.xml.sax.EntityResolver	getPluginEntityResolver()
static PluginManager	getPluginManager() Returns a PluginManager.
java.util.Set<java.lang.String>	getPluginPath(boolean priv, java.lang.String pluginName, java.util.Set<java.lang.String> pluginSet) Returns a Set of relative Path to plugin public/private folder with all files stored on disk even if they are not declared in xml
java.util.Collection<Plugin>	getPlugins() Returns a Collection of plugins.
org.jdom.input.SAXBuilder	getSAXBuilder()
java.util.Set<java.lang.String>	getWorkflowsPath() Returns a Set of relative Path to all webapp's workflow
void	init(Channel channel) Inits the PluginManager.
void	initMainPlugin() Initialize main plugin (reserved for JCMS internals).
void	initPlugins() Inits all plugins that have been correctly loaded.
void	initPlugins(java.util.Collection<Plugin> collection) Inits all plugins that have been correctly loaded.
void	invalidateIncludeCache() Invalidate cache of plugin's JSP to include for given tags.
boolean	isMainPluginDefined() Returns true if the main plugin has been defined.
Plugin	loadArchive(java.io.File file) Load a given Plugin Archive if it has not been already loadded
void	loadLanguageProperties(LangProperties properties, java.util.List<java.lang.String> jcmsLangList) Iterates on plugin's collection and load only languages properties for initialized plugins.
void	loadMainPluginProperties(LangProperties properties, java.util.List<java.lang.String> jcmsLangList) Loads all the properties of the main plugin.
Plugin	loadPluginXML(java.io.File file) Load a given Plugin Archive if it has not been already loadded
void	loadProperties(LangProperties properties, java.util.List<java.lang.String> jcmsLangList) Iterates on plugin's collection and load properties, including language properties for initialized plugins.
void	loadProperties(LangProperties properties, java.util.List<java.lang.String> jcmsLangList, java.util.Collection<Plugin> collection, boolean onlyLangProp) Iterates on plugin's collection and load properties for initialized plugins
boolean	performDeletePackage(java.lang.String packageName) Delete the given plugin package
java.util.Map<Plugin,java.util.Set<SignatureDiffEntry>>	performDiffPlugins() Perform a Diff on each loaded plugins and store results in a Map
void	performInclude(java.lang.String tag, javax.servlet.jsp.PageContext pageContext) Iterates on plugin's collection and retrieve Plugins' JSP to include for the given anchor.
void	register(Plugin plugin) Register a loaded plugin in PluginManager
void	registerAlarmListener() Iterates on plugin's collection and register AlarmListener for initialized plugins.
void	registerAlarmListener(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register AlarmListener for initialized plugins
void	registerAlertChannel() Iterates on plugin's collection and register AlertChannel for initialized plugins.
void	registerAlertChannel(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register AlertChannel for initialized plugins
void	registerAuthenticationHandler() Iterates on plugin's collection and register AuthenticationHandlers for initialized plugins.
void	registerAuthenticationHandler(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register AuthenticationHandlers for initialized plugins
void	registerChannelListener() Iterates on plugin's collection and register ChannelListener for initialized plugins.
void	registerChannelListener(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register ChannelListener for initialized plugins
void	registerCleanFilter() Iterates on plugin's collection and register CleanFilter for initialized plugins.
void	registerCleanFilter(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register CleanFilter for initialized plugins
void	registerDataController() Iterates on plugin's collection and register DataController for initialized plugins.
void	registerDataController(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register DataController for initialized plugins
void	registerDBListener() Iterates on plugin's collection and register DBlistener for initialized plugins.
void	registerDBListener(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register DBlistener for initialized plugins
void	registerHibernateMapping() Iterates on plugin's collection and register Hibernate mappings for initialized plugins.
void	registerHibernateMapping(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register Hibernate mappings for initialized plugins
void	registerOpenApiResources(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register RestResource for initialized plugins
void	registerPolicyFilter() Iterates on plugin's collection and register PolicyFilter for initialized plugins.
void	registerPolicyFilter(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register PolicyFilter for initialized plugins
void	registerQueryFilter() Iterates on plugin's collection and register QueryFilter for initialized plugins.
void	registerQueryFilter(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register QueryFilter for initialized plugins
void	registerRestResource() Iterates on plugin's collection and register RestResource for initialized plugins.
void	registerStoreListener(boolean beforeStoreLoad) Iterates on plugin's collection and register StoreListener for initialized plugins.
void	registerStoreListener(java.util.Collection<Plugin> collection, boolean beforeStoreLoad) Iterates on plugin's collection and register StoreListener for initialized plugins
void	registerTemplates() Iterates on plugin's collection and register types' template for initialized plugins.
void	registerTemplates(java.util.Collection<Plugin> collection) Iterates on plugin's collection and register types' template for initialized plugins
void	setupPlugins() Setup all plugins that have been correctly initialized.
void	setupPlugins(java.util.Collection<Plugin> collection) Setup all plugins that have been correctly initialized.
void	signPlugins() Sign all plugins that have been correctly initialized.
void	signPlugins(java.util.Collection<Plugin> collection) Sign all plugins that have been correctly initialized.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

PLUGIN_PRIVATE_PATH

public static final java.lang.String PLUGIN_PRIVATE_PATH

See Also:

Constant Field Values

PLUGIN_PUBLIC_PATH

public static final java.lang.String PLUGIN_PUBLIC_PATH

See Also:

Constant Field Values

PLUGIN_XML

public static final java.lang.String PLUGIN_XML

See Also:

Constant Field Values

PLUGIN_BUILD

public static final java.lang.String PLUGIN_BUILD

See Also:

Constant Field Values

PLUGIN_EXTENSION

public static final java.lang.String PLUGIN_EXTENSION

See Also:

Constant Field Values

PLUGIN_BACKUP

public static final java.lang.String PLUGIN_BACKUP

See Also:

Constant Field Values

MAIN_PLUGIN_PROP

public static final java.lang.String MAIN_PLUGIN_PROP

See Also:

Constant Field Values

MAIN_PLUGIN_CHECK_PROP

public static final java.lang.String MAIN_PLUGIN_CHECK_PROP

See Also:

Constant Field Values

pluginCollection

protected java.util.Collection<Plugin> pluginCollection

pluginMap

protected java.util.Map<java.lang.String,Plugin> pluginMap

pluginPrivateFolder

protected java.io.File pluginPrivateFolder

mainPluginCoreProperties

protected LangProperties mainPluginCoreProperties

mainPlugin

protected Plugin mainPlugin

isMainPluginInit

protected boolean isMainPluginInit

Method Detail

getPluginManager

public static PluginManager getPluginManager()

Returns a PluginManager. Singleton method initalized by Channel (not synchronized)

Returns:

PluginManager the Pluginmanager

init

public void init(Channel channel)

Inits the PluginManager.

Parameters:

channel - the Channel singleton instance

initPlugins

public void initPlugins()

Inits all plugins that have been correctly loaded. Called after Channelinitialized most important stuff.

initPlugins

public void initPlugins(java.util.Collection<Plugin> collection)

Inits all plugins that have been correctly loaded. Called juste after PluginManager Initialisation, Channel not completly initialised. Properties not loaded.

Parameters:

collection - a collection of Plugin

setupPlugins

public void setupPlugins()

Setup all plugins that have been correctly initialized. Channel properties have been loaded.

setupPlugins

public void setupPlugins(java.util.Collection<Plugin> collection)

Setup all plugins that have been correctly initialized. Channel properties have been loaded.

Parameters:

collection - a collection of Plugin

getMainPluginName

public java.lang.String getMainPluginName()

Returns the name of the main plugin (or null if there is no main plugin)

Returns:

the name of the main plugin (or null if there is no main plugin)

Since:

jcms-8.0.1

getMainPlugin

public Plugin getMainPlugin()

Returns the main plugin (or null if there is no main plugin)

Returns:

the main plugin (or null if there is no main plugin)

Since:

jcms-8.0.1

isMainPluginDefined

public boolean isMainPluginDefined()

Returns true if the main plugin has been defined.

Returns:

true if the main plugin has been defined.

Since:

jcms-8.0.1

initMainPlugin

public void initMainPlugin()
                    throws java.lang.IllegalStateException

Initialize main plugin (reserved for JCMS internals).

Throws:

java.lang.IllegalStateException - if the main plugin is not correctly started

Since:

jcms-8.0.1

loadMainPluginProperties

public void loadMainPluginProperties(LangProperties properties,
                            java.util.List<java.lang.String> jcmsLangList)

Loads all the properties of the main plugin.

Parameters:

properties - the properties where to load the main plugin properties

jcmsLangList - the JCMS language list

Since:

jcms-8.0.1

getMainPluginCoreProperties

public LangProperties getMainPluginCoreProperties()

Returns the core properties the main plugin override.

Returns:

the core properties the main plugin override.

Since:

jcms-8.0.1

signPlugins

public void signPlugins()

Sign all plugins that have been correctly initialized. Channel properties have been loaded.

signPlugins

public void signPlugins(java.util.Collection<Plugin> collection)

Sign all plugins that have been correctly initialized. Channel properties have been loaded.

Parameters:

collection - a collection of Plugin

performDiffPlugins

public java.util.Map<Plugin,java.util.Set<SignatureDiffEntry>> performDiffPlugins()

Perform a Diff on each loaded plugins and store results in a Map

Returns:

Return a Map of Plugin/Set of DiffEntry.

getAllPathSet

public java.util.Set<java.lang.String> getAllPathSet(boolean sources)

Returns a Set of relative path to all plugins declared files

Parameters:

sources - also include .java sources

Returns:

Set of relative path

getAllPathSet

public java.util.Set<java.lang.String> getAllPathSet(boolean sources,
                                            boolean generated,
                                            boolean signature,
                                            boolean pkg,
                                            boolean jar,
                                            java.lang.String prefix,
                                            boolean directory)

Returns a Set of relative path to all plugins declared files

Parameters:

sources - also include .java sources

generated - include generated content

signature - add signature file

pkg - add package file

jar - add jar file

prefix - add prefix to path

directory - should resolve directory path

Returns:

Set of relative path

getPluginEntityResolver

public org.xml.sax.EntityResolver getPluginEntityResolver()

getSAXBuilder

public org.jdom.input.SAXBuilder getSAXBuilder()

register

public void register(Plugin plugin)

Register a loaded plugin in PluginManager

Parameters:

plugin - the loaded plugin

loadPluginXML

public Plugin loadPluginXML(java.io.File file)

Load a given Plugin Archive if it has not been already loadded

Parameters:

file - the folder that contains PLUGIN_XML

Returns:

Plugin or null if there is an error

loadArchive

public Plugin loadArchive(java.io.File file)

Load a given Plugin Archive if it has not been already loadded

Parameters:

file - the archive that ends with PLUGIN_EXTENSION

Returns:

Plugin or null if there is an error

deployPlugin

public boolean deployPlugin(Plugin plugin,
                   java.lang.String archiveName)

Deploy all files from a given archive to the current JCMS directory tree. If file already exists backup it to plugin backup directory.

Parameters:

plugin - the loaded Plugin

archiveName - the archive to deploy

Returns:

boolean true if deployement has been correctly done

deletePluginFiles

public boolean deletePluginFiles(Plugin plugin)

Delete all deployed files of the given plugin.

Parameters:

plugin - the loaded Plugin

Returns:

boolean true if delete has been correctly done

performDeletePackage

public boolean performDeletePackage(java.lang.String packageName)

Delete the given plugin package

Parameters:

packageName - the name of the package to delete

Returns:

boolean

Since:

jcms-5.7.1

registerTemplates

public void registerTemplates()

Iterates on plugin's collection and register types' template for initialized plugins.

registerTemplates

public void registerTemplates(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register types' template for initialized plugins

Parameters:

collection - a collection of Plugin

registerStoreListener

public void registerStoreListener(boolean beforeStoreLoad)

Iterates on plugin's collection and register StoreListener for initialized plugins.

Parameters:

beforeStoreLoad - boolean true before loading store

registerStoreListener

public void registerStoreListener(java.util.Collection<Plugin> collection,
                         boolean beforeStoreLoad)

Iterates on plugin's collection and register StoreListener for initialized plugins

Parameters:

collection - a collection of Plugin

beforeStoreLoad - boolean true before loading store

registerDBListener

public void registerDBListener()

Iterates on plugin's collection and register DBlistener for initialized plugins.

registerDBListener

public void registerDBListener(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register DBlistener for initialized plugins

Parameters:

collection - a collection of Plugin

registerDataController

public void registerDataController()

Iterates on plugin's collection and register DataController for initialized plugins.

registerDataController

public void registerDataController(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register DataController for initialized plugins

Parameters:

collection - a collection of Plugin

registerAlarmListener

public void registerAlarmListener()

Iterates on plugin's collection and register AlarmListener for initialized plugins.

registerAlarmListener

public void registerAlarmListener(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register AlarmListener for initialized plugins

Parameters:

collection - a collection of Plugin

registerAlertChannel

public void registerAlertChannel()

Iterates on plugin's collection and register AlertChannel for initialized plugins.

registerAlertChannel

public void registerAlertChannel(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register AlertChannel for initialized plugins

Parameters:

collection - a collection of Plugin

registerRestResource

public void registerRestResource()

Iterates on plugin's collection and register RestResource for initialized plugins.

registerOpenApiResources

public void registerOpenApiResources(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register RestResource for initialized plugins

Parameters:

collection - a collection of Plugin

registerChannelListener

public void registerChannelListener()

Iterates on plugin's collection and register ChannelListener for initialized plugins.

registerChannelListener

public void registerChannelListener(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register ChannelListener for initialized plugins

Parameters:

collection - a collection of Plugin

registerQueryFilter

public void registerQueryFilter()

Iterates on plugin's collection and register QueryFilter for initialized plugins.

registerQueryFilter

public void registerQueryFilter(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register QueryFilter for initialized plugins

Parameters:

collection - a collection of Plugin

registerCleanFilter

public void registerCleanFilter()

Iterates on plugin's collection and register CleanFilter for initialized plugins.

registerCleanFilter

public void registerCleanFilter(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register CleanFilter for initialized plugins

Parameters:

collection - a collection of Plugin

registerPolicyFilter

public void registerPolicyFilter()

Iterates on plugin's collection and register PolicyFilter for initialized plugins.

registerPolicyFilter

public void registerPolicyFilter(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register PolicyFilter for initialized plugins

Parameters:

collection - a collection of Plugin

registerAuthenticationHandler

public void registerAuthenticationHandler()

Iterates on plugin's collection and register AuthenticationHandlers for initialized plugins.

registerAuthenticationHandler

public void registerAuthenticationHandler(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register AuthenticationHandlers for initialized plugins

Parameters:

collection - a collection of Plugin

registerHibernateMapping

public void registerHibernateMapping()

Iterates on plugin's collection and register Hibernate mappings for initialized plugins.

registerHibernateMapping

public void registerHibernateMapping(java.util.Collection<Plugin> collection)

Iterates on plugin's collection and register Hibernate mappings for initialized plugins

Parameters:

collection - a collection of Plugin

getCssFiles

public void getCssFiles(java.util.Collection<java.io.File> cssPaths,
               java.io.FileFilter filter)

Fill given cssPaths collection with plugins css path used for portals

Parameters:

cssPaths - Collection of css path

filter - FileFilter for css

getCssFiles

public void getCssFiles(java.util.Collection<java.io.File> cssPaths,
               java.util.Collection<Plugin> collection,
               java.io.FileFilter filter)

Fill given cssPaths collection with plugins css path used for portals

Parameters:

cssPaths - Collection of css path

collection - Collection of plugins

filter - FileFilter for css

invalidateIncludeCache

public void invalidateIncludeCache()

Invalidate cache of plugin's JSP to include for given tags.

performInclude

public void performInclude(java.lang.String tag,
                  javax.servlet.jsp.PageContext pageContext)

Iterates on plugin's collection and retrieve Plugins' JSP to include for the given anchor. WARNING ! This method must be called from a jsp taglib

Parameters:

tag - the scope of include

pageContext - the current Jsp's pageContext, required !

loadProperties

public void loadProperties(LangProperties properties,
                  java.util.List<java.lang.String> jcmsLangList)

Iterates on plugin's collection and load properties, including language properties for initialized plugins.

Parameters:

properties - the channel properties

jcmsLangList - the lang list of JCMS

loadLanguageProperties

public void loadLanguageProperties(LangProperties properties,
                          java.util.List<java.lang.String> jcmsLangList)

Iterates on plugin's collection and load only languages properties for initialized plugins.

Parameters:

properties - the channel properties

jcmsLangList - the lang list of JCMS

Since:

jcms-6.1.0

loadProperties

public void loadProperties(LangProperties properties,
                  java.util.List<java.lang.String> jcmsLangList,
                  java.util.Collection<Plugin> collection,
                  boolean onlyLangProp)

Iterates on plugin's collection and load properties for initialized plugins

Parameters:

properties - the channel properties

jcmsLangList - the lang list of JCMS

collection - a collection of Plugin

onlyLangProp - only the language properties

getWorkflowsPath

public java.util.Set<java.lang.String> getWorkflowsPath()

Returns a Set of relative Path to all webapp's workflow

Returns:

Set of relative path

getJarsPath

public java.util.Set<java.lang.String> getJarsPath()

Returns a Set of relative Path to all webapp's jar

Returns:

Set of relative path

getPluginPath

public java.util.Set<java.lang.String> getPluginPath(boolean priv,
                                            java.lang.String pluginName,
                                            java.util.Set<java.lang.String> pluginSet)

Returns a Set of relative Path to plugin public/private folder with all files stored on disk even if they are not declared in xml

Parameters:

priv - boolean true if private or false if public

pluginName - the name og the plugin

pluginSet - the set of known path to add

Returns:

Set of relative path

getPlugins

public java.util.Collection<Plugin> getPlugins()

Returns a Collection of plugins.

Returns:

Collenction the plugin's collection

getPlugin

public Plugin getPlugin(java.lang.String pluginName)

Returns the plugin for the given name or null if it does not exists.

Parameters:

pluginName - the name of the plugin

Returns:

Plugin the plugin