Package org.ametys.core.migration.handler.impl

Class ScriptVersionHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.handler.impl.ScriptVersionHandler

All Implemented Interfaces:

VersionHandler, LogEnabled, Serviceable

public class ScriptVersionHandler
extends AbstractLogEnabled
implements VersionHandler, Serviceable

Version Handler which use a script as version storage

Field Summary

Fields

Modifier and Type	Field	Description
protected ScriptHandler	_scriptHandler	Script Handler
protected SourceResolver	_sourceResolver	Source resolver

Constructor Summary

Constructors

Constructor	Description
ScriptVersionHandler()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_getAdditionalParameters(String componentId, Configuration versionConfiguration)	Generate a Map of objects that will be passed to the script
protected String	_getScript(String componentId, Configuration versionConfiguration)	Get the content of the script from the actionData
void	addVersion(Version newVersion)	Adds a new version for a component
VersionConfiguration	getConfiguration(String componentId, Configuration versionConfiguration)	Create a specific object containing usefull data for the handler/storage
List<Version>	getCurrentVersions(String componentId, VersionConfiguration configuration)	Get the list of all curent versions for this component id based on the configuration
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_sourceResolver

protected SourceResolver _sourceResolver

Source resolver

_scriptHandler

protected ScriptHandler _scriptHandler

Script Handler

Constructor Details

ScriptVersionHandler

public ScriptVersionHandler()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCurrentVersions

public List<Version> getCurrentVersions(String componentId,
 VersionConfiguration configuration)
                                 throws MigrationException,
NotMigrableInSafeModeException

Description copied from interface: VersionHandler

Get the list of all curent versions for this component id based on the configuration

Specified by:

getCurrentVersions in interface VersionHandler

Parameters:

componentId - id to check

configuration - configuration of this version

Returns:

a non-null list of Version. Can be an empty list if no version can be computed (e.g. configuration not filled). Beware, returning an empty list will not initialize the component ; to initialize a component, you need to return a list with a Version with null id.

Throws:

MigrationException - Something went wrong

NotMigrableInSafeModeException - Impossible to determine the version (e.g. Safe Mode without access to the conf)

addVersion

public void addVersion(Version newVersion)
                throws MigrationException

Description copied from interface: VersionHandler

Adds a new version for a component

Specified by:

addVersion in interface VersionHandler

Parameters:

newVersion - Version to set

Throws:

MigrationException - Something went wrong

_getScript

protected String _getScript(String componentId,
 Configuration versionConfiguration)
                     throws MigrationException

Get the content of the script from the actionData

Parameters:

componentId - id of the component

versionConfiguration - configuration of this version

Returns:

The script as a String (either from the config or from a file to parse)

Throws:

MigrationException - Something went wrong

getConfiguration

public VersionConfiguration getConfiguration(String componentId,
 Configuration versionConfiguration)
                                      throws ConfigurationException,
NotMigrableInSafeModeException

Description copied from interface: VersionHandler

Create a specific object containing usefull data for the handler/storage

Specified by:

getConfiguration in interface VersionHandler

Parameters:

componentId - id of the component

versionConfiguration - configuration from the plugin.xml

Returns:

the confuguration object

Throws:

ConfigurationException - something wrong in the configuration

NotMigrableInSafeModeException - Impossible to determine the version (e.g. Safe Mode without access to the conf)

_getAdditionalParameters

protected Map<String,Object> _getAdditionalParameters(String componentId,
 Configuration versionConfiguration)

Generate a Map of objects that will be passed to the script

Parameters:

componentId - id of the component

versionConfiguration - configuration from the plugin.xml

Returns:

a Map of objects that will be passed to the script (componentId, versionConfiguration, logger)