com.xebialabs.deployit.plugin.generic.step

Class ArtifactCopyStep

java.lang.Object

com.xebialabs.deployit.plugin.generic.step.BaseStep

com.xebialabs.deployit.plugin.generic.step.BaseDeploymentStep

com.xebialabs.deployit.plugin.generic.step.ArtifactCopyStep

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.flow.StageableStep, com.xebialabs.deployit.plugin.api.flow.Step, java.io.Serializable

Direct Known Subclasses:

TemplateArtifactCopyStep

public class ArtifactCopyStep
extends BaseDeploymentStep
implements com.xebialabs.deployit.plugin.api.flow.StageableStep

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.generic.step.BaseStep

container, ctx, FREEMARKER_FILE_EXT, logger, remoteConn

Fields inherited from interface com.xebialabs.deployit.plugin.api.flow.Step

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
ArtifactCopyStep(CopiedArtifact<? extends com.xebialabs.deployit.plugin.api.udm.DeployableArtifact> copiedArtifact)
ArtifactCopyStep(int order, com.xebialabs.overthere.OverthereFile sourceFile, com.xebialabs.deployit.plugin.overthere.HostContainer container, java.lang.String targetPath)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.xebialabs.deployit.plugin.api.flow.StepExitCode	doExecute()
java.lang.String	getDescription()
com.xebialabs.deployit.plugin.api.udm.artifact.Artifact	getSourceArtifact()
java.lang.String	getSourceFileDescription()
java.lang.String	getTargetFileName()
boolean	isCreateTargetPath()
boolean	isPreserveExistingFiles()
void	requestStaging(com.xebialabs.deployit.plugin.api.flow.StagingContext ctx)
protected com.xebialabs.overthere.OverthereFile	resolveSourceFile()
void	setCreateTargetPath(boolean createTargetPath)
void	setDescription(java.lang.String description)
void	setPreserveExistingFiles(boolean preserveExistingFiles)
void	setSourceArtifact(com.xebialabs.deployit.plugin.api.udm.artifact.Artifact sourceArtifact)
void	setSourceFileDescription(java.lang.String sourceFileDescription)
void	setTargetFileName(java.lang.String targetFileName)

Methods inherited from class com.xebialabs.deployit.plugin.generic.step.BaseDeploymentStep

execute, getOrder

Methods inherited from class com.xebialabs.deployit.plugin.generic.step.BaseStep

classpathResourceExists, createArtifactUploader, createOrReplaceHostFile, disconnect, evaluateTemplate, evaluateTemplate, evaluateTemplate, evaluateTemplate, getArtifactUploader, getContainer, getCtx, getHostFileSeparator, getHostLineSeparator, getLocalConnection, getRemoteConnection, getRemoteWorkingDirectory, getRemoteWorkingDirPath, handleExecute, hostFileExists, isRetainRemoteWorkingDirOnCompletion, readHostFile, readHostFileLines, readHostXmlFileAsModel, resolveOsSpecificTemplate, setRemoteWorkingDirPath, setRetainRemoteWorkingDirOnCompletion, substringAfterLast, substringAfterLast, uploadToWorkingDirectory, uploadToWorkingDirectory, uploadToWorkingDirectory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xebialabs.deployit.plugin.api.flow.Step

execute, getOrder

Constructor Detail

ArtifactCopyStep

public ArtifactCopyStep(int order,
                com.xebialabs.overthere.OverthereFile sourceFile,
                com.xebialabs.deployit.plugin.overthere.HostContainer container,
                java.lang.String targetPath)

ArtifactCopyStep

public ArtifactCopyStep(CopiedArtifact<? extends com.xebialabs.deployit.plugin.api.udm.DeployableArtifact> copiedArtifact)

Method Detail

requestStaging

public void requestStaging(com.xebialabs.deployit.plugin.api.flow.StagingContext ctx)

Specified by:

requestStaging in interface com.xebialabs.deployit.plugin.api.flow.StageableStep

doExecute

protected com.xebialabs.deployit.plugin.api.flow.StepExitCode doExecute()
                                                                 throws java.lang.Exception

Specified by:

doExecute in class BaseStep

Throws:

java.lang.Exception

resolveSourceFile

protected com.xebialabs.overthere.OverthereFile resolveSourceFile()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface com.xebialabs.deployit.plugin.api.flow.Step

Overrides:

getDescription in class BaseStep

getSourceFileDescription

public java.lang.String getSourceFileDescription()

setSourceFileDescription

public void setSourceFileDescription(java.lang.String sourceFileDescription)

getSourceArtifact

public com.xebialabs.deployit.plugin.api.udm.artifact.Artifact getSourceArtifact()

setSourceArtifact

public void setSourceArtifact(com.xebialabs.deployit.plugin.api.udm.artifact.Artifact sourceArtifact)

isCreateTargetPath

public boolean isCreateTargetPath()

setCreateTargetPath

public void setCreateTargetPath(boolean createTargetPath)

getTargetFileName

public java.lang.String getTargetFileName()

setTargetFileName

public void setTargetFileName(java.lang.String targetFileName)

isPreserveExistingFiles

public boolean isPreserveExistingFiles()

setPreserveExistingFiles

public void setPreserveExistingFiles(boolean preserveExistingFiles)

setDescription

public void setDescription(java.lang.String description)