Package lumis.portal.deployment.stepexecutable.script

Class AbstractScriptStepExecutable

java.lang.Object

lumis.portal.deployment.stepexecutable.AbstractDeploymentStepExecutable

lumis.portal.deployment.stepexecutable.script.AbstractScriptStepExecutable

All Implemented Interfaces:

java.io.Serializable, IDeploymentStepExecutable, IScriptStepExecutable, IStepExecutable

Direct Known Subclasses:

DisplayMessageStepExecutable, RemoveBigDataDocumentTypesStepExecutable, RemoveGlobalNonReferencedEntriesStepExecutable, RunClassStepExecutable, RunSqlStepExecutable

public abstract class AbstractScriptStepExecutable
extends AbstractDeploymentStepExecutable
implements IScriptStepExecutable

Base IScriptStepExecutable.

Since:

7.1.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface lumis.portal.deployment.stepexecutable.script.IScriptStepExecutable

IScriptStepExecutable.ScriptOwnerType

Constructor Summary

Constructors

Constructor	Description
AbstractScriptStepExecutable(java.util.Map<java.lang.String,java.util.List<EnvironmentType>> environment, java.lang.String message)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	execute(IStep step)	Executes the step code.
protected DeploymentMessageWriter[]	getDeploymentMessageWriters()	Returns the deployment message writer to be used.
java.util.Map<java.lang.String,java.util.List<EnvironmentType>>	getEnvironments()	Returns the environments.
protected java.lang.String	getMessageInternal()	Returns the message.
java.lang.String	getOwnerId()	Returns this step's owner identifier.
IScriptStepExecutable.ScriptOwnerType	getOwnerType()	Returns this step's owner type.
java.lang.String	getStepId()	Returns this step identifier.
void	setOwnerId(java.lang.String ownerId)	Sets this step's owner identifier.
void	setOwnerType(IScriptStepExecutable.ScriptOwnerType ownerType)	Sets this step's owner type.
void	setStepId(java.lang.String stepId)	Sets this step identifier.
void	stepIgnored(IStep step)	Callback invoked when the step is ignored.

Methods inherited from class lumis.portal.deployment.stepexecutable.AbstractDeploymentStepExecutable

executeInternal, getDescription, getDescriptionInternal, getLogger, getMessage, isMandatory, localize

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.deployment.stepexecutable.IDeploymentStepExecutable

isMandatory

Methods inherited from interface lumis.portal.interactiveprocess.IStepExecutable

getDescription, getMessage

Constructor Detail

AbstractScriptStepExecutable

public AbstractScriptStepExecutable(java.util.Map<java.lang.String,java.util.List<EnvironmentType>> environment,
                                    java.lang.String message)

Creates a new instance.

Parameters:

environment - the environment configuration.

message - the message to be displayed.

Since:

7.1.0

Method Detail

getEnvironments

public java.util.Map<java.lang.String,java.util.List<EnvironmentType>> getEnvironments()

Description copied from interface: IScriptStepExecutable

Returns the environments.

Specified by:

getEnvironments in interface IScriptStepExecutable

Returns:

the environments.

getMessageInternal

protected java.lang.String getMessageInternal()
                                       throws java.lang.Throwable

Description copied from class: AbstractDeploymentStepExecutable

Returns the message.

Specified by:

getMessageInternal in class AbstractDeploymentStepExecutable

Returns:

the message.

Throws:

java.lang.Throwable

execute

public void execute(IStep step)
             throws java.lang.Throwable

Description copied from interface: IStepExecutable

Executes the step code.

Specified by:

execute in interface IStepExecutable

Overrides:

execute in class AbstractDeploymentStepExecutable

Parameters:

step - the step owner of the executable.

Throws:

java.lang.Throwable

stepIgnored

public void stepIgnored(IStep step)
                 throws java.lang.Throwable

Description copied from interface: IStepExecutable

Callback invoked when the step is ignored.

Specified by:

stepIgnored in interface IStepExecutable

Overrides:

stepIgnored in class AbstractDeploymentStepExecutable

Parameters:

step - the ignored step.

Throws:

java.lang.Throwable

getOwnerId

public java.lang.String getOwnerId()

Description copied from interface: IScriptStepExecutable

Returns this step's owner identifier.

Specified by:

getOwnerId in interface IScriptStepExecutable

Returns:

this step's owner identifier.

setOwnerId

public void setOwnerId(java.lang.String ownerId)

Description copied from interface: IScriptStepExecutable

Sets this step's owner identifier.

Specified by:

setOwnerId in interface IScriptStepExecutable

Parameters:

ownerId - this step's owner identifier.

getOwnerType

public IScriptStepExecutable.ScriptOwnerType getOwnerType()

Description copied from interface: IScriptStepExecutable

Returns this step's owner type.

Specified by:

getOwnerType in interface IScriptStepExecutable

Returns:

this step's owner type.

setOwnerType

public void setOwnerType(IScriptStepExecutable.ScriptOwnerType ownerType)

Description copied from interface: IScriptStepExecutable

Sets this step's owner type.

Specified by:

setOwnerType in interface IScriptStepExecutable

Parameters:

ownerType - this step's owner type.

getStepId

public java.lang.String getStepId()

Description copied from interface: IScriptStepExecutable

Returns this step identifier.

Specified by:

getStepId in interface IScriptStepExecutable

Returns:

this step identifier.

setStepId

public void setStepId(java.lang.String stepId)

Description copied from interface: IScriptStepExecutable

Sets this step identifier.

Specified by:

setStepId in interface IScriptStepExecutable

Parameters:

stepId - this step identifier.

getDeploymentMessageWriters

protected DeploymentMessageWriter[] getDeploymentMessageWriters()

Description copied from class: AbstractDeploymentStepExecutable

Returns the deployment message writer to be used.

Specified by:

getDeploymentMessageWriters in class AbstractDeploymentStepExecutable

Returns:

the deployment message writer to be used.