Package org.ametys.core.migration.action

Class ScriptAction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.action.ScriptAction

All Implemented Interfaces:

Action, LogEnabled, Serviceable

public class ScriptAction
extends AbstractLogEnabled
implements Action, Serviceable

Script action: A script will be executed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptAction.ScriptActionConfiguration	ActionConfiguration with script location

Constructor Summary

Constructors

Constructor	Description
ScriptAction()

Method Summary

Modifier and Type	Method	Description
void	act(MigrationEngine.ActionData actionData)	Run the action with the provided data
ActionConfiguration	createActionConfiguration(String versionNumber, String type, String comment, String from, boolean restartRequired, boolean isInitialization, Configuration configuration)	Generate an ActionConfiguration linked to this kind of action
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

Constructor Details

ScriptAction

public ScriptAction()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

act

public void act(MigrationEngine.ActionData actionData)
         throws MigrationException

Description copied from interface: Action

Run the action with the provided data

Specified by:

act in interface Action

Parameters:

actionData - data needed to do the action

Throws:

MigrationException - Something went wrong

createActionConfiguration

public ActionConfiguration createActionConfiguration(String versionNumber,
 String type,
 String comment,
 String from,
 boolean restartRequired,
 boolean isInitialization,
 Configuration configuration)
                                              throws ConfigurationException

Description copied from interface: Action

Generate an ActionConfiguration linked to this kind of action

Specified by:

createActionConfiguration in interface Action

Parameters:

versionNumber - id of the action

type - type of action

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

restartRequired - true if a restart is required after the action

isInitialization - true for initialization action, false for upgrade

configuration - configuration of the action

Returns:

a ActionConfiguration for this type of action

Throws:

ConfigurationException - Configuration malformed