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

Class ManualAction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.action.impl.ManualAction

All Implemented Interfaces:

Action, LogEnabled

public class ManualAction
extends AbstractLogEnabled
implements Action

Manual action: no code will be executed, and an exception will be thrown to stop the migration

Constructor Summary

Constructors

Constructor	Description
ManualAction()

Method Summary

Modifier and Type	Method	Description
void	doAction(ActionData actionData)	Run the action with the provided data
ActionData	generateActionData(String versionNumber, Version version, String comment, String from, String type, String pluginName, Configuration configuration, boolean restartRequired)	Generate an ActionData linked to this kind of action

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

ManualAction

public ManualAction()

Method Details

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

generateActionData

public ActionData generateActionData(String versionNumber,
 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:

versionNumber - 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