Package de.xima.fc.interfaces.plugin.lifecycle

Interface IPluginDefaultLifecycleData

All Known Subinterfaces:

IPluginInitializeBeanData, IPluginInitializeData, IPluginInstallData, IPluginShutdownData, IPluginUninstallData, IPluginValidationData

All Known Implementing Classes:

DefaultPluginLifecycleData, DefaultPluginValidationData

public interface IPluginDefaultLifecycleData

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	SYSTEM_SCOPE_KEY

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 SYSTEM_SCOPE_KEY or the uuid of the client

Field Detail

SYSTEM_SCOPE_KEY

static final String SYSTEM_SCOPE_KEY

See Also:

Constant Field Values

Method Detail

getScopeKey

String getScopeKey()

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

Returns:

Client UUID or SYSTEM_SCOPE_KEY

getPluginKey

String getPluginKey()

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 getPluginFileKey().

Returns:

The plugin key.

getPluginFileKey

String getPluginFileKey()

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 getPluginKey(). If a plugin only has one JAR file, the file key is usually empty.

Returns:

The plugin file key.

getRuntimeKey

String getRuntimeKey()

Returns the plugin-runtime-key

Returns:

The plugin-runtime-key

getClient

Mandant getClient()

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

Returns:

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

getProperties

Properties getProperties()

Returns the properties of the plugin

Returns:

The plugin properties.

getFrontendServer

FrontendServer getFrontendServer()

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

Returns:

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

getFileHelper

IPluginFileHelper getFileHelper()

Gets the helper-class for working with plugin-files

Returns:

The plugin file helper

getResourceHelper

IPluginResourceHelper getResourceHelper()

Gets the helper-class for working with resources

Returns:

The plugin resource helper.

getManifest

IPluginManifest getManifest()

Gets the manifest of the plugin.

Returns:

The manifest of the plugin.