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

Class SqlUpgradeAction

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.migration.action.impl.SqlUpgradeAction

All Implemented Interfaces:

Action, LogEnabled, Serviceable

Direct Known Subclasses:

SqlInitializationAction

public class SqlUpgradeAction
extends AbstractLogEnabled
implements Action, Serviceable

SQL action: A script will be executed

Field Summary

Fields

Modifier and Type	Field	Description
protected SourceResolver	_sourceResolver	Source resolver

Constructor Summary

Constructors

Constructor	Description
SqlUpgradeAction()

Method Summary

Modifier and Type	Method	Description
protected void	_upgrade(SqlUpgradeActionData sqlUpgradeData, SqlVersion sqlVersion)	Do the upgrade with the right objects
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
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

Constructor Details

SqlUpgradeAction

public SqlUpgradeAction()

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

_upgrade

protected void _upgrade(SqlUpgradeActionData sqlUpgradeData,
 SqlVersion sqlVersion)
                 throws MigrationException

Do the upgrade with the right objects

Parameters:

sqlUpgradeData - upgrade data

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