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 final 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.
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 Details

SYSTEM_SCOPE_KEY

static final String SYSTEM_SCOPE_KEY

See Also:

• Constant Field Values

Method Details

getScopeKey

String getScopeKey()

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

Returns:

String uuid or SYSTEM_SCOPE_KEY

getRuntimeKey

String getRuntimeKey()

Returns the plugin-runtime-key

Returns:

String 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:

Mandant or null if the plugin is installed in system-scope

getProperties

Properties getProperties()

Returns the properties of the plugin

Returns:

Properties

getFrontendServer

FrontendServer getFrontendServer()

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

Returns:

FrontendServer 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:

IPluginFileHelper

getResourceHelper

IPluginResourceHelper getResourceHelper()

Gets the helper-class for working with resources

Returns:

IPluginResourceHelper

getManifest

IPluginManifest getManifest()

Gets the manifest of the plugin.

Returns:

The manifest of the plugin.