Package de.xima.fc.plugin.lifecycle

Class DefaultPluginValidationData

java.lang.Object

de.xima.fc.plugin.lifecycle.DefaultPluginLifecycleData

de.xima.fc.plugin.lifecycle.DefaultPluginValidationData

All Implemented Interfaces:

IPluginDefaultLifecycleData, IPluginInitializeBeanData, IPluginInitializeData, IPluginInstallData, IPluginShutdownData, IPluginUninstallData, IPluginValidationData

public final class DefaultPluginValidationData
extends DefaultPluginLifecycleData
implements IPluginValidationData

Default POJO implementation of IPluginValidationData.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.interfaces.plugin.lifecycle.IPluginDefaultLifecycleData

SYSTEM_SCOPE_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultPluginValidationData(PluginRuntime runtime, Properties properties, Locale locale)	Creates a new plugin validation data instance with the given data.

Method Summary

Modifier and Type	Method	Description
Locale	getLocale()	Gets the locale for the validation check.
Properties	getProperties()	Returns the properties of the plugin

Methods inherited from class de.xima.fc.plugin.lifecycle.DefaultPluginLifecycleData

getClient, getFileHelper, getFrontendServer, getManifest, getResourceHelper, getRuntimeKey, getScopeKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.plugin.lifecycle.IPluginDefaultLifecycleData

getClient, getFileHelper, getFrontendServer, getManifest, getResourceHelper, getRuntimeKey, getScopeKey

Constructor Detail

DefaultPluginValidationData

public DefaultPluginValidationData(PluginRuntime runtime,
                                   Properties properties,
                                   Locale locale)

Creates a new plugin validation data instance with the given data.

Parameters:

runtime - Runtime of the plugin, usually a temporary runtime as the plugin should not be put into service if validation fails.

properties - Current set of properties representing the configuration of the plugin.

locale - Current locale for locale-sensitive operations, such as for constructing localized error messages.

Method Detail

getProperties

public Properties getProperties()

Description copied from interface: IPluginDefaultLifecycleData

Returns the properties of the plugin

Specified by:

getProperties in interface IPluginDefaultLifecycleData

Specified by:

getProperties in interface IPluginValidationData

Overrides:

getProperties in class DefaultPluginLifecycleData

Returns:

Properties

getLocale

public Locale getLocale()

Description copied from interface: IPluginValidationData

Gets the locale for the validation check. The locale may be used e.g. to generated localized error messages.

Specified by:

getLocale in interface IPluginValidationData

Returns:

The locale for locale-sensitive validation operations.