com.xebialabs.deployit.plugin.generic.step

Class InstructionStep

java.lang.Object

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

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

@StepMetadata(name="manual")
public class InstructionStep
extends java.lang.Object
implements com.xebialabs.deployit.plugin.api.flow.Step, com.xebialabs.deployit.plugin.api.flow.PreviewStep, com.xebialabs.xlplatform.satellite.SatelliteAware

See Also:

Serialized Form

Field Summary

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

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
InstructionStep()
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

Methods

Modifier and Type	Method and Description
protected void	checkMailProperties()
protected void	doPostConstruct(com.xebialabs.deployit.plugin.api.rules.StepPostConstructContext ctx)
com.xebialabs.deployit.plugin.api.flow.StepExitCode	execute(com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx)
java.lang.String	getDescription()
java.lang.String	getFromAddress()
SmtpServer	getMailServer()
int	getOrder()
com.xebialabs.deployit.plugin.api.flow.Preview	getPreview()
com.xebialabs.xlplatform.satellite.Satellite	getSatellite()
java.lang.String	getSubject()
java.util.List<java.lang.String>	getToAddresses()
protected void	mailInstructions(java.lang.String instructions, com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx)
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 java.lang.Object

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

Constructor Detail

InstructionStep

public InstructionStep()

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

doPostConstruct

@RulePostConstruct
protected void doPostConstruct(com.xebialabs.deployit.plugin.api.rules.StepPostConstructContext ctx)

checkMailProperties

protected void checkMailProperties()

getOrder

public int getOrder()

Specified by:

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

getDescription

public java.lang.String getDescription()

Specified by:

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

execute

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

Specified by:

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

Throws:

java.lang.Exception

mailInstructions

protected void mailInstructions(java.lang.String instructions,
                    com.xebialabs.deployit.plugin.api.flow.ExecutionContext ctx)

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

getPreview

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

Specified by:

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

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)

getSatellite

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

Specified by:

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