Class DefaultPluginLifecycleData

java.lang.Object

de.xima.fc.plugin.lifecycle.DefaultPluginLifecycleData

All Implemented Interfaces:

IPluginDefaultLifecycleData, IPluginInitializeBeanData, IPluginInitializeData, IPluginInstallData, IPluginShutdownData, IPluginUninstallData

Direct Known Subclasses:

DefaultPluginValidationData

public class DefaultPluginLifecycleData
extends Object
implements IPluginInitializeData, IPluginInitializeBeanData, IPluginShutdownData, IPluginInstallData, IPluginUninstallData

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface IPluginDefaultLifecycleData

SYSTEM_SCOPE_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultPluginLifecycleData(PluginRuntime runtime)

Method Summary

Modifier and Type	Method	Description
Mandant	getClient()	Gets the client where the plugin is installed or null if it is installed in system scope.
IPluginFileHelper	getFileHelper()	Gets the helper-class for working with plugin-files
FrontendServer	getFrontendServer()	Gets the frontend-server where the plugin is installed or null if it is installed on an master-server
IPluginManifest	getManifest()	Gets the manifest of the plugin.
String	getPluginFileKey()	Gets the plugin file key of the plugin file.
String	getPluginKey()	Gets the plugin key of the plugin.
Properties	getProperties()	Returns the properties of the plugin
IPluginResourceHelper	getResourceHelper()	Gets the helper-class for working with resources
String	getRuntimeKey()	Returns the plugin-runtime-key
String	getScopeKey()	Returns the plugin scope-key: Could be the IPluginDefaultLifecycleData.SYSTEM_SCOPE_KEY or the uuid of the client

Methods inherited from class Object

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

Constructor Details

DefaultPluginLifecycleData

public DefaultPluginLifecycleData(PluginRuntime runtime)

Method Details

getScopeKey

public String getScopeKey()

Description copied from interface: IPluginDefaultLifecycleData

Returns the plugin scope-key: Could be the IPluginDefaultLifecycleData.SYSTEM_SCOPE_KEY or the uuid of the client

Specified by:

getScopeKey in interface IPluginDefaultLifecycleData

Returns:

Client UUID or IPluginDefaultLifecycleData.SYSTEM_SCOPE_KEY

getManifest

public IPluginManifest getManifest()

Description copied from interface: IPluginDefaultLifecycleData

Gets the manifest of the plugin.

Specified by:

getManifest in interface IPluginDefaultLifecycleData

Returns:

The manifest of the plugin.

getPluginKey

public String getPluginKey()

Description copied from interface: IPluginDefaultLifecycleData

Gets the plugin key of the plugin. The key uniquely identifies the plugin. A plugin may consist of multiple JAR files. In that case, each JAR file has a different IPluginDefaultLifecycleData.getPluginFileKey().

Specified by:

getPluginKey in interface IPluginDefaultLifecycleData

Returns:

The plugin key.

getPluginFileKey

public String getPluginFileKey()

Description copied from interface: IPluginDefaultLifecycleData

Gets the plugin file key of the plugin file. The key uniquely identifies the plugin JAR file. A plugin may consist of multiple JAR files. In that case, each JAR file has a different plugin file key, but the same IPluginDefaultLifecycleData.getPluginKey(). If a plugin only has one JAR file, the file key is usually empty.

Specified by:

getPluginFileKey in interface IPluginDefaultLifecycleData

Returns:

The plugin file key.

getRuntimeKey

public String getRuntimeKey()

Description copied from interface: IPluginDefaultLifecycleData

Returns the plugin-runtime-key

Specified by:

getRuntimeKey in interface IPluginDefaultLifecycleData

Returns:

The plugin-runtime-key

getClient

public Mandant getClient()

Description copied from interface: IPluginDefaultLifecycleData

Gets the client where the plugin is installed or null if it is installed in system scope.

Specified by:

getClient in interface IPluginDefaultLifecycleData

Returns:

The client or null if the plugin is installed in system scope.

getFrontendServer

public FrontendServer getFrontendServer()

Description copied from interface: IPluginDefaultLifecycleData

Gets the frontend-server where the plugin is installed or null if it is installed on an master-server

Specified by:

getFrontendServer in interface IPluginDefaultLifecycleData

Returns:

The frontend server, or null if the plugin is installed in on an master-server

getProperties

public Properties getProperties()

Description copied from interface: IPluginDefaultLifecycleData

Returns the properties of the plugin

Specified by:

getProperties in interface IPluginDefaultLifecycleData

Returns:

The plugin properties.

getFileHelper

public IPluginFileHelper getFileHelper()

Description copied from interface: IPluginDefaultLifecycleData

Gets the helper-class for working with plugin-files

Specified by:

getFileHelper in interface IPluginDefaultLifecycleData

Returns:

The plugin file helper

getResourceHelper

public IPluginResourceHelper getResourceHelper()

Description copied from interface: IPluginDefaultLifecycleData

Gets the helper-class for working with resources

Specified by:

getResourceHelper in interface IPluginDefaultLifecycleData

Returns:

The plugin resource helper.