com.xebialabs.deployit.plugin.tomcat.deployed

Class ContextWarModule

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.AbstractDeployedArtifact<D>

com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

com.xebialabs.deployit.plugin.tomcat.deployed.ContextWarModule

All Implemented Interfaces:

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

@Metadata(virtual=true,
          description="War Module that has an associated context.xml")
public class ContextWarModule
extends com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

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
ContextWarModule()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.xebialabs.deployit.plugin.generic.step.ArtifactDeleteStep	createArtifactDeleteStep()
protected com.xebialabs.deployit.plugin.generic.step.TemplateArtifactCopyStep	createTemplateArtifactCopyStep(int order, java.lang.String verb)
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)
java.lang.String	getContextDescription(java.lang.String verb)
java.lang.String	getContextRoot()
java.lang.String	getContextSubject()
java.lang.String	getContextTemplate()
java.lang.String	getContextXmlTargetDirectory()
int	getCreateOrderOfContextXml()
java.util.Set<java.lang.String>	getDeleteGeneratedResources()
int	getDestroyOrderOfContextXml()
int	getModifyOrderOfContextXml()
boolean	isDestroyOperation()
boolean	isManageContextXml()
boolean	isRemoveContextXml()
java.lang.String	resolveContextFile(java.lang.String fileSeparator)
void	setContextRoot(java.lang.String contextRoot)
void	setContextSubject(java.lang.String contextSubject)
void	setContextTemplate(java.lang.String contextTemplate)
void	setContextXmlTargetDirectory(java.lang.String contextXmlTargetDirectory)
void	setCreateOrderOfContextXml(int createOrderOfContextXml)
void	setDeleteGeneratedResources(java.util.Set<java.lang.String> deleteGeneratedResources)
void	setDestroyOrderOfContextXml(int destroyOrderOfContextXml)
void	setManageContextXml(boolean manageContextXml)
void	setModifyOrderOfContextXml(int modifyOrderOfContextXml)
void	setRemoveContextXml(boolean removeContextXml)

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

createArtifactCopyStep, getFile, getPlaceholders, getSourceArtifact, isPreserveExistingFiles, isTargetPathSharedSubDirectories, setFile, setPlaceholders, setPreserveExistingFiles, setTargetPathSharedSubDirectories, setUseDescriptionGeneratedByStep

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

getTargetDirectory, getTargetFile, isCreateTargetDirectory, isTargetDirectoryShared, resolveTargetFileName, setCreateTargetDirectory, setTargetDirectory, setTargetDirectoryShared, setTargetFile

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, 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

ContextWarModule

public ContextWarModule()

Method Detail

executeModify

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

Overrides:

executeModify in class com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

executeCreate

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

Overrides:

executeCreate in class com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

executeDestroy

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

Overrides:

executeDestroy in class com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

createTemplateArtifactCopyStep

protected com.xebialabs.deployit.plugin.generic.step.TemplateArtifactCopyStep createTemplateArtifactCopyStep(int order,
                                                                                                 java.lang.String verb)

createArtifactDeleteStep

protected com.xebialabs.deployit.plugin.generic.step.ArtifactDeleteStep createArtifactDeleteStep()

Overrides:

createArtifactDeleteStep in class com.xebialabs.deployit.plugin.generic.deployed.CopiedArtifact<com.xebialabs.deployit.plugin.jee.artifact.War>

resolveContextFile

public java.lang.String resolveContextFile(java.lang.String fileSeparator)

getContextDescription

public java.lang.String getContextDescription(java.lang.String verb)

getContextRoot

public java.lang.String getContextRoot()

setContextRoot

public void setContextRoot(java.lang.String contextRoot)

getContextTemplate

public java.lang.String getContextTemplate()

setContextTemplate

public void setContextTemplate(java.lang.String contextTemplate)

getCreateOrderOfContextXml

public int getCreateOrderOfContextXml()

setCreateOrderOfContextXml

public void setCreateOrderOfContextXml(int createOrderOfContextXml)

getContextXmlTargetDirectory

public java.lang.String getContextXmlTargetDirectory()

setContextXmlTargetDirectory

public void setContextXmlTargetDirectory(java.lang.String contextXmlTargetDirectory)

isRemoveContextXml

public boolean isRemoveContextXml()

setRemoveContextXml

public void setRemoveContextXml(boolean removeContextXml)

getDeleteGeneratedResources

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

setDeleteGeneratedResources

public void setDeleteGeneratedResources(java.util.Set<java.lang.String> deleteGeneratedResources)

getModifyOrderOfContextXml

public int getModifyOrderOfContextXml()

setModifyOrderOfContextXml

public void setModifyOrderOfContextXml(int modifyOrderOfContextXml)

getDestroyOrderOfContextXml

public int getDestroyOrderOfContextXml()

setDestroyOrderOfContextXml

public void setDestroyOrderOfContextXml(int destroyOrderOfContextXml)

isDestroyOperation

public boolean isDestroyOperation()

getContextSubject

public java.lang.String getContextSubject()

setContextSubject

public void setContextSubject(java.lang.String contextSubject)

isManageContextXml

public boolean isManageContextXml()

setManageContextXml

public void setManageContextXml(boolean manageContextXml)