Package org.ametys.core.migration.action

Interface Action

All Known Implementing Classes:

JavaAction, ManualAction, NoOpAction, ScriptAction, SqlInitializationAction, SqlUpgradeAction

public interface Action

Interface for actions components

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

Method Details

act

void act(MigrationEngine.ActionData actionData)
  throws MigrationException

Run the action with the provided data

Parameters:

actionData - data needed to do the action

Throws:

MigrationException - Something went wrong

createActionConfiguration

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

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