com.xebialabs.deployit.plugin.generic.deployed

Class ExecutedFolder<D extends Folder>

java.lang.Object

com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

com.xebialabs.deployit.plugin.api.udm.base.BaseDeployed<D,com.xebialabs.deployit.plugin.overthere.HostContainer>

com.xebialabs.deployit.plugin.generic.deployed.AbstractDeployed<D>

com.xebialabs.deployit.plugin.generic.deployed.ExecutedFolder<D>

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.udm.artifact.Artifact, com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact<D>, com.xebialabs.deployit.plugin.api.udm.ConfigurationItem, com.xebialabs.deployit.plugin.api.udm.Deployed<D,com.xebialabs.deployit.plugin.overthere.HostContainer>, com.xebialabs.deployit.plugin.api.udm.EmbeddedDeployedContainer<D,com.xebialabs.deployit.plugin.overthere.HostContainer>, java.io.Serializable, java.lang.Comparable<com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem>

@Metadata(virtual=true,
          description="Scripts in the folder are executed against a Container based on a naming convention")
public class ExecutedFolder<D extends Folder>
extends AbstractDeployed<D>
implements com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact<D>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.generic.deployed.AbstractDeployed

STEP_OPTION_NONE, STEP_OPTION_UPLOAD_ARTIFACT_DATA, STEP_OPTION_UPLOAD_CLASSPATH_RESOURCES, STEP_OPTION_UPLOAD_TEMPLATE_CLASSPATH_RESOURCES, STEP_OPTIONS_DEFAULT, STEP_OPTIONS_DESCRIPTION_SUFFIX, STEP_OPTIONS_REGEX

Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

id, syntheticProperties, type

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD

Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.EmbeddedDeployedContainer

CONTAINER_FIELD, DEPLOYABLE_FIELD

Constructor Summary

Constructors

Constructor and Description
ExecutedFolder()

Method Summary

Methods

Modifier and Type	Method and Description
protected static com.xebialabs.deployit.plugin.api.flow.Step	addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx, ExecutedFolder<?> deployed, java.util.List<java.io.File> scriptsToRun, java.lang.String scriptNameRegex, java.util.Set<java.lang.String> stepOptions, int order, java.lang.String verb)
protected com.xebialabs.deployit.plugin.api.flow.Step	addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx, ExecutedFolder<D> deployed, java.util.List<java.io.File> scriptsToRun, java.lang.String scriptNameRegex, java.util.Set<java.lang.String> stepOptions) Deprecated. Please use addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext, ExecutedFolder, java.util.List, String, java.util.Set, int, String)
protected java.util.List<java.io.File>	compareAndIdentifyOrderedRollbackScriptsToRunForUpdate(java.io.File previousFolder, java.io.File currentFolder)
protected java.util.List<java.io.File>	compareAndIdentifyOrderedScriptsToRunForUpdate(java.io.File previousFolder, java.io.File currentFolder)
protected java.util.Collection<java.io.File>	difference(java.util.List<java.io.File> previousFiles, java.util.List<java.io.File> currentFiles, boolean compareContents)
void	executeCreate(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)
void	executeDestroy(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)
void	executeModify(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx, com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)
protected java.lang.String	extractScriptPrefix(java.util.regex.Pattern pattern, java.lang.String scriptName)
protected java.util.List<java.io.File>	findScriptsToRun(java.io.File folder, java.lang.String pattern)
java.util.Set<java.lang.String>	getClasspathResources()
java.lang.String	getCommonScriptFolderName()
protected java.io.File	getDerivedArtifactAsFile()
java.lang.String	getDescription(java.lang.String script, java.lang.String verb)
java.lang.String	getExecutorScript()
com.xebialabs.overthere.OverthereFile	getFile()
java.util.Map<java.lang.String,java.lang.String>	getPlaceholders()
java.lang.String	getRollbackScriptPostfix()
java.lang.String	getRollbackScriptRecognitionRegex()
java.lang.String	getScriptRecognitionRegex()
D	getSourceArtifact()
java.util.Set<java.lang.String>	getTemplateClasspathResources()
protected java.util.List<java.io.File>	identifyAndOrderCreateScriptsInFolder(java.io.File folder)
protected java.util.List<java.io.File>	identifyAndOrderRollbackScriptsInFolder(java.io.File folder)
boolean	isCheckpointAfterFirstScript()
boolean	isExecuteModifiedScripts()
boolean	isExecuteRollbackForModifiedScripts()
protected static ScriptExecutionStep	newScriptExecutionStep(java.lang.String script, ExecutedFolder<?> deployed) Deprecated. Please use newScriptExecutionStep(String, ExecutedFolder, int, String)
protected static ScriptExecutionStep	newScriptExecutionStep(java.lang.String script, ExecutedFolder<?> deployed, int order, java.lang.String verb)
java.lang.String	resolveExpression(java.lang.String expression)
void	setCheckpointAfterFirstScript(boolean checkpointAfterFirstScript)
void	setClasspathResources(java.util.Set<java.lang.String> classpathResources)
void	setCommonScriptFolderName(java.lang.String commonScriptFolderName)
void	setExecuteModifiedScripts(boolean executeModifiedScripts)
void	setExecuteRollbackForModifiedScripts(boolean executeRollbackForModifiedScripts)
void	setExecutorScript(java.lang.String executorScript)
void	setFile(com.xebialabs.overthere.OverthereFile file)
void	setPlaceholders(java.util.Map<java.lang.String,java.lang.String> placeholders)
void	setRollbackScriptPostfix(java.lang.String rollbackScriptPostfix)
void	setRollbackScriptRecognitionRegex(java.lang.String rollbackScriptRecognitionRegex)
void	setScriptRecognitionRegex(java.lang.String scriptRecognitionRegex)
void	setTemplateClasspathResources(java.util.Set<java.lang.String> templateClasspathResources)
protected java.util.Set<com.xebialabs.deployit.plugin.generic.deployed.ExecutedFolder.FileNameAndContentsEqualityWrapper>	transform(java.util.List<java.io.File> files, boolean compareContents)

Methods inherited from class com.xebialabs.deployit.plugin.generic.deployed.AbstractDeployed

controlTaskDispatch, getCreateOptions, getCreateOrder, getCreateVerb, getDeployedApplication, getDeployedAsFreeMarkerContext, getDescription, getDestroyOptions, getDestroyOrder, getDestroyVerb, getInspectClasspathResources, getInspectScript, getInspectTemplateClasspathResources, getModifyOptions, getModifyOrder, getModifyVerb, getNoopOptions, getNoopOrder, getNoopVerb, getPlanOperation, getPropertyOrContainerDefault, inspectContainer, isRestartRequired, isRestartRequiredForNoop, resolveExpression, resolveExpression, resolveExpression, setCreateOptions, setCreateOrder, setCreateVerb, setDeployedApplication, setDestroyOptions, setDestroyOrder, setDestroyVerb, setInspectClasspathResources, setInspectScript, setInspectTemplateClasspathResources, setModifyOptions, setModifyOrder, setModifyVerb, setNoopOptions, setNoopOrder, setNoopVerb, setPlanOperation, setRestartRequired, setRestartRequiredForNoop

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseDeployed

getContainer, getDeployable, setContainer, setDeployable

Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem

compareTo, equals, get$token, getId, getName, getProperty, getPropertyDescriptor, getSyntheticProperties, getSyntheticProperty, getType, hashCode, hasProperty, hasSyntheticProperty, putSyntheticProperties, putSyntheticProperty, set$token, setId, setProperty, setSyntheticProperties, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem

getId, getName, getProperty, getSyntheticProperties, getSyntheticProperty, getType, hasProperty, putSyntheticProperty, setId, setProperty

Constructor Detail

ExecutedFolder

public ExecutedFolder()

Method Detail

resolveExpression

public java.lang.String resolveExpression(java.lang.String expression)

Overrides:

resolveExpression in class AbstractDeployed<D extends Folder>

getDescription

public java.lang.String getDescription(java.lang.String script,
                              java.lang.String verb)

executeCreate

public void executeCreate(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx,
                 com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

executeModify

public void executeModify(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx,
                 com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

executeDestroy

public void executeDestroy(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx,
                  com.xebialabs.deployit.plugin.api.deployment.specification.Delta delta)

addSteps

protected static com.xebialabs.deployit.plugin.api.flow.Step addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx,
                                                   ExecutedFolder<?> deployed,
                                                   java.util.List<java.io.File> scriptsToRun,
                                                   java.lang.String scriptNameRegex,
                                                   java.util.Set<java.lang.String> stepOptions,
                                                   int order,
                                                   java.lang.String verb)

addSteps

@Deprecated
protected com.xebialabs.deployit.plugin.api.flow.Step addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext ctx,
                                                              ExecutedFolder<D> deployed,
                                                              java.util.List<java.io.File> scriptsToRun,
                                                              java.lang.String scriptNameRegex,
                                                              java.util.Set<java.lang.String> stepOptions)

Deprecated. Please use addSteps(com.xebialabs.deployit.plugin.api.deployment.planning.DeploymentPlanningContext, ExecutedFolder, java.util.List, String, java.util.Set, int, String)

This method contains a bug! It's still here just for backwards compatibility. It always sets create order and description with create verb to steps, regardless of step type.

newScriptExecutionStep

@Deprecated
protected static ScriptExecutionStep newScriptExecutionStep(java.lang.String script,
                                                    ExecutedFolder<?> deployed)

Deprecated. Please use newScriptExecutionStep(String, ExecutedFolder, int, String)

This method contains a bug! It's still here just for backwards compatibility. It always sets create order and description with create verb to steps, regardless of step type.

newScriptExecutionStep

protected static ScriptExecutionStep newScriptExecutionStep(java.lang.String script,
                                         ExecutedFolder<?> deployed,
                                         int order,
                                         java.lang.String verb)

extractScriptPrefix

protected java.lang.String extractScriptPrefix(java.util.regex.Pattern pattern,
                                   java.lang.String scriptName)

getDerivedArtifactAsFile

protected java.io.File getDerivedArtifactAsFile()

identifyAndOrderCreateScriptsInFolder

protected java.util.List<java.io.File> identifyAndOrderCreateScriptsInFolder(java.io.File folder)

findScriptsToRun

protected java.util.List<java.io.File> findScriptsToRun(java.io.File folder,
                                            java.lang.String pattern)

identifyAndOrderRollbackScriptsInFolder

protected java.util.List<java.io.File> identifyAndOrderRollbackScriptsInFolder(java.io.File folder)

compareAndIdentifyOrderedScriptsToRunForUpdate

protected java.util.List<java.io.File> compareAndIdentifyOrderedScriptsToRunForUpdate(java.io.File previousFolder,
                                                                          java.io.File currentFolder)

compareAndIdentifyOrderedRollbackScriptsToRunForUpdate

protected java.util.List<java.io.File> compareAndIdentifyOrderedRollbackScriptsToRunForUpdate(java.io.File previousFolder,
                                                                                  java.io.File currentFolder)

difference

protected java.util.Collection<java.io.File> difference(java.util.List<java.io.File> previousFiles,
                                            java.util.List<java.io.File> currentFiles,
                                            boolean compareContents)

transform

protected java.util.Set<com.xebialabs.deployit.plugin.generic.deployed.ExecutedFolder.FileNameAndContentsEqualityWrapper> transform(java.util.List<java.io.File> files,
                                                                                                                        boolean compareContents)

getScriptRecognitionRegex

public java.lang.String getScriptRecognitionRegex()

setScriptRecognitionRegex

public void setScriptRecognitionRegex(java.lang.String scriptRecognitionRegex)

getRollbackScriptRecognitionRegex

public java.lang.String getRollbackScriptRecognitionRegex()

setRollbackScriptRecognitionRegex

public void setRollbackScriptRecognitionRegex(java.lang.String rollbackScriptRecognitionRegex)

getRollbackScriptPostfix

public java.lang.String getRollbackScriptPostfix()

setRollbackScriptPostfix

public void setRollbackScriptPostfix(java.lang.String rollbackScriptPostfix)

isExecuteModifiedScripts

public boolean isExecuteModifiedScripts()

setExecuteModifiedScripts

public void setExecuteModifiedScripts(boolean executeModifiedScripts)

isExecuteRollbackForModifiedScripts

public boolean isExecuteRollbackForModifiedScripts()

setExecuteRollbackForModifiedScripts

public void setExecuteRollbackForModifiedScripts(boolean executeRollbackForModifiedScripts)

isCheckpointAfterFirstScript

public boolean isCheckpointAfterFirstScript()

setCheckpointAfterFirstScript

public void setCheckpointAfterFirstScript(boolean checkpointAfterFirstScript)

getCommonScriptFolderName

public java.lang.String getCommonScriptFolderName()

setCommonScriptFolderName

public void setCommonScriptFolderName(java.lang.String commonScriptFolderName)

getExecutorScript

public java.lang.String getExecutorScript()

setExecutorScript

public void setExecutorScript(java.lang.String executorScript)

getClasspathResources

public java.util.Set<java.lang.String> getClasspathResources()

setClasspathResources

public void setClasspathResources(java.util.Set<java.lang.String> classpathResources)

getTemplateClasspathResources

public java.util.Set<java.lang.String> getTemplateClasspathResources()

setTemplateClasspathResources

public void setTemplateClasspathResources(java.util.Set<java.lang.String> templateClasspathResources)

getSourceArtifact

public D getSourceArtifact()

Specified by:

getSourceArtifact in interface com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact<D extends Folder>

getPlaceholders

public java.util.Map<java.lang.String,java.lang.String> getPlaceholders()

Specified by:

getPlaceholders in interface com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact<D extends Folder>

setPlaceholders

public void setPlaceholders(java.util.Map<java.lang.String,java.lang.String> placeholders)

Specified by:

setPlaceholders in interface com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact<D extends Folder>

getFile

public com.xebialabs.overthere.OverthereFile getFile()

Specified by:

getFile in interface com.xebialabs.deployit.plugin.api.udm.artifact.Artifact

setFile

public void setFile(com.xebialabs.overthere.OverthereFile file)

Specified by:

setFile in interface com.xebialabs.deployit.plugin.api.udm.artifact.Artifact