Package de.xima.fc.plugin.runtime

Class PluginRuntime

java.lang.Object

de.xima.fc.plugin.runtime.PluginRuntime

All Implemented Interfaces:

Serializable

public class PluginRuntime
extends Object
implements Serializable

Model-class for a registered plugin

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginRuntime(Class<T> clazz, String scopeKey, String runtimeKey)
PluginRuntime(org.reflections.Reflections reflect, String runtimeName, String scopeKey, String runtimeKey)

Method Summary

Modifier and Type	Method	Description
<T extends IFCPlugin> void	addPlugin(T plugin)
void	addUnregisteredPlugin(Class<? extends IFCPlugin> pluginClazz)
void	delete()	Deprecated. use PluginManager.deletePlugin(PluginRuntime)
Set<IFCPlugin>	getAllPlugins()
ClassLoader[]	getClassLoaders()
String	getFutureScopeKey()	Deprecated. use getScopeKey()
long	getInstanciationTime()
File	getJarFile()
PluginManifest	getManifest()
String	getName()
<T extends IFCPlugin> Set<T>	getPluginsOfType(Class<T> clazz)
org.apache.commons.configuration.PropertiesConfiguration	getProperties()	Getter für die Plugin-Properties
Map<String,IBundleConfigParam>	getPropertiesConfiguration(Locale locale)	Returns a map with definitions of bundle configuration parameters.
org.reflections.Reflections	getReflections()
String	getRuntimeKey()
String	getScopeKey()
Set<Class<? extends IFCPlugin>>	getUnregisteredPlugins()
boolean	hasPersitedData()
boolean	isSystemManaged()
boolean	isSystemScope()
void	saveProperties(Properties props)	Methode zum Speichern der Properties eines Mandanten-Plugins
void	setPropertyConfiguration(List<IBundleProperties> propertyConfiguration)
void	shutdown()	Deprecated. use PluginManager.uninstallPlugin(String, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginRuntime

public PluginRuntime(Class<T> clazz,
                     String scopeKey,
                     String runtimeKey)

PluginRuntime

public PluginRuntime(org.reflections.Reflections reflect,
                     String runtimeName,
                     String scopeKey,
                     String runtimeKey)

Method Detail

getScopeKey

public String getScopeKey()

getRuntimeKey

public String getRuntimeKey()

getClassLoaders

public ClassLoader[] getClassLoaders()

isSystemManaged

public boolean isSystemManaged()

isSystemScope

public boolean isSystemScope()

getJarFile

public File getJarFile()

getReflections

public org.reflections.Reflections getReflections()

getName

public String getName()

addPlugin

public <T extends IFCPlugin> void addPlugin(T plugin)

getAllPlugins

public Set<IFCPlugin> getAllPlugins()

getUnregisteredPlugins

public Set<Class<? extends IFCPlugin>> getUnregisteredPlugins()

addUnregisteredPlugin

public void addUnregisteredPlugin(Class<? extends IFCPlugin> pluginClazz)

getPluginsOfType

public <T extends IFCPlugin> Set<T> getPluginsOfType(Class<T> clazz)

Parameters:

clazz - the plugin class

Returns:

A Set of IFCPlugin of the given class.

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)
                    throws IOException

Methode zum Speichern der Properties eines Mandanten-Plugins

Parameters:

props - Properties

Throws:

IOException - on errors while saving

getManifest

public PluginManifest getManifest()

getPropertiesConfiguration

public Map<String,IBundleConfigParam> getPropertiesConfiguration(Locale locale)

Returns a map with definitions of bundle configuration parameters. Key is the parameter name, value is a IBundleConfigParam that specifies which parameters are available.

Parameters:

locale - The locale for the current language.

Returns:

A Map with objects of type IBundleConfigParam.

setPropertyConfiguration

public void setPropertyConfiguration(List<IBundleProperties> propertyConfiguration)

hasPersitedData

public boolean hasPersitedData()

getInstanciationTime

public long getInstanciationTime()

shutdown

@Deprecated
public void shutdown()
              throws IOException

Deprecated.

use PluginManager.uninstallPlugin(String, String)

Throws:

IOException - on errors while shutdown

getFutureScopeKey

@Deprecated
public String getFutureScopeKey()

Deprecated.

use getScopeKey()

delete

@Deprecated
public void delete()
            throws IOException

Deprecated.

use PluginManager.deletePlugin(PluginRuntime)

Throws:

IOException - on errors while deletion