de.xima.fc.plugin

Class PluginMeta

java.lang.Object

de.xima.fc.plugin.PluginMeta

All Implemented Interfaces:

Serializable

public class PluginMeta
extends Object
implements Serializable

Klasse ist ein Container für alle Jars, die Plugin-Klassen enthalten Kapselt folgende Eigenschaften: - Absoluter Pfad zur Jar-Datei (im Form eines Uniform Resource Locators) - Name der Jar-Datei - Map mit allen gefundenen Plugin-Klassen (Schlüssel: EPluginTypes) - Pfad zu Plugin-Properties - Instanz einer Propertykonfiguartion, wenn im Jar vorhanden

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginMeta()
PluginMeta(URL jarPath)

Method Summary

Modifier and Type	Method and Description
void	addMonitorPlugin(IMonitorPlugin monitorPlugin)
void	addPlugin(EPluginTypes pluginType, IFCPlugin xfcPlugin)
void	addUsedClassLoader(ClassLoader[] usedClassLoader)
void	callPluginShutdown() Führt für jedes registrierte Plugin eine release-Methode aus, wenn das Plugin vom die Schnittstelle IPluginRemove implementiert und leert anschließend die Liste mit den ermittelten Plugins.
boolean	equals(Object obj)
Set<IMonitorPlugin>	getAllMonitorPlugins()
String	getJarName() Liefert Namen der Jar-Datei zurück
URL	getJarPathName() Liefert den Ablagepfad zur Jar-Datei zurück
File	getPluginPropertyFolder() Getter für das Plugin-Verzeichnis
Set<IFCPlugin>	getPluginsOfType(EPluginTypes pluginType) Liefert eine Liste mit Plugins, die dem angeforderten Plugin-Typ entsprechen zurück.
org.apache.commons.configuration.PropertiesConfiguration	getProperties() Getter für die Plugin-Properties
Map<String,IBundleConfigParam>	getPropertiesConfiguration() Liefert die, durch den Entwickler festgelegten, Bundle-Property Namen, deren Werte durch den Bundle-Benutzer definiert werden müssen.
List<ClassLoader>	getUsedClassLoader() Liefert Liste mit allen ClassLoader, die für das Laden der Pluginklassen zustandig
int	hashCode()
boolean	hasMonitorPlugins() Prüft, ob MonitoringPlugins für das Plugin-Bundle registriert sind
boolean	hasPersitedData() Prüft ob am Objekt ein Dateipfad zu einer Jar-Datei hinterlegt ist.
boolean	hasPluginsOfType(EPluginTypes pluginType)
boolean	isSystemManaged()
void	saveProperties(Properties props) Methode zum Speichern der Properties eines Mandanten-Plugins
void	setJarName(String name) Setzt den Namen der Jar-Datei
void	setJarPathName(URL jarPathName) Setzt den Ablagepfad zur Jar-Datei
void	setPropertyConfiguration(IBundleProperties propertyConfiguration)
void	setSystemManaged(boolean isSystemManaged)
void	setUsedClassLoader(List<ClassLoader> classLoader)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginMeta

public PluginMeta()

PluginMeta

public PluginMeta(URL jarPath)

Method Detail

hasPersitedData

public boolean hasPersitedData()

Prüft ob am Objekt ein Dateipfad zu einer Jar-Datei hinterlegt ist. In diesem Fall wird davon ausgegangen, dass das hinterlegte Jar persitiert und in die Applikation eingebunden ist.

Returns:

true oder false

isSystemManaged

public boolean isSystemManaged()

Returns:

the isSystemManaged

setSystemManaged

public void setSystemManaged(boolean isSystemManaged)

Parameters:

isSystemManaged - the isSystemManaged to set

setJarName

public void setJarName(String name)

Setzt den Namen der Jar-Datei

Parameters:

name -

getJarName

public String getJarName()

Liefert Namen der Jar-Datei zurück

Returns:

setJarPathName

public void setJarPathName(URL jarPathName)

Setzt den Ablagepfad zur Jar-Datei

Parameters:

jarPath - the jarPath to set

getJarPathName

public URL getJarPathName()

Liefert den Ablagepfad zur Jar-Datei zurück

Returns:

getUsedClassLoader

public List<ClassLoader> getUsedClassLoader()

Liefert Liste mit allen ClassLoader, die für das Laden der Pluginklassen zustandig

Returns:

the usedClassLoader

addUsedClassLoader

public void addUsedClassLoader(ClassLoader[] usedClassLoader)

Parameters:

usedClassLoader - the usedClassLoader to set

setUsedClassLoader

public void setUsedClassLoader(List<ClassLoader> classLoader)

Parameters:

usedClassLoader -

addPlugin

public void addPlugin(EPluginTypes pluginType,
                      IFCPlugin xfcPlugin)

hasPluginsOfType

public boolean hasPluginsOfType(EPluginTypes pluginType)

getPluginsOfType

public Set<IFCPlugin> getPluginsOfType(EPluginTypes pluginType)

Liefert eine Liste mit Plugins, die dem angeforderten Plugin-Typ entsprechen zurück.

Parameters:

pluginType -

Returns:

callPluginShutdown

public void callPluginShutdown()

Führt für jedes registrierte Plugin eine release-Methode aus, wenn das Plugin vom die Schnittstelle IPluginRemove implementiert und leert anschließend die Liste mit den ermittelten Plugins.

addMonitorPlugin

public void addMonitorPlugin(IMonitorPlugin monitorPlugin)

getAllMonitorPlugins

public Set<IMonitorPlugin> getAllMonitorPlugins()

hasMonitorPlugins

public boolean hasMonitorPlugins()

Prüft, ob MonitoringPlugins für das Plugin-Bundle registriert sind

Returns:

true oder false

getProperties

public org.apache.commons.configuration.PropertiesConfiguration getProperties()

Getter für die Plugin-Properties

Returns:

Properties die Plugin-Properties

saveProperties

public void saveProperties(Properties props)

Methode zum Speichern der Properties eines Mandanten-Plugins

Parameters:

props - Properties

getPluginPropertyFolder

public File getPluginPropertyFolder()

Getter für das Plugin-Verzeichnis

Returns:

File das Plugin-Verzeichnis

getPropertiesConfiguration

public Map<String,IBundleConfigParam> getPropertiesConfiguration()

Liefert die, durch den Entwickler festgelegten, Bundle-Property Namen, deren Werte durch den Bundle-Benutzer definiert werden müssen.

Returns:

setPropertyConfiguration

public void setPropertyConfiguration(IBundleProperties propertyConfiguration)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object