Package org.ametys.core.migration.action

Class SqlUpgradeAction.SqlUpgradeActionConfiguration

java.lang.Object

org.ametys.core.migration.action.DefaultActionConfiguration

org.ametys.core.migration.action.SqlUpgradeAction.SqlUpgradeActionConfiguration

All Implemented Interfaces:

ActionConfiguration

Direct Known Subclasses:

SqlInitializationAction.SqlInitializationActionConfiguration

Enclosing class:

SqlUpgradeAction

public static class SqlUpgradeAction.SqlUpgradeActionConfiguration
extends DefaultActionConfiguration

ActionConfiguration with sql script location

Constructor Summary

Constructors

Constructor	Description
SqlUpgradeActionConfiguration(String versionNumber, String type, String comment, String from, boolean restartRequired, boolean isInitialization, String file, String plugin)	Create an ActionConfiguration for use with sql upgrades actions.

Method Summary

Modifier and Type	Method	Description
String	getFile()	Get the path for the script to run
String	getPlugin()	Get the plugin containing the sql script (either the default plugin of the extension, or the one passed in the config)

Methods inherited from class org.ametys.core.migration.action.DefaultActionConfiguration

getComment, getFrom, getType, getVersionNumber, requiresRestart, setRequiresRestart, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SqlUpgradeActionConfiguration

public SqlUpgradeActionConfiguration(String versionNumber,
 String type,
 String comment,
 String from,
 boolean restartRequired,
 boolean isInitialization,
 String file,
 String plugin)

Create an ActionConfiguration for use with sql upgrades actions.

Parameters:

versionNumber - version number of the action

type - type of action

comment - The 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

file - the location of the sql script

plugin - the plugin of the sql script or null to default to the component plugin

Method Details

getFile

public String getFile()

Get the path for the script to run

Returns:

The path for the script to run

getPlugin

public String getPlugin()

Get the plugin containing the sql script (either the default plugin of the extension, or the one passed in the config)

Returns:

The plugin containing the sql script (either the default plugin of the extension, or the one passed in the config)