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

Class AbstractActionData

java.lang.Object

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

All Implemented Interfaces:

ActionData

Direct Known Subclasses:

JavaActionData, ManualActionData, ScriptActionData, SqlUpgradeActionData

public abstract class AbstractActionData
extends Object
implements ActionData

Representation of an upgrade line in the extension

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_comment	Comment about the action
protected String	_from	When an upgrade contains multiple upgrades, this represent the 1st upgrade impacted
protected String	_pluginName	Plugin containing the extension
protected boolean	_restartRequired	Is restart required after action
protected String	_type	Type of upgrade
protected Version	_version	Version used to determine the list of remaining upgrades
protected String	_versionNumber	number of the version created by this migration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractActionData(String versionNumber, 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 May contain restartAfter, component and/or file

Method Summary

Modifier and Type	Method	Description
String	getComment()	Get the comment about this action
String	getFrom()	Get the upgrade "from" field
String	getPluginName()	Get the name of the plugin of the extension
String	getType()	Get the upgrade type
Version	getVersion()	Get the version to apply this upgrade on
String	getVersionNumber()	Get the upgrade version number
boolean	requiresRestart()	If true at the end of the action, the server will be restarted
void	setRequiresRestart(boolean requiresRestart)	Set to requireRestart flag
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_versionNumber

protected String _versionNumber

number of the version created by this migration

_type

protected String _type

Type of upgrade

_comment

protected String _comment

Comment about the action

_from

protected String _from

When an upgrade contains multiple upgrades, this represent the 1st upgrade impacted

_version

protected Version _version

Version used to determine the list of remaining upgrades

_pluginName

protected String _pluginName

Plugin containing the extension

_restartRequired

protected boolean _restartRequired

Is restart required after action

Constructor Detail

AbstractActionData

protected AbstractActionData(String versionNumber,
                             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 May contain restartAfter, component and/or file

Parameters:

versionNumber - version number 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 containing the extension

configuration - the extension upgrade line to add

restartRequired - true if a restart is required after the action

Throws:

ConfigurationException - id or type missing

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getVersionNumber

public String getVersionNumber()

Description copied from interface: ActionData

Get the upgrade version number

Specified by:

getVersionNumber in interface ActionData

Returns:

upgrade version number

getType

public String getType()

Description copied from interface: ActionData

Get the upgrade type

Specified by:

getType in interface ActionData

Returns:

upgrade type

getComment

public String getComment()

Description copied from interface: ActionData

Get the comment about this action

Specified by:

getComment in interface ActionData

Returns:

The comment about this action

getFrom

public String getFrom()

Description copied from interface: ActionData

Get the upgrade "from" field

Specified by:

getFrom in interface ActionData

Returns:

upgrade "from" field

getVersion

public Version getVersion()

Description copied from interface: ActionData

Get the version to apply this upgrade on

Specified by:

getVersion in interface ActionData

Returns:

the version to apply this upgrade on

getPluginName

public String getPluginName()

Description copied from interface: ActionData

Get the name of the plugin of the extension

Specified by:

getPluginName in interface ActionData

Returns:

The name of the plugin of the extension

requiresRestart

public boolean requiresRestart()

Description copied from interface: ActionData

If true at the end of the action, the server will be restarted

Specified by:

requiresRestart in interface ActionData

Returns:

true to restart server

setRequiresRestart

public void setRequiresRestart(boolean requiresRestart)

Description copied from interface: ActionData

Set to requireRestart flag

Specified by:

setRequiresRestart in interface ActionData

Parameters:

requiresRestart - true to indicates that the server will require a restart at the end of the action