com.xebialabs.deployit.plugin.generic.step

Class BaseExecutionStep

java.lang.Object

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

com.xebialabs.deployit.plugin.generic.step.BaseExecutionStep

All Implemented Interfaces:

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

Direct Known Subclasses:

InspectScriptExecutionStep, ScriptExecutionStep

public abstract class BaseExecutionStep
extends BaseStep
implements com.xebialabs.deployit.plugin.api.flow.PreviewStep, 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
BaseExecutionStep(java.lang.String scriptPath, com.xebialabs.deployit.plugin.overthere.HostContainer container, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String description)

Method Summary

Methods

Modifier and Type	Method and Description
ArtifactUploader	createArtifactUploader()
com.xebialabs.deployit.plugin.api.flow.StepExitCode	doExecute()
protected com.xebialabs.deployit.plugin.api.flow.StepExitCode	executeScript(com.xebialabs.overthere.OverthereFile executable)
java.io.File	getArtifact()
java.util.List<java.lang.String>	getClasspathResources()
java.util.List<java.io.File>	getFileResources()
com.xebialabs.deployit.plugin.api.flow.Preview	getPreview()
java.lang.String	getScriptPath()
java.lang.String	getScriptTemplatePath()
java.util.List<java.lang.String>	getTemplateClasspathResources()
java.lang.String	getUploadedArtifactPath()
java.util.Map<java.lang.String,java.lang.Object>	getVars()
void	requestStaging(com.xebialabs.deployit.plugin.api.flow.StagingContext ctx)
protected java.lang.String	resolveOsSpecificFileName(java.lang.String template)
static java.lang.String	resolveOsSpecificFileName(java.lang.String template, com.xebialabs.deployit.plugin.overthere.HostContainer hostContainer)
void	setArtifact(java.io.File artifact)
void	setClasspathResources(java.util.List<java.lang.String> classpathResources)
void	setDerivedArtifact(com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact da)
void	setFileResources(java.util.List<java.io.File> fileResources)
void	setTemplateClasspathResources(java.util.List<java.lang.String> templateClasspathResources)
protected void	setWorkingDirectory()
protected com.xebialabs.overthere.OverthereFile	uploadArtifactIfPresent()
protected void	uploadClasspathResources()
protected void	uploadFileOrDirectory(com.xebialabs.overthere.OverthereFile remoteDir, de.schlichtherle.truezip.file.TFile file, boolean logFileNameToConsole)
protected void	uploadFileResources()
protected com.xebialabs.overthere.OverthereFile	uploadScriptToExecute(java.lang.String scriptTemplatePath)
protected void	uploadTemplateClasspathResources()

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

classpathResourceExists, createOrReplaceHostFile, disconnect, evaluateTemplate, evaluateTemplate, evaluateTemplate, getContainer, getCtx, getDescription, 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, getDescription, getOrder

Constructor Detail

BaseExecutionStep

public BaseExecutionStep(java.lang.String scriptPath,
                 com.xebialabs.deployit.plugin.overthere.HostContainer container,
                 java.util.Map<java.lang.String,java.lang.Object> vars,
                 java.lang.String description)

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

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

Specified by:

doExecute in class BaseStep

Throws:

java.lang.Exception

getPreview

public com.xebialabs.deployit.plugin.api.flow.Preview getPreview()

Specified by:

getPreview in interface com.xebialabs.deployit.plugin.api.flow.PreviewStep

uploadArtifactIfPresent

protected com.xebialabs.overthere.OverthereFile uploadArtifactIfPresent()

uploadFileResources

protected void uploadFileResources()

uploadClasspathResources

protected void uploadClasspathResources()

uploadFileOrDirectory

protected void uploadFileOrDirectory(com.xebialabs.overthere.OverthereFile remoteDir,
                         de.schlichtherle.truezip.file.TFile file,
                         boolean logFileNameToConsole)
                              throws java.io.IOException

Throws:

java.io.IOException

uploadTemplateClasspathResources

protected void uploadTemplateClasspathResources()

uploadScriptToExecute

protected com.xebialabs.overthere.OverthereFile uploadScriptToExecute(java.lang.String scriptTemplatePath)

setWorkingDirectory

protected void setWorkingDirectory()

executeScript

protected com.xebialabs.deployit.plugin.api.flow.StepExitCode executeScript(com.xebialabs.overthere.OverthereFile executable)

getScriptPath

public java.lang.String getScriptPath()

getFileResources

public java.util.List<java.io.File> getFileResources()

setFileResources

public void setFileResources(java.util.List<java.io.File> fileResources)

getClasspathResources

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

setClasspathResources

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

getTemplateClasspathResources

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

setTemplateClasspathResources

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

getArtifact

public java.io.File getArtifact()

setArtifact

public void setArtifact(java.io.File artifact)

setDerivedArtifact

public void setDerivedArtifact(com.xebialabs.deployit.plugin.api.udm.artifact.DerivedArtifact da)

getUploadedArtifactPath

public java.lang.String getUploadedArtifactPath()

resolveOsSpecificFileName

protected java.lang.String resolveOsSpecificFileName(java.lang.String template)

resolveOsSpecificFileName

public static java.lang.String resolveOsSpecificFileName(java.lang.String template,
                                         com.xebialabs.deployit.plugin.overthere.HostContainer hostContainer)

createArtifactUploader

public ArtifactUploader createArtifactUploader()

Overrides:

createArtifactUploader in class BaseStep

getScriptTemplatePath

public java.lang.String getScriptTemplatePath()

getVars

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