Package org.ametys.core.migration.action

Interface Action

All Known Implementing Classes:

JavaAction, ManualAction, ScriptAction, SqlInitializationAction, SqlUpgradeAction

public interface Action

Interface for actions components

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

Method Details

doAction

void doAction(ActionData actionData)
       throws MigrationException

Run the action with the provided data

Parameters:

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

Throws:

MigrationException - Something went wrong

generateActionData

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

Generate an ActionData linked to this kind of 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