com.vectorcast.plugins.vectorcastexecution

Class VectorCASTSetup

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.vectorcast.plugins.vectorcastexecution.VectorCASTSetup

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class VectorCASTSetup
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

VectorCAST setup build action

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorCASTSetup.DescriptorImpl Descriptor for VectorCASTSetup.

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

VectorCASTSetup(String environmentSetupWin, String environmentSetupUnix, String executePreambleWin, String executePreambleUnix, String environmentTeardownWin, String environmentTeardownUnix, boolean optionUseReporting, String optionErrorLevel, String optionHtmlBuildDesc, boolean optionExecutionReport, boolean optionClean, Long waitLoops, Long waitTime, String manageProjectName, String jobName, String nodeLabel) Create setup step

Method Summary

Modifier and Type	Method and Description
VectorCASTSetup.DescriptorImpl	getDescriptor()
String	getEnvironmentSetupUnix() Get environment setup for unix
String	getEnvironmentSetupWin() Get environment for windows setup
String	getEnvironmentTeardownUnix() Get environment teardown for unix
String	getEnvironmentTeardownWin() Get environment teardown for windows
String	getExecutePreambleUnix() Get execute preamble for unix
String	getExecutePreambleWin() Get execute preamble for windows
String	getJobName() Get the job name
String	getManageProjectName() Get the Manage project file/name
String	getNodeLabel() Get the node label
boolean	getOptionClean() Get option for cleaning workspace
String	getOptionErrorLevel() Get option error level
boolean	getOptionExecutionReport() Get option for execution report
String	getOptionHtmlBuildDesc() Get option for HTML Build Description
boolean	getOptionUseReporting() Get option to use reporting
hudson.scm.SCM	getSCM() Get the SCM to use
boolean	getUsingSCM() Get using SCM
Long	getWaitLoops() Get the number of wait loops to do
Long	getWaitTime() Get the wait time for license retries
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Perform the build step.
void	setEnvironmentSetupUnix(String environmentSetupUnix) Set environment setup for unix
void	setEnvironmentSetupWin(String environmentSetupWin) Set environment setup for windows
void	setEnvironmentTeardownUnix(String environmentTeardownUnix) Set environment teardown for unix
void	setEnvironmentTeardownWin(String environmentTeardownWin) Set environment teardown for windows
void	setExecutePreambleUnix(String executePreambleUnix) Set execute preamble for unix
void	setExecutePreambleWin(String executePreambleWin) Set execute preamble for windows
void	setJobName(String jobName) Set the job name
void	setManageProjectName(String manageProjectName) Set the Manage project file/name
void	setNodeLabel(String nodeLabel) Set the node label
void	setOptionClean(boolean optionClean) Set option for cleaning workspace
void	setOptionErrorLevel(String optionErrorLevel) Set option error level
void	setOptionExecutionReport(boolean optionExecutionReport) Set option for execution report
void	setOptionHtmlBuildDesc(String optionHtmlBuildDesc) Set option for HTML build description *
void	setOptionUseReporting(boolean optionUseReporting) Set option to use reporting
void	setSCM(hudson.scm.SCM scm) Set the SCM being used
void	setUsingSCM(boolean usingSCM) Set using SCM (true yes, false no)
void	setWaitLoops(Long waitLoops) Set the number of wait loops
void	setWaitTime(Long waitTime) Set the wait time for license retries

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

VectorCASTSetup

@DataBoundConstructor
public VectorCASTSetup(String environmentSetupWin,
                                              String environmentSetupUnix,
                                              String executePreambleWin,
                                              String executePreambleUnix,
                                              String environmentTeardownWin,
                                              String environmentTeardownUnix,
                                              boolean optionUseReporting,
                                              String optionErrorLevel,
                                              String optionHtmlBuildDesc,
                                              boolean optionExecutionReport,
                                              boolean optionClean,
                                              Long waitLoops,
                                              Long waitTime,
                                              String manageProjectName,
                                              String jobName,
                                              String nodeLabel)

Create setup step

Parameters:

environmentSetupWin - environment setup for windows

environmentSetupUnix - environment setup for unix

executePreambleWin - execute preamble for windows

executePreambleUnix - execute preamble for unix

environmentTeardownWin - environment teardown for windows

environmentTeardownUnix - environment teardown for unix

optionUseReporting - use reporting

optionErrorLevel - error level

optionHtmlBuildDesc - HTML Build description

optionExecutionReport - execution report

optionClean - clean

waitLoops - wait loops

waitTime - wait time

manageProjectName - manage project name

jobName - job name

nodeLabel - node label

Method Detail

getWaitLoops

public Long getWaitLoops()

Get the number of wait loops to do

Returns:

number of loops

setWaitLoops

public void setWaitLoops(Long waitLoops)

Set the number of wait loops

Parameters:

waitLoops - number of loops

getWaitTime

public Long getWaitTime()

Get the wait time for license retries

Returns:

the wait time

setWaitTime

public void setWaitTime(Long waitTime)

Set the wait time for license retries

Parameters:

waitTime - the wait time

getEnvironmentSetupWin

public String getEnvironmentSetupWin()

Get environment for windows setup

Returns:

environment setup

setEnvironmentSetupWin

public void setEnvironmentSetupWin(String environmentSetupWin)

Set environment setup for windows

Parameters:

environmentSetupWin - environment setup

getEnvironmentSetupUnix

public String getEnvironmentSetupUnix()

Get environment setup for unix

Returns:

environment setup

setEnvironmentSetupUnix

public void setEnvironmentSetupUnix(String environmentSetupUnix)

Set environment setup for unix

Parameters:

environmentSetupUnix - environment setup

getExecutePreambleWin

public String getExecutePreambleWin()

Get execute preamble for windows

Returns:

execute preamble

setExecutePreambleWin

public void setExecutePreambleWin(String executePreambleWin)

Set execute preamble for windows

Parameters:

executePreambleWin - execute preamble

getExecutePreambleUnix

public String getExecutePreambleUnix()

Get execute preamble for unix

Returns:

execute preamble

setExecutePreambleUnix

public void setExecutePreambleUnix(String executePreambleUnix)

Set execute preamble for unix

Parameters:

executePreambleUnix - execute preamble

getEnvironmentTeardownWin

public String getEnvironmentTeardownWin()

Get environment teardown for windows

Returns:

environment teardown

setEnvironmentTeardownWin

public void setEnvironmentTeardownWin(String environmentTeardownWin)

Set environment teardown for windows

Parameters:

environmentTeardownWin - environment teardown

getEnvironmentTeardownUnix

public String getEnvironmentTeardownUnix()

Get environment teardown for unix

Returns:

environment teardown

setEnvironmentTeardownUnix

public void setEnvironmentTeardownUnix(String environmentTeardownUnix)

Set environment teardown for unix

Parameters:

environmentTeardownUnix - environment teardown

getOptionUseReporting

public boolean getOptionUseReporting()

Get option to use reporting

Returns:

true/false

setOptionUseReporting

public void setOptionUseReporting(boolean optionUseReporting)

Set option to use reporting

Parameters:

optionUseReporting - true/false

getOptionErrorLevel

public String getOptionErrorLevel()

Get option error level

Returns:

error level

setOptionErrorLevel

public void setOptionErrorLevel(String optionErrorLevel)

Set option error level

Parameters:

optionErrorLevel - error level

getOptionHtmlBuildDesc

public String getOptionHtmlBuildDesc()

Get option for HTML Build Description

Returns:

"HTML" or "TEXT"

setOptionHtmlBuildDesc

public void setOptionHtmlBuildDesc(String optionHtmlBuildDesc)

Set option for HTML build description *

Parameters:

optionHtmlBuildDesc - HTML or TEXT

getOptionExecutionReport

public boolean getOptionExecutionReport()

Get option for execution report

Returns:

true/false

setOptionExecutionReport

public void setOptionExecutionReport(boolean optionExecutionReport)

Set option for execution report

Parameters:

optionExecutionReport - true/false

getOptionClean

public boolean getOptionClean()

Get option for cleaning workspace

Returns:

true/false

setOptionClean

public void setOptionClean(boolean optionClean)

Set option for cleaning workspace

Parameters:

optionClean - true/false

getUsingSCM

public boolean getUsingSCM()

Get using SCM

Returns:

true/false

setUsingSCM

public void setUsingSCM(boolean usingSCM)

Set using SCM (true yes, false no)

Parameters:

usingSCM - true/false

getSCM

public hudson.scm.SCM getSCM()

Get the SCM to use

Returns:

SCM

setSCM

public void setSCM(hudson.scm.SCM scm)

Set the SCM being used

Parameters:

scm - SCM

getManageProjectName

public String getManageProjectName()

Get the Manage project file/name

Returns:

Manage project name

setManageProjectName

public void setManageProjectName(String manageProjectName)

Set the Manage project file/name

Parameters:

manageProjectName - Manage project name

getJobName

public String getJobName()

Get the job name

Returns:

job name

setJobName

public void setJobName(String jobName)

Set the job name

Parameters:

jobName - job name

getNodeLabel

public String getNodeLabel()

Get the node label

Returns:

node label

setNodeLabel

public void setNodeLabel(String nodeLabel)

Set the node label

Parameters:

nodeLabel - node label

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)

Perform the build step. Copy the scripts from the archive/directory to the workspace

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Parameters:

build - build

workspace - workspace

launcher - launcher

listener - listener

getDescriptor

public VectorCASTSetup.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder