com.xebialabs.deployit.plugin.generic.step
Class InstructionStep

java.lang.Object
  com.xebialabs.deployit.plugin.generic.step.BaseStep
      com.xebialabs.deployit.plugin.generic.step.BaseDeploymentStep
          com.xebialabs.deployit.plugin.generic.step.InstructionStep

All Implemented Interfaces:

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

public class InstructionStep
extends BaseDeploymentStep

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

InstructionStep(int order, java.lang.String description, com.xebialabs.deployit.plugin.overthere.HostContainer container, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String templatePath)

Method Summary

protected com.xebialabs.deployit.plugin.api.flow.StepExitCode	doExecute()
java.lang.String	getFromAddress()
SmtpServer	getMailServer()
java.lang.String	getSubject()
java.util.List<java.lang.String>	getToAddresses()
protected void	mailInstructions(java.lang.String instructions)
protected java.lang.String	renderEmailTemplate(java.lang.String template, java.util.Map<java.lang.String,java.lang.Object> vars)
void	setFromAddress(java.lang.String fromAddress)
void	setMailServer(SmtpServer mailServer)
void	setSubject(java.lang.String subject)
void	setToAddresses(java.util.List<java.lang.String> toAddresses)

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

Constructor Detail

InstructionStep

public InstructionStep(int order,
                       java.lang.String description,
                       com.xebialabs.deployit.plugin.overthere.HostContainer container,
                       java.util.Map<java.lang.String,java.lang.Object> vars,
                       java.lang.String templatePath)

Method Detail

doExecute

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

Specified by:

doExecute in class BaseStep

Throws:

java.lang.Exception

mailInstructions

protected void mailInstructions(java.lang.String instructions)

renderEmailTemplate

protected java.lang.String renderEmailTemplate(java.lang.String template,
                                               java.util.Map<java.lang.String,java.lang.Object> vars)
                                        throws java.io.IOException,
                                               freemarker.template.TemplateException

Throws:

java.io.IOException

freemarker.template.TemplateException

getToAddresses

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

setToAddresses

public void setToAddresses(java.util.List<java.lang.String> toAddresses)

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

getFromAddress

public java.lang.String getFromAddress()

setFromAddress

public void setFromAddress(java.lang.String fromAddress)

getMailServer

public SmtpServer getMailServer()

setMailServer

public void setMailServer(SmtpServer mailServer)