com.xebialabs.deployit.plugin.jbossdm.step

Class BaseStep

java.lang.Object

com.xebialabs.deployit.plugin.jbossdm.step.BaseStep

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.flow.PreviewStep, com.xebialabs.deployit.plugin.api.flow.Step, com.xebialabs.xlplatform.satellite.SatelliteAware, java.io.Serializable

Direct Known Subclasses:

CliDeploymentStep, CliInspectionStep, CliStageableStep

public abstract class BaseStep
extends java.lang.Object
implements com.xebialabs.deployit.plugin.api.flow.PreviewStep, com.xebialabs.xlplatform.satellite.SatelliteAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JYTHON_SCRIPT_ENGINE

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

DEFAULT_ORDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseStep(java.lang.String script, int order, java.util.Map<java.lang.String,java.lang.Object> pythonContext, java.lang.String description, CliManagedContainer container)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.script.Bindings	createBindings(java.util.Map<java.lang.String,java.lang.Object> variables)
protected void	disconnect()
java.lang.Object	executeCliCommand(java.lang.String cmd)
java.util.List<java.lang.Object>	executeCliCommands(java.lang.String[] cmds)
protected void	executeScript(javax.script.ScriptEngine scriptEngine)
protected java.util.List<java.lang.String>	getAdditionalLibraries()
CliManagedContainer	getContainer()
com.xebialabs.deployit.plugin.api.flow.ExecutionContext	getCtx()
java.lang.String	getDescription()
com.xebialabs.overthere.OverthereConnection	getLocalConnection()
int	getOrder()
com.xebialabs.deployit.plugin.api.flow.Preview	getPreview()
com.xebialabs.overthere.OverthereConnection	getRemoteConnection()
com.xebialabs.overthere.OverthereFile	getRemoteWorkingDirectory()
java.lang.String	getRemoteWorkingDirPath()
com.xebialabs.xlplatform.satellite.Satellite	getSatellite()
com.xebialabs.deployit.plugin.api.flow.StepExitCode	handleExecute(com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx)
boolean	hostFileExists(java.lang.String remoteFile)
boolean	isRetainRemoteWorkingDirOnCompletion()
protected void	loadLibraryScripts(java.util.List<java.lang.String> libs, javax.script.ScriptEngine scriptEngine)
protected void	loadLibraryScriptsAndEval(java.lang.String scriptPath, javax.script.ScriptEngine scriptEngine, javax.script.Bindings localBindings)
protected javax.script.ScriptEngine	loadScriptEngine()
protected abstract org.slf4j.Logger	logger()
java.lang.String	readHostFile(java.lang.String remoteFile)
java.lang.String[]	readHostFileLines(java.lang.String remoteFile)
void	setAdditionalLibraries(java.util.List<java.lang.String> additionalLibraries)
void	setRemoteWorkingDirPath(java.lang.String remoteWorkingDirPath)
void	setRetainRemoteWorkingDirOnCompletion(boolean deleteWorkingDirOnCompletion)
protected void	throwCliScriptException(java.lang.String scriptName, javax.script.ScriptException e)
com.xebialabs.overthere.OverthereFile	uploadToWorkingDirectory(java.io.File content, java.lang.String fileName)
com.xebialabs.overthere.OverthereFile	uploadToWorkingDirectory(com.xebialabs.overthere.OverthereFile content, java.lang.String fileName)
com.xebialabs.overthere.OverthereFile	uploadToWorkingDirectory(java.lang.String content, java.lang.String fileName)
com.xebialabs.overthere.OverthereFile	uploadToWorkingDirectory(java.net.URL content, java.lang.String fileName)

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

Field Detail

JYTHON_SCRIPT_ENGINE

public static final java.lang.String JYTHON_SCRIPT_ENGINE

See Also:

Constant Field Values

Constructor Detail

BaseStep

protected BaseStep(java.lang.String script,
        int order,
        java.util.Map<java.lang.String,java.lang.Object> pythonContext,
        java.lang.String description,
        CliManagedContainer container)

Method Detail

logger

protected abstract org.slf4j.Logger logger()

getOrder

public int getOrder()

Specified by:

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

getPreview

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

Specified by:

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

getDescription

public java.lang.String getDescription()

Specified by:

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

handleExecute

public com.xebialabs.deployit.plugin.api.flow.StepExitCode handleExecute(com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

executeScript

protected void executeScript(javax.script.ScriptEngine scriptEngine)
                      throws java.io.IOException

Throws:

java.io.IOException

loadLibraryScriptsAndEval

protected void loadLibraryScriptsAndEval(java.lang.String scriptPath,
                             javax.script.ScriptEngine scriptEngine,
                             javax.script.Bindings localBindings)
                                  throws java.io.IOException

Throws:

java.io.IOException

loadScriptEngine

protected javax.script.ScriptEngine loadScriptEngine()
                                              throws java.io.IOException

Throws:

java.io.IOException

loadLibraryScripts

protected void loadLibraryScripts(java.util.List<java.lang.String> libs,
                      javax.script.ScriptEngine scriptEngine)
                           throws java.io.IOException

Throws:

java.io.IOException

throwCliScriptException

protected void throwCliScriptException(java.lang.String scriptName,
                           javax.script.ScriptException e)

createBindings

protected javax.script.Bindings createBindings(java.util.Map<java.lang.String,java.lang.Object> variables)

executeCliCommand

public java.lang.Object executeCliCommand(java.lang.String cmd)

executeCliCommands

public java.util.List<java.lang.Object> executeCliCommands(java.lang.String[] cmds)

getCtx

public com.xebialabs.deployit.plugin.api.flow.ExecutionContext getCtx()

setAdditionalLibraries

public void setAdditionalLibraries(java.util.List<java.lang.String> additionalLibraries)

getAdditionalLibraries

protected java.util.List<java.lang.String> getAdditionalLibraries()

getContainer

public CliManagedContainer getContainer()

getRemoteWorkingDirectory

public com.xebialabs.overthere.OverthereFile getRemoteWorkingDirectory()

getLocalConnection

public com.xebialabs.overthere.OverthereConnection getLocalConnection()

getRemoteConnection

public com.xebialabs.overthere.OverthereConnection getRemoteConnection()

disconnect

protected void disconnect()

getRemoteWorkingDirPath

public java.lang.String getRemoteWorkingDirPath()

setRemoteWorkingDirPath

public void setRemoteWorkingDirPath(java.lang.String remoteWorkingDirPath)

isRetainRemoteWorkingDirOnCompletion

public boolean isRetainRemoteWorkingDirOnCompletion()

setRetainRemoteWorkingDirOnCompletion

public void setRetainRemoteWorkingDirOnCompletion(boolean deleteWorkingDirOnCompletion)

uploadToWorkingDirectory

public com.xebialabs.overthere.OverthereFile uploadToWorkingDirectory(java.lang.String content,
                                                             java.lang.String fileName)

uploadToWorkingDirectory

public com.xebialabs.overthere.OverthereFile uploadToWorkingDirectory(java.io.File content,
                                                             java.lang.String fileName)

uploadToWorkingDirectory

public com.xebialabs.overthere.OverthereFile uploadToWorkingDirectory(com.xebialabs.overthere.OverthereFile content,
                                                             java.lang.String fileName)

uploadToWorkingDirectory

public com.xebialabs.overthere.OverthereFile uploadToWorkingDirectory(java.net.URL content,
                                                             java.lang.String fileName)

hostFileExists

public boolean hostFileExists(java.lang.String remoteFile)

readHostFile

public java.lang.String readHostFile(java.lang.String remoteFile)

readHostFileLines

public java.lang.String[] readHostFileLines(java.lang.String remoteFile)

getSatellite

public com.xebialabs.xlplatform.satellite.Satellite getSatellite()

Specified by:

getSatellite in interface com.xebialabs.xlplatform.satellite.SatelliteAware