Package org.ametys.core.migration.action

Class DefaultActionConfiguration

java.lang.Object

org.ametys.core.migration.action.DefaultActionConfiguration

All Implemented Interfaces:

ActionConfiguration

Direct Known Subclasses:

JavaAction.JavaActionConfiguration, ScriptAction.ScriptActionConfiguration, SqlUpgradeAction.SqlUpgradeActionConfiguration

public class DefaultActionConfiguration
extends Object
implements ActionConfiguration

Representation of an upgrade line in the extension

Constructor Summary

Constructors

Constructor	Description
DefaultActionConfiguration(String versionNumber, String type, String comment, String from, boolean restartRequired, boolean isInitialization)	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	getType()	Get the upgrade type
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 restart)	Set the requireRestart flag
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultActionConfiguration

public DefaultActionConfiguration(String versionNumber,
 String type,
 String comment,
 String from,
 boolean restartRequired,
 boolean isInitialization)

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

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

getVersionNumber

public String getVersionNumber()

Description copied from interface: ActionConfiguration

Get the upgrade version number

Specified by:

getVersionNumber in interface ActionConfiguration

Returns:

upgrade version number

getType

public String getType()

Description copied from interface: ActionConfiguration

Get the upgrade type

Specified by:

getType in interface ActionConfiguration

Returns:

upgrade type

getComment

public String getComment()

Description copied from interface: ActionConfiguration

Get the comment about this action

Specified by:

getComment in interface ActionConfiguration

Returns:

The comment about this action

getFrom

public String getFrom()

Description copied from interface: ActionConfiguration

Get the upgrade "from" field

Specified by:

getFrom in interface ActionConfiguration

Returns:

upgrade "from" field

requiresRestart

public boolean requiresRestart()

Description copied from interface: ActionConfiguration

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

Specified by:

requiresRestart in interface ActionConfiguration

Returns:

true to restart server

setRequiresRestart

public void setRequiresRestart(boolean restart)

Description copied from interface: ActionConfiguration

Set the requireRestart flag

Specified by:

setRequiresRestart in interface ActionConfiguration

Parameters:

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