lumis.portal.deployment.stepexecutable

Class AbstractDeploymentStepExecutable

java.lang.Object

lumis.portal.deployment.stepexecutable.AbstractDeploymentStepExecutable

All Implemented Interfaces:

Serializable, IDeploymentStepExecutable, IStepExecutable

Direct Known Subclasses:

AbstractScriptStepExecutable, CopyComponentPublicFilesStepExecutable, DeployComponentStepExecutable, PostProcessModuleMetadataStepExecutable, ProcessObserversStepExecutable, RebuildClassloadersStepExecutable, RegisterComponentStructuralElementsStepExecutable, RegisterModuleStepExecutable, RegisterModuleStructuralElementsStepExecutable, ReloadRestConfigurationsStepExecutable, RemoveComponentPublicFilesStepExecutable, RemoveComponentRegisterStepExecutable, UnregisterComponentStructuralElementsStepExecutable, UnregisterModuleStepExecutable, UnregisterModuleStructuralElementsStepExecutable, UpdateModuleResgistryStepExecutable, UpgradeComponentStepExecutable

public abstract class AbstractDeploymentStepExecutable
extends Object
implements IDeploymentStepExecutable

Abstract deployment step executable.

Since:

7.1.0

Version:

$Revision: 20413 $ $Date: 2017-07-20 19:57:40 +0000 (Thu, 20 Jul 2017) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractDeploymentStepExecutable()

Method Summary

Modifier and Type	Method and Description
void	execute(IStep step) Executes the step code.
protected abstract void	executeInternal(IStep step) Executes the step.
protected abstract DeploymentMessageWriter[]	getDeploymentMessageWriters() Returns the deployment message writer to be used.
String	getDescription() Returns the description of the step.
protected abstract String	getDescriptionInternal() Returns the description of this step.
protected abstract ILogger	getLogger() Returns the logger to be used.
String	getMessage() Returns the message of the step.
protected abstract String	getMessageInternal() Returns the message.
boolean	isMandatory() Indicates whether the step is mandatory.
String	localize(String localizableString, String... parameters) Localize a string with the given parameters.
void	stepIgnored(IStep step) Callback invoked when the step is ignored.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDeploymentStepExecutable

public AbstractDeploymentStepExecutable()

Method Detail

localize

public String localize(String localizableString,
                       String... parameters)
                throws PortalException

Localize a string with the given parameters.

Parameters:

localizableString - the localizable string.

parameters - the localization parameters.

Returns:

the localized string.

Throws:

PortalException

Since:

7.1.0

execute

public void execute(IStep step)
             throws Throwable

Description copied from interface: IStepExecutable

Executes the step code.

Specified by:

execute in interface IStepExecutable

Parameters:

step - the step owner of the executable.

Throws:

Throwable

getDescription

public String getDescription()

Description copied from interface: IStepExecutable

Returns the description of the step.

Specified by:

getDescription in interface IStepExecutable

Returns:

the description of the step.

getMessage

public String getMessage()

Description copied from interface: IStepExecutable

Returns the message of the step.

Specified by:

getMessage in interface IStepExecutable

Returns:

the message of the step.

stepIgnored

public void stepIgnored(IStep step)
                 throws Throwable

Description copied from interface: IStepExecutable

Callback invoked when the step is ignored.

Specified by:

stepIgnored in interface IStepExecutable

Parameters:

step - the ignored step.

Throws:

Throwable

isMandatory

public boolean isMandatory()

Description copied from interface: IDeploymentStepExecutable

Indicates whether the step is mandatory.

Specified by:

isMandatory in interface IDeploymentStepExecutable

Returns:

whether the step is mandatory.

getMessageInternal

protected abstract String getMessageInternal()
                                      throws Throwable

Returns the message.

Returns:

the message.

Throws:

Throwable

Since:

7.1.0

executeInternal

protected abstract void executeInternal(IStep step)
                                 throws Throwable

Executes the step.

Parameters:

step - the step.

Throws:

Throwable

Since:

7.1.0

getLogger

protected abstract ILogger getLogger()

Returns the logger to be used.

Returns:

the logger to be used.

Since:

7.1.0

getDeploymentMessageWriters

protected abstract DeploymentMessageWriter[] getDeploymentMessageWriters()

Returns the deployment message writer to be used.

Returns:

the deployment message writer to be used.

Since:

10.2.0

getDescriptionInternal

protected abstract String getDescriptionInternal()
                                          throws Throwable

Returns the description of this step.

Returns:

the description of this step.

Throws:

Throwable

Since:

7.1.0