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

Class ScriptActionData

java.lang.Object

org.ametys.core.migration.action.data.impl.AbstractActionData

org.ametys.core.migration.action.data.impl.ScriptActionData

All Implemented Interfaces:

ActionData

public class ScriptActionData
extends AbstractActionData

Data for an Script upgrade

Field Summary

Fields inherited from class org.ametys.core.migration.action.data.impl.AbstractActionData

_comment, _from, _pluginName, _restartRequired, _type, _version, _versionNumber

Constructor Summary

Constructors

Constructor	Description
ScriptActionData(String id, Version version, String comment, String from, String type, String pluginName, Configuration configuration, boolean restartRequired)	Create the Upgrade based on the upgrade xml line Must contains id and type, plus a script or the file where to get the script May contain restartAfter, component and/or file

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)
String	getScript()	Get the path for the script to run
String	toString()

Methods inherited from class org.ametys.core.migration.action.data.impl.AbstractActionData

getComment, getFrom, getPluginName, getType, getVersion, getVersionNumber, requiresRestart, setRequiresRestart

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptActionData

public ScriptActionData(String id,
 Version version,
 String comment,
 String from,
 String type,
 String pluginName,
 Configuration configuration,
 boolean restartRequired)
                 throws ConfigurationException

Create the Upgrade based on the upgrade xml line Must contains id and type, plus a script or the file where to get the script May contain restartAfter, component and/or file

Parameters:

id - id of the action

version - version concerned by this upgrade

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

type - type of action

pluginName - name of the plugin

configuration - the extension upgrade line to add

restartRequired - true if a restart is required after the action

Throws:

ConfigurationException - something is missing

Method Details

getFile

public String getFile()

Get the path for the script to run

Returns:

The path for the script to run

getScript

public String getScript()

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)

toString

public String toString()

Overrides:

toString in class AbstractActionData