de.xima.fc.plugin

Class PluginManager

java.lang.Object

de.xima.fc.plugin.PluginManager

public class PluginManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_SCOPE

Constructor Summary

Constructors

Constructor and Description
PluginManager()

Method Summary

Modifier and Type	Method and Description
static void	createMandantProtocolEntry(IEntityContext ec, Mandant man, String protocolEntry, Object... params)
static void	createSystemProtocolEntry(IEntityContext ec, String protocolEntry, Object... params)
static boolean	deletePlugin(PluginMeta pluginMeta)
static boolean	existsJarFile(PluginMeta pm)
static Map<String,Set<IMonitorPlugin>>	getAllMonitorPlugins()
static SortedSet<IFCPlugin>	getAllPlugins(Mandant man, EPluginTypes type) Liefert ein Set aller für einen Mandanten registrierten Plugins eines bestimmten Plugin-Typs zurück.
static File	getMandantPluginJar(Mandant man, String jarName) Liefert File-Handle zum mandanten abhängigen Jar-File (Achtung, es kann nicht davon ausgegangen werden, das File existiert, deshalb -> File.exists())
static List<PluginMeta>	getMandantPlugins(Mandant man) Liefert eine Liste mit allen für einen Mandanten registrierten Plugins zurück.
static SortedSet<IFCPlugin>	getMandantPlugins(Mandant man, EPluginTypes type) Liefert ein Set mit allen für den übergebenen Mandanten registrierten Plugins, eines bestimmten EPluginTypes, zurück.
static IFCPlugin	getPluginByName(Mandant man, EPluginTypes type, String pluginName) Gibt ein anhand des Namens gesuchtes IFCPlugin-Objekt oder null zurück.
static Map<EPluginScope,Set<String>>	getPluginNameMap(UserContext uc, Mandant mandant, EPluginTypes type)
static Set<String>	getPluginNames(UserContext uc, Mandant mandant, EPluginTypes type)
static IFCPlugin	getSystemPluginByName(EPluginTypes type, String pluginName)
static File	getSystemPluginJar(String jarName) Liefert File-Handle zum mandanten abhängigen Jar-File (Achtung, es kann nicht davon ausgegangen werden, das File existiert, deshalb -> File.exists())
static List<PluginMeta>	getSystemPlugins()
static SortedSet<IFCPlugin>	getSystemPlugins(EPluginTypes type) Liefert ein Set mit allen im System registrierten Plugins eines bestimmten EPluginTypes zurück.
static boolean	isPluginJar(File file) Testet, ob es sich beim übergebenen File-Objekt um ein Jar-File mit FormCycle spezifischen Plugin-Klassen handelt
static void	registerMandantPlugin(Mandant man, EPluginTypes typ, Class<? extends IFCPlugin> clazz)
static void	registerSystemPlugin(EPluginTypes typ, Class<? extends IFCPlugin> clazz)
static void	releaseAllPlugins()
static void	releaseMandantPlugin(Mandant man, PluginMeta pluginMeta) Gibt geladene Jar Resourcen wieder frei.
static void	releaseMandantPlugins()
static void	releaseSystemPlugin(PluginMeta pluginMeta) Gibt geladene Jar Resourcen wieder frei.
static void	releaseSystemPlugins()
static boolean	scanAndRegisterMandantPlugin(Mandant man, PluginMeta pluginMeta, byte[] jarData) Registriert ein Jar-File im mandanten-spezifischen Plugin Verzeichnis.
static boolean	scanAndRegisterSystemPlugin(PluginMeta pluginMeta, byte[] jarData) Registriert ein Jar-File im system-spezifischen Plugin Verzeichnis.
static void	scanForAllPlugins()
static void	scanMandantPlugins()
static void	scanSystemPlugins()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_SCOPE

public static final String SYSTEM_SCOPE

See Also:

Constant Field Values

Constructor Detail

PluginManager

public PluginManager()

Method Detail

scanForAllPlugins

public static void scanForAllPlugins()

scanAndRegisterMandantPlugin

public static boolean scanAndRegisterMandantPlugin(Mandant man,
                                                   PluginMeta pluginMeta,
                                                   byte[] jarData)

Registriert ein Jar-File im mandanten-spezifischen Plugin Verzeichnis. Existiert bereits ein Instanz, wird diese deregistriert und neu initialisiert bzw. durch die neu hochgeladene Jar-Datei ersetzt.

Parameters:

man -

pluginMeta -

jarData - (kann null sein, dann wird vorhandene Jar Datei deregistriert und neu initialisiert...)

Returns:

Statusflag true wenn alles ok war, sonst false

scanMandantPlugins

public static void scanMandantPlugins()

scanAndRegisterSystemPlugin

public static boolean scanAndRegisterSystemPlugin(PluginMeta pluginMeta,
                                                  byte[] jarData)

Registriert ein Jar-File im system-spezifischen Plugin Verzeichnis. Existiert bereits ein Instanz, wird diese deregistriert und neu initialisiert bzw. durch die neu hochgeladene Jar-Datei ersetzt.

Parameters:

pluginMeta -

jarData - (kann null sein, dann wird vorhandene Jar Datei deregistriert und neu initialisiert...)

Returns:

Statusflag true wenn alles ok war, sonst false

scanSystemPlugins

public static void scanSystemPlugins()

isPluginJar

public static boolean isPluginJar(File file)

Testet, ob es sich beim übergebenen File-Objekt um ein Jar-File mit FormCycle spezifischen Plugin-Klassen handelt

Parameters:

file -

Returns:

true wenn im übergebenen Jar Klassen enthalten sind, welche IFCPlugin implementieren false wenn nicht

getMandantPluginJar

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

Liefert File-Handle zum mandanten abhängigen Jar-File (Achtung, es kann nicht davon ausgegangen werden, das File existiert, deshalb -> File.exists())

Parameters:

man -

jarName -

Returns:

Throws:

IOException

getSystemPluginJar

public static File getSystemPluginJar(String jarName)
                               throws IOException

Liefert File-Handle zum mandanten abhängigen Jar-File (Achtung, es kann nicht davon ausgegangen werden, das File existiert, deshalb -> File.exists())

Parameters:

man -

jarName -

Returns:

Throws:

IOException

registerSystemPlugin

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

registerMandantPlugin

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

deletePlugin

public static boolean deletePlugin(PluginMeta pluginMeta)

getMandantPlugins

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

Liefert ein Set mit allen für den übergebenen Mandanten registrierten Plugins, eines bestimmten EPluginTypes, zurück.

Parameters:

man - der Mandant

type - der angeforderte EPluginTypes

Returns:

Set mit allen registrierten IFCPlugin-Instanzen vom angeforderten EPluginTypes, die für einen Mandant registriert wurden oder leeres Set

getMandantPlugins

public static List<PluginMeta> getMandantPlugins(Mandant man)

Liefert eine Liste mit allen für einen Mandanten registrierten Plugins zurück.

Parameters:

man -

Returns:

getSystemPlugins

public static SortedSet<IFCPlugin> getSystemPlugins(EPluginTypes type)

Liefert ein Set mit allen im System registrierten Plugins eines bestimmten EPluginTypes zurück.

Parameters:

type - der angeforderte EPluginTypes

Returns:

Set mit allen registrierten IFCPlugin-Instanzen vom angeforderten EPluginTypes oder leeres Set

getSystemPlugins

public static List<PluginMeta> getSystemPlugins()

getAllPlugins

public static SortedSet<IFCPlugin> getAllPlugins(Mandant man,
                                                 EPluginTypes type)

Liefert ein Set aller für einen Mandanten registrierten Plugins eines bestimmten Plugin-Typs zurück. (Hinweis: Es werden Mandant und Systemplugins zurückgeliefert)

Parameters:

man -

type -

Returns:

getAllMonitorPlugins

public static Map<String,Set<IMonitorPlugin>> getAllMonitorPlugins()

getPluginByName

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

Gibt ein anhand des Namens gesuchtes IFCPlugin-Objekt oder null zurück.

Parameters:

man -

type -

pluginName -

Returns:

getSystemPluginByName

public static IFCPlugin getSystemPluginByName(EPluginTypes type,
                                              String pluginName)

releaseAllPlugins

public static void releaseAllPlugins()

releaseSystemPlugin

public static void releaseSystemPlugin(PluginMeta pluginMeta)

Gibt geladene Jar Resourcen wieder frei. Dabei wird folgendes durchgeführt:

• Es werden die im PluginMeta hinterlegten ClassLoader geschlossen
• Es wird das Jar-File an sich geschlossen, das heißt sämtliche offene Streams auf das Jar-File
• das PluginMeta-Object wird aus der intern verwalteten Liste entfernt

Parameters:

pluginMeta -

releaseMandantPlugin

public static void releaseMandantPlugin(Mandant man,
                                        PluginMeta pluginMeta)

Gibt geladene Jar Resourcen wieder frei. Dabei wird folgendes durchgeführt:

• Es werden die im PluginMeta hinterlegten ClassLoader geschlossen
• Es wird das Jar-File an sich geschlossen, das heißt sämtliche offene Streams auf das Jar-File
• Etwaige Referenzen auf IMonitorPlugin-Objekte werden aus der internen Liste entfernt
• das PluginMeta-Object wird aus der intern verwalteten Liste entfernt

Parameters:

man -

pluginMeta -

releaseMandantPlugins

public static void releaseMandantPlugins()

releaseSystemPlugins

public static void releaseSystemPlugins()

existsJarFile

public static boolean existsJarFile(PluginMeta pm)

createSystemProtocolEntry

public static void createSystemProtocolEntry(IEntityContext ec,
                                             String protocolEntry,
                                             Object... params)

createMandantProtocolEntry

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

getPluginNames

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

getPluginNameMap

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