Package de.xima.fc.plugin

Class PluginManager

java.lang.Object

de.xima.fc.plugin.PluginManager

public class PluginManager
extends Object

Class for managing plugins

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
PluginManager()

Method Summary

Modifier and Type	Method	Description
static void	createClientProtocolEntry(UserContext uc, Mandant man, String protocolEntry, Object... params)	Creates a client-protocol-entry
static void	createMandantProtocolEntry(IEntityContext ec, Mandant man, String protocolEntry, Object... params)	Deprecated. use createClientProtocolEntry(UserContext, Mandant, String, Object...)
static void	createSystemProtocolEntry(UserContext uc, String protocolEntry, Object... params)	Creates a system-protocol-entry
static void	deletePlugin(PluginRuntime prtm)	Deprecated.
static void	deletePlugin(String scopeKey, String runtimeKey)	Deprecated.
static Set<IFCPlugin>	getAllPlugins(Mandant man, EPluginTypes type)	Deprecated. user getAllPlugins(Mandant, Class)
static <T extends IFCPlugin> Set<T>	getAllPlugins(Mandant client, Class<T> pluginType)	Get a set of plugins with the given interface registered in system-scope OR to the given client.
static <T extends IFCPlugin> Set<T>	getAllPlugins(UUID clientUuid, Class<T> pluginType)	Get a set of plugins with the given interface registered in system-scope OR to the given client.
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	getAllPluginsWithRuntime(Mandant man, Class<T> clazz)
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	getAllPluginsWithRuntime(UUID clientUuid, Class<T> clazz)
static Set<PluginRuntime>	getClientPlugins(Mandant client)	Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
static <T extends IFCPlugin> Set<T>	getClientPlugins(Mandant client, Class<T> pluginType)	Get a set of plugins with the given interfaces registered to the given client
static Set<PluginRuntime>	getClientPlugins(UUID clientUuid)	Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
static <T extends IFCPlugin> Set<T>	getClientPlugins(UUID clientUuid, Class<T> pluginType)	Get a set of plugins with the given interfaces registered to the given client
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	getClientPluginsWithRuntime(Mandant client, Class<T> clazz)
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	getClientPluginsWithRuntime(UUID clientUuid, Class<T> clazz)
static IFCPlugin	getMandantPluginByName(Mandant man, EPluginTypes type, String pluginName)	Deprecated. will be removed!
static File	getMandantPluginJar(Mandant man, String jarName)	Deprecated. use PluginRuntime.getJarFile()
static List<PluginRuntime>	getMandantPlugins(Mandant man)	Deprecated. use getClientPlugins(Mandant)
static SortedSet<IFCPlugin>	getMandantPlugins(Mandant man, EPluginTypes type)	Deprecated. will be removed!
static IFCPlugin	getPluginByName(Mandant man, EPluginTypes type, String pluginName)	Deprecated. user getPluginByName(Mandant, Class, String)
static <T extends IFCPlugin> T	getPluginByName(Mandant man, Class<T> clazz, String pluginName)	Get a plugin by name and IFCPlugin-interface from client- and system-scope
static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>	getPluginByNameWithRuntime(Mandant man, Class<T> clazz, String pluginName)
static <T extends IFCPlugin> Map<EPluginScope,Set<String>>	getPluginNameMap(Mandant mandant, Class<T> clazz)	Deprecated.
static Map<EPluginScope,Set<String>>	getPluginNameMap(UserContext uc, Mandant mandant, EPluginTypes type)	Deprecated. use getPluginNameMap(UserContext, Mandant, EPluginTypes)
static <T extends IFCPlugin> Set<String>	getPluginNames(Mandant mandant, Class<T> clazz)	Get a set of all plugin-names with the given IFCPlugin-interface and Mandant
static Set<String>	getPluginNames(UserContext uc, Mandant mandant, EPluginTypes type)	Deprecated. use getPluginNames(UserContext, Mandant, EPluginTypes)
static PluginRuntime	getPluginRuntime(String scopeKey, String runtimeKey)
static <T extends IFCPlugin> Set<T>	getRegisteredPlugins(Class<T> clazz)	Get an set with all registered plugins of the given IFCPlugin-interface
static IFCPlugin	getSystemPluginByName(EPluginTypes type, String pluginName)	Deprecated. user getSystemPluginByName(Class, String)
static <T extends IFCPlugin> T	getSystemPluginByName(Class<T> clazz, String pluginName)	Get a system-plugin by name, IFCPlugin-interface
static Set<PluginRuntime>	getSystemPlugins()	Get a List of all PluginRuntimes registered in system-scope
static SortedSet<IFCPlugin>	getSystemPlugins(EPluginTypes type)	Deprecated. use getSystemPlugins(Class)
static <T extends IFCPlugin> Set<T>	getSystemPlugins(Class<T> clazz)	Get a set of plugins with the given interfaces registered in system-scope
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>	getSystemPluginsWithRuntime(Class<T> clazz)
static PluginRuntime	initClientPlugin(File pluginJar, Mandant man)	Deprecated.
static void	initPlugins()	Initialize all plugins stored in the database
static PluginRuntime	initSystemPlugin(File pluginJar)	Deprecated.
static void	install(IPluginEntity<?,?,?> pluginEntity)
static boolean	isPluginJar(File file)	Deprecated.
static <T extends IFCPlugin> void	registerClientPlugin(Mandant man, Class<T> clazz, String runtimeKey)	Method to register a plugin-class in scope of the given client
static void	registerMandantPlugin(Mandant man, EPluginTypes typ, Class<? extends IFCPlugin> clazz)	Deprecated. use registerClientPlugin(Mandant, Class, String)
static <T extends IFCPlugin> void	registerPlugin(boolean isInstall, PluginRuntime prtm, Class<T> clazz)	Register a plugin to the given key and PluginRuntime
static <T extends IFCPlugin> void	registerPlugin(PluginRuntime prtm, Class<T> clazz)
static void	registerSystemPlugin(EPluginTypes typ, Class<? extends IFCPlugin> clazz)	Deprecated. use registerSystemPlugin(Class, String)
static void	registerSystemPlugin(Class<? extends IFCPlugin> clazz, String runtimeKey)	Method to register a plugin-class in system-scope
static void	releaseMandantPlugin(Mandant man, PluginRuntime pluginMeta)	Deprecated. use releasePlugin(PluginRuntime)
static void	releasePlugin(boolean isUninstall, PluginRuntime prtm)
static void	releasePlugin(boolean isUninstall, String scopeKey, String runtimeKey)
static void	releasePlugin(PluginRuntime prtm)
static void	releasePlugin(String scopeKey, String runtimeKey)
static void	releasePlugins()	Releases all registered plugins
static boolean	scanAndRegisterMandantPlugin(Mandant man, PluginRuntime pluginMeta, byte[] jarData)	Deprecated. use initClientPlugin(File, Mandant)
static boolean	scanAndRegisterSystemPlugin(PluginRuntime pluginMeta, byte[] jarData)	Deprecated. use initSystemPlugin(File)
static void	scanForAllPlugins()	Deprecated. use initPlugins()
static void	synchronizePlugin(boolean isInstall, PluginSyncData pluginData)
static void	uninstallPlugin(String scopeKey, String runtimeKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

public PluginManager()

Method Detail

initPlugins

public static void initPlugins()

Initialize all plugins stored in the database

synchronizePlugin

public static void synchronizePlugin(boolean isInstall,
                                     PluginSyncData pluginData)
                              throws IOException,
                                     FCPluginException

Throws:

IOException

FCPluginException

registerSystemPlugin

public static void registerSystemPlugin(Class<? extends IFCPlugin> clazz,
                                        String runtimeKey)
                                 throws FCPluginException

Method to register a plugin-class in system-scope

Parameters:

clazz - IFCPlugin-class to register

Throws:

FCPluginException

registerClientPlugin

public static <T extends IFCPlugin> void registerClientPlugin(Mandant man,
                                                              Class<T> clazz,
                                                              String runtimeKey)
                                                       throws FCPluginException

Method to register a plugin-class in scope of the given client

Parameters:

man - Mandant

clazz - IFCPlugin-class to register

Throws:

FCPluginException

registerPlugin

public static <T extends IFCPlugin> void registerPlugin(PluginRuntime prtm,
                                                        Class<T> clazz)
                                                 throws FCPluginException

Throws:

FCPluginException

registerPlugin

public static <T extends IFCPlugin> void registerPlugin(boolean isInstall,
                                                        PluginRuntime prtm,
                                                        Class<T> clazz)
                                                 throws FCPluginException

Register a plugin to the given key and PluginRuntime

Parameters:

isInstall - true if the plugin is installed for the first time, false if the plugin configuration is only updated.

prtm - PluginRuntime

clazz - IFCPlugin class

Throws:

FCPluginException

install

public static void install(IPluginEntity<?,?,?> pluginEntity)
                    throws IOException,
                           FCPluginException

Throws:

IOException

FCPluginException

releasePlugin

public static void releasePlugin(String scopeKey,
                                 String runtimeKey)
                          throws IOException

Throws:

IOException

releasePlugin

public static void releasePlugin(boolean isUninstall,
                                 String scopeKey,
                                 String runtimeKey)
                          throws IOException

Throws:

IOException

releasePlugin

public static void releasePlugin(PluginRuntime prtm)
                          throws IOException

Throws:

IOException

releasePlugin

public static void releasePlugin(boolean isUninstall,
                                 PluginRuntime prtm)
                          throws IOException

Throws:

IOException

releasePlugins

public static void releasePlugins()

Releases all registered plugins

uninstallPlugin

public static void uninstallPlugin(String scopeKey,
                                   String runtimeKey)
                            throws IOException

Parameters:

scopeKey - the plugin scope key

runtimeKey - the plugin runtime key

Throws:

IOException - on errors while uninstall

getClientPlugins

public static <T extends IFCPlugin> Set<T> getClientPlugins(Mandant client,
                                                            Class<T> pluginType)

Get a set of plugins with the given interfaces registered to the given client

Parameters:

client - The client-scope to use for retrieving client plugins, if any.

pluginType - Type of the plugins to retrieve.

Returns:

All active plugins for the given client, if any (does not include systm plugins!)

getClientPlugins

public static <T extends IFCPlugin> Set<T> getClientPlugins(UUID clientUuid,
                                                            Class<T> pluginType)

Get a set of plugins with the given interfaces registered to the given client

Parameters:

clientUuid - The client-scope to use for retrieving client plugins, if any.

pluginType - Type of the plugins to retrieve.

Returns:

All active plugins for the given client, if any (does not include systm plugins!)

getClientPluginsWithRuntime

public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>> getClientPluginsWithRuntime(Mandant client,
                                                                                                                                Class<T> clazz)

getClientPluginsWithRuntime

public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>> getClientPluginsWithRuntime(UUID clientUuid,
                                                                                                                                Class<T> clazz)

getClientPlugins

public static Set<PluginRuntime> getClientPlugins(Mandant client)

Gets a list of all plugin runtimes registered to the given client (not including system plugins!)

Parameters:

client - A client for which to retrieve the plugins.

Returns:

A list of all plugin runtimes corresponding to the plugin installed for the given client

getClientPlugins

public static Set<PluginRuntime> getClientPlugins(UUID clientUuid)

Gets a list of all plugin runtimes registered to the given client (not including system plugins!)

Parameters:

clientUuid - UUID of a client.

Returns:

A list of all plugin runtimes corresponding to the plugin installed for the given client

getPluginRuntime

public static PluginRuntime getPluginRuntime(String scopeKey,
                                             String runtimeKey)

getSystemPlugins

public static <T extends IFCPlugin> Set<T> getSystemPlugins(Class<T> clazz)

Get a set of plugins with the given interfaces registered in system-scope

Parameters:

clazz - IFCPlugin-interface

Returns:

Set of IFCPlugin-instances

getSystemPluginsWithRuntime

public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>> getSystemPluginsWithRuntime(Class<T> clazz)

getSystemPlugins

public static Set<PluginRuntime> getSystemPlugins()

Get a List of all PluginRuntimes registered in system-scope

Returns:

Set of PluginRuntimes

getAllPlugins

public static <T extends IFCPlugin> Set<T> getAllPlugins(Mandant client,
                                                         Class<T> pluginType)

Get a set of plugins with the given interface registered in system-scope OR to the given client. (client-scope wins over system-scope)

Parameters:

client - Mandant

pluginType - Type of the plugins to retrieve.

Returns:

All plugins from the given client (if any) and from the system scope. A client-scoped plugin overwrites a system-scoped plugin.

getAllPlugins

public static <T extends IFCPlugin> Set<T> getAllPlugins(UUID clientUuid,
                                                         Class<T> pluginType)

Get a set of plugins with the given interface registered in system-scope OR to the given client. (client-scope wins over system-scope)

Parameters:

clientUuid - UUID of a client.

pluginType - Type of the plugins to retrieve.

Returns:

All plugins from the given client (if any) and from the system scope. A client-scoped plugin overwrites a system-scoped plugin.

getAllPluginsWithRuntime

public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>> getAllPluginsWithRuntime(Mandant man,
                                                                                                                             Class<T> clazz)

getAllPluginsWithRuntime

public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>> getAllPluginsWithRuntime(UUID clientUuid,
                                                                                                                             Class<T> clazz)

getRegisteredPlugins

public static <T extends IFCPlugin> Set<T> getRegisteredPlugins(Class<T> clazz)

Get an set with all registered plugins of the given IFCPlugin-interface

Parameters:

clazz - IFCPlugin-interfaces

Returns:

Set of IFCPlugin-instances

getPluginByName

public static <T extends IFCPlugin> T getPluginByName(Mandant man,
                                                      Class<T> clazz,
                                                      String pluginName)

Get a plugin by name and IFCPlugin-interface from client- and system-scope

Parameters:

man - Mandant where the plugin should be searched

clazz - IFCPlugin-interface to search for

pluginName - String name of the searched plugin

Returns:

IFCPlugin-instance or null if no plugin could be found

getPluginByNameWithRuntime

public static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime,T> getPluginByNameWithRuntime(Mandant man,
                                                                                                                          Class<T> clazz,
                                                                                                                          String pluginName)

getSystemPluginByName

public static <T extends IFCPlugin> T getSystemPluginByName(Class<T> clazz,
                                                            String pluginName)

Get a system-plugin by name, IFCPlugin-interface

Parameters:

clazz - IFCPlugin-interface to search for

pluginName - String name of the searched plugin

Returns:

IFCPlugin-instance or null if no plugin could be found

getPluginNames

public static <T extends IFCPlugin> Set<String> getPluginNames(Mandant mandant,
                                                               Class<T> clazz)

Get a set of all plugin-names with the given IFCPlugin-interface and Mandant

Parameters:

mandant - Mandant

clazz - IFCPlugin-interface

Returns:

Set of Strings

createSystemProtocolEntry

public static void createSystemProtocolEntry(UserContext uc,
                                             String protocolEntry,
                                             Object... params)

Creates a system-protocol-entry

Parameters:

uc - UserContext

protocolEntry - String protocol-text

params - Objects parameters

createClientProtocolEntry

public static void createClientProtocolEntry(UserContext uc,
                                             Mandant man,
                                             String protocolEntry,
                                             Object... params)

Creates a client-protocol-entry

Parameters:

uc - UserContext

man - Mandant

protocolEntry - String protocol-text

params - Objects parameters

isPluginJar

@Deprecated
public static boolean isPluginJar(File file)

Deprecated.

deletePlugin

@Deprecated
public static void deletePlugin(PluginRuntime prtm)
                         throws IOException

Deprecated.

Throws:

IOException

deletePlugin

@Deprecated
public static void deletePlugin(String scopeKey,
                                String runtimeKey)
                         throws IOException

Deprecated.

Throws:

IOException

getAllPlugins

@Deprecated
public static Set<IFCPlugin> getAllPlugins(Mandant man,
                                           EPluginTypes type)

Deprecated.

user getAllPlugins(Mandant, Class)

getPluginNameMap

@Deprecated
public static Map<EPluginScope,Set<String>> getPluginNameMap(UserContext uc,
                                                                   Mandant mandant,
                                                                   EPluginTypes type)

Deprecated.

use getPluginNameMap(UserContext, Mandant, EPluginTypes)

getPluginNames

@Deprecated
public static Set<String> getPluginNames(UserContext uc,
                                         Mandant mandant,
                                         EPluginTypes type)

Deprecated.

use getPluginNames(UserContext, Mandant, EPluginTypes)

getPluginByName

@Deprecated
public static IFCPlugin getPluginByName(Mandant man,
                                        EPluginTypes type,
                                        String pluginName)

Deprecated.

user getPluginByName(Mandant, Class, String)

getMandantPlugins

@Deprecated
public static SortedSet<IFCPlugin> getMandantPlugins(Mandant man,
                                                     EPluginTypes type)

Deprecated.

will be removed!

getSystemPlugins

@Deprecated
public static SortedSet<IFCPlugin> getSystemPlugins(EPluginTypes type)

Deprecated.

use getSystemPlugins(Class)

getSystemPluginByName

@Deprecated
public static IFCPlugin getSystemPluginByName(EPluginTypes type,
                                              String pluginName)

Deprecated.

user getSystemPluginByName(Class, String)

getMandantPluginByName

@Deprecated
public static IFCPlugin getMandantPluginByName(Mandant man,
                                               EPluginTypes type,
                                               String pluginName)

Deprecated.

will be removed!

registerMandantPlugin

@Deprecated
public static void registerMandantPlugin(Mandant man,
                                         EPluginTypes typ,
                                         Class<? extends IFCPlugin> clazz)
                                  throws FCPluginException

Deprecated.

use registerClientPlugin(Mandant, Class, String)

Throws:

FCPluginException

registerSystemPlugin

@Deprecated
public static void registerSystemPlugin(EPluginTypes typ,
                                        Class<? extends IFCPlugin> clazz)
                                 throws FCPluginException

Deprecated.

use registerSystemPlugin(Class, String)

Throws:

FCPluginException

createMandantProtocolEntry

@Deprecated
public static void createMandantProtocolEntry(IEntityContext ec,
                                              Mandant man,
                                              String protocolEntry,
                                              Object... params)

Deprecated.

use createClientProtocolEntry(UserContext, Mandant, String, Object...)

releaseMandantPlugin

@Deprecated
public static void releaseMandantPlugin(Mandant man,
                                        PluginRuntime pluginMeta)
                                 throws IOException

Deprecated.

use releasePlugin(PluginRuntime)

Throws:

IOException

getMandantPluginJar

@Deprecated
public static File getMandantPluginJar(Mandant man,
                                       String jarName)
                                throws IOException

Deprecated.

use PluginRuntime.getJarFile()

Throws:

IOException

scanForAllPlugins

@Deprecated
public static void scanForAllPlugins()

Deprecated.

use initPlugins()

scanAndRegisterSystemPlugin

@Deprecated
public static boolean scanAndRegisterSystemPlugin(PluginRuntime pluginMeta,
                                                  byte[] jarData)

Deprecated.

use initSystemPlugin(File)

scanAndRegisterMandantPlugin

@Deprecated
public static boolean scanAndRegisterMandantPlugin(Mandant man,
                                                   PluginRuntime pluginMeta,
                                                   byte[] jarData)

Deprecated.

use initClientPlugin(File, Mandant)

getMandantPlugins

@Deprecated
public static List<PluginRuntime> getMandantPlugins(Mandant man)

Deprecated.

use getClientPlugins(Mandant)

getPluginNameMap

@Deprecated
public static <T extends IFCPlugin> Map<EPluginScope,Set<String>> getPluginNameMap(Mandant mandant,
                                                                                         Class<T> clazz)

Deprecated.

Get a map of plugins by client, system and IFCPlugin-interface

Parameters:

mandant - Mandant

clazz - IFCPlugin-interface

Returns:

Map of plugins

initClientPlugin

@Deprecated
public static PluginRuntime initClientPlugin(File pluginJar,
                                             Mandant man)
                                      throws IOException,
                                             FCPluginException

Deprecated.

Throws:

IOException

FCPluginException

initSystemPlugin

@Deprecated
public static PluginRuntime initSystemPlugin(File pluginJar)
                                      throws IOException,
                                             FCPluginException

Deprecated.

Throws:

IOException

FCPluginException