Package org.ametys.core.migration.action.impl

Class ScriptAction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.action.impl.ScriptAction

All Implemented Interfaces:

Action, LogEnabled, Serviceable

public class ScriptAction
extends AbstractLogEnabled
implements Action, Serviceable

SQL action : A script will be executed

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ScriptAction()

Method Summary

Modifier and Type	Method	Description
void	doAction(ActionData actionData)	Run the action with the provided data
ActionData	generateActionData(String id, Version version, String comment, String from, String type, String pluginName, Configuration configuration, boolean restartRequired)	Generate an ActionData linked to this kind of action
protected String	getScript(ScriptActionData scriptActionData)	Get the content of the script from the actionData
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

ScriptAction

public ScriptAction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

doAction

public void doAction(ActionData actionData)
              throws MigrationException

Description copied from interface: Action

Run the action with the provided data

Specified by:

doAction in interface Action

Parameters:

actionData - data needed to do the action (contains the version)

Throws:

MigrationException - Something went wrong

getScript

protected String getScript(ScriptActionData scriptActionData)
                    throws MigrationException

Get the content of the script from the actionData

Parameters:

scriptActionData - actionData containing info about the upgrade

Returns:

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

Throws:

MigrationException - Something went wrong

generateActionData

public ActionData generateActionData(String id,
 Version version,
 String comment,
 String from,
 String type,
 String pluginName,
 Configuration configuration,
 boolean restartRequired)
                              throws MigrationException,
ConfigurationException

Description copied from interface: Action

Generate an ActionData linked to this kind of action

Specified by:

generateActionData in interface Action

Parameters:

id - id of the action

version - original version

comment - Comment about this action

from - if this actions is the equivalent of multiple actions, this is the version id just before the 1st action impacted by this action

type - type of action

pluginName - name of the plugin

configuration - configuration of the action

restartRequired - true if a restart is required after the action

Returns:

a ActionData for this type of action

Throws:

MigrationException - Something went wrong

ConfigurationException - Configuration malformed