public class TEDExecutionBuilder extends Builder implements SimpleBuildStep
Builder
.
When the user configures the project and enables this builder,
Descriptor.newInstance(StaplerRequest)
is invoked and a new
TEDExecutionRunner
is created. The created instance is persisted to the
project configuration XML by using XStream, so this allows you to use
instance fields to remember remember the configuration.
When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener)
method will be invoked.
Modifier and Type | Class and Description |
---|---|
static class |
TEDExecutionBuilder.DescriptorImpl |
SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory
BuildStep.PublisherList
ExtensionPoint.LegacyInstancesAreScopedToHudson
BUILDERS, PUBLISHERS
Constructor and Description |
---|
TEDExecutionBuilder(String repositoryName,
String resultsRepositoryName,
String selectExecutionTypeRadio,
String specificationName,
String specificationType,
String specificationList,
boolean exitOnFailure,
String executionContext,
String executionTimeout,
boolean defineCES,
String cesURL,
boolean useCloudCES,
String cloudCustomerNo,
String cloudSiteID,
boolean defineManager,
String communicationManager,
String communicationManagerPort,
boolean defineServer,
String executionServer,
String executionServerPort,
boolean defineHost,
String connectionId,
boolean includeCred,
String credentialsID,
boolean defineJobcard,
String jclJobcardLine1,
String jclJobcardLine2,
String jclJobcardLine3,
String jclJobcardLine4,
String jclJobcardLine5,
boolean defineQualifiers,
String datasetHighLevelQualifier,
String temporaryDatasetPrefix,
String temporaryDatasetSuffix,
boolean defineDataprivacyOverride,
String dpOverrideFADEBUG,
String dpOverrideFAEXPATH,
String dpOverrideFAIPADDR,
String dpOverrideFAJOPTS,
String dpOverrideFAJPATH,
boolean haltPipelineOnFailure)
Constructor for TED Execution Builder
|
Modifier and Type | Method and Description |
---|---|
String |
getCesURL()
Returns the CES URL.
|
String |
getCloudCustomerNo()
Returns the cloud customer number.
|
String |
getCloudSiteID()
Returns the cloud site id.
|
String |
getCommunicationManager()
Returns the communication manager host.
|
String |
getCommunicationManagerPort()
Returns the communication manager port.
|
String |
getConnectionId()
Returns the execution host connection id.
|
String |
getCredentialsId()
Returns the execution host credentials
|
String |
getDatasetHighLevelQualifier()
Returns the dataset highlevel qualifier
|
boolean |
getDefineCES()
Returns if CES is being defined.
|
boolean |
getDefineDataprivacyOverride()
Returns if the dataprivacy overrides is defined
|
boolean |
getDefineHost()
Returns if the execution host has to be defined.
|
boolean |
getDefineJobcard()
Returns the if the JCL Jobcard preferences are to be defined.
|
boolean |
getDefineManager()
Returns if the communication manager is being defined.
|
boolean |
getDefineQualifiers()
Returns if the dataset qualifiers are to be defined
|
boolean |
getDefineServer()
Return if the execution server is to be defined.
|
Descriptor<Builder> |
getDescriptor() |
String |
getDpOverrideFADEBUG()
Returns the dataprivacy overrides FADEBUG
|
String |
getDpOverrideFAEXPATH()
Returns the dataprivacy overrides FAEXPATH
|
String |
getDpOverrideFAIPADDR()
Returns the dataprivacy overrides FAIPADDR
|
String |
getDpOverrideFAJOPTS()
Returns the dataprivacy overrides FAJOPTS
|
String |
getDpOverrideFAJPATH()
Returns the dataprivacy overrides FAJPATH
|
String |
getExecutionContext()
Returns the execution context to be used.
|
String |
getExecutionServer()
Returns the execution server host.
|
String |
getExecutionServerPort()
Returns the execution server port.
|
String |
getExecutionTimeout()
Returns the value for the execution timeout.
|
boolean |
getExitOnFailure()
Returns the flag if process has to exit on failure after a specification fails in a list.
|
boolean |
getHaltPipelineOnFailure()
Should the pipeline execution continues when an error occurs.
|
String |
getHaltPipelineTitle()
Returns the associated text for the "Halt pipeline if errors occur" field's title
|
boolean |
getIncludeCred()
Returns if the execution host credentials has to be included
|
String |
getJclJobcardLine1()
Returns the JCL Jobcard preference line 1
|
String |
getJclJobcardLine2()
Returns the JCL Jobcard preference line 2
|
String |
getJclJobcardLine3()
Returns the JCL Jobcard preference line 3
|
String |
getJclJobcardLine4()
Returns the JCL Jobcard preference line 4
|
String |
getJclJobcardLine5()
Returns the JCL Jobcard preference line 5
|
String |
getRepositoryName()
Returns the name of the repository name to be used for specification retrieval.
|
String |
getResultsRepositoryName()
Returns the name of the results repository name to be used for storing compare results.
|
String |
getSelectExecutionType()
Returns the selected execution type radio button.
|
String |
getSelectExecutionTypeRadio()
Returns the chosen execution type.
|
String |
getSpecificationList()
Returns the list specifications to be executed.
|
String |
getSpecificationName()
Returns the name of the specification to be executed.
|
String |
getSpecificationType()
Returns the type of the specification to be executed.
|
String |
getTemporaryDatasetPrefix()
Returns the temporary dataset prefix
|
String |
getTemporaryDatasetSuffix()
Returns the temporary dataset suffix
|
boolean |
getUseCloudCES()
Returns if Cloud CES is to be used.
|
boolean |
isMultiSpecExecution()
Returns if Multi Spec Execution is selected.
|
boolean |
isSingleSpecExecution()
Returns if Single Spec Execution is selected.
|
void |
perform(Run<?,?> build,
FilePath workspace,
Launcher launcher,
TaskListener listener)
Performs the execution of the pipeline.
|
void |
setCesURL(String cesURL)
Sets the CES URL.
|
void |
setCloudCustomerNo(String cloudCustomerNo)
Sets the cloud customer number.
|
void |
setCloudSiteID(String cloudSiteID)
Sets the cloud site id.
|
void |
setCommunicationManager(String communicationManager)
Set the communication manager host.
|
void |
setCommunicationManagerPort(String communicationManagerPort)
Set the communication manager port.
|
void |
setConnectionId(String connectionId)
Sets the execution host connection id.
|
void |
setCredentialsId(String credentialsId)
Sets the execution host credentials
|
void |
setDatasetHighLevelQualifier(String datasetHighLevelQualifier)
Sets the dataset highlevel qualifier
|
void |
setDefineCES(boolean defineCES)
Sets if the CES is being defined.
|
void |
setDefineDataprivacyOverride(boolean defineDataprivacyOverride)
Sets if the dataprivacy overrides is defined
|
void |
setDefineHost(boolean defineHost)
Sets if the execution host has to be defined.
|
void |
setDefineJobcard(boolean defineJobcard)
Sets the if the JCL Jobcard preferences are to be defined.
|
void |
setDefineManager(boolean defineManager)
Set if the communication manager is being defined.
|
void |
setDefineQualifiers(boolean defineQualifiers)
Sets if the dataset qualifiers are to be defined
|
void |
setDefineServer(boolean defineServer)
Set if the execution server is to be defined.
|
void |
setDpOverrideFADEBUG(String dpOverrideFADEBUG)
Sets the dataprivacy overrides FADEBUG
|
void |
setDpOverrideFAEXPATH(String dpOverrideFAEXPATH)
Sets the dataprivacy overrides FAEXPATH
|
void |
setDpOverrideFAIPADDR(String dpOverrideFAIPADDR)
Sets the dataprivacy overrides FAIPADDR
|
void |
setDpOverrideFAJOPTS(String dpOverrideFAJOPTS)
Sets the dataprivacy overrides FAJOPTS
|
void |
setDpOverrideFAJPATH(String dpOverrideFAJPATH)
Sets the dataprivacy overrides FAJPATH
|
void |
setExecutionContext(String executionContext)
Sets the execution context to be used.
|
void |
setExecutionServer(String executionServer)
Sets the execution server host.
|
void |
setExecutionServerPort(String executionServerPort)
Sets the execution server port.
|
void |
setExecutionTimeout(String executionTimeout)
Sets the value for the execution timeout.
|
void |
setExitOnFailure(boolean exitOnFailure)
Sets the flag if process has to exit on failure after a specification fails in a list.
|
void |
setHaltPipelineOnFailure(boolean haltPipelineOnFailure)
Set if the pipeline execution continues when an error occurs.
|
void |
setIncludeCred(boolean includeCred)
Sets if the execution host credentials has to be included
|
void |
setJclJobcardLine1(String jclJobcardLine1)
Sets the JCL Jobcard preference line 1
|
void |
setJclJobcardLine2(String jclJobcardLine2)
Sets the JCL Jobcard preference line 2
|
void |
setJclJobcardLine3(String jclJobcardLine3)
Sets the JCL Jobcard preference line 3
|
void |
setJclJobcardLine4(String jclJobcardLine4)
Sets the JCL Jobcard preference line 4
|
void |
setJclJobcardLine5(String jclJobcardLine5)
Sets the JCL Jobcard preference line 5
|
void |
setRepositoryName(String repositoryName)
Sets the name of the repository name to be used for specification retrieval.
|
void |
setResultsRepositoryName(String resultsRepositoryName)
Sets the name of the repository name to be used for storing compare results.
|
void |
setSelectExecutionTypeRadio(String selectExecutionTypeRadio)
Sets the chosen execution type.
|
void |
setSpecificationList(String specificationList)
Sets the list specifications to be executed.
|
void |
setSpecificationName(String specificationName)
Sets the name of the specification to be executed.
|
void |
setSpecificationType(String specificationType)
Sets the type of the specification to be executed.
|
void |
setTemporaryDatasetPrefix(String temporaryDatasetPrefix)
Sets the temporary dataset prefix
|
void |
setTemporaryDatasetSuffix(String temporaryDatasetSuffix)
Sets the temporary dataset suffix
|
void |
setUseCloudCES(boolean useCloudCES)
Set if the Cloud CES is to be used.
|
void |
validateParameters(Launcher launcher,
TaskListener listener,
Item project)
Validates the defined parameters.
|
all, getRequiredMonitorService, prebuild
getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
perform, perform, requiresWorkspace
getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild
@DataBoundConstructor public TEDExecutionBuilder(String repositoryName, String resultsRepositoryName, String selectExecutionTypeRadio, String specificationName, String specificationType, String specificationList, boolean exitOnFailure, String executionContext, String executionTimeout, boolean defineCES, String cesURL, boolean useCloudCES, String cloudCustomerNo, String cloudSiteID, boolean defineManager, String communicationManager, String communicationManagerPort, boolean defineServer, String executionServer, String executionServerPort, boolean defineHost, String connectionId, boolean includeCred, String credentialsID, boolean defineJobcard, String jclJobcardLine1, String jclJobcardLine2, String jclJobcardLine3, String jclJobcardLine4, String jclJobcardLine5, boolean defineQualifiers, String datasetHighLevelQualifier, String temporaryDatasetPrefix, String temporaryDatasetSuffix, boolean defineDataprivacyOverride, String dpOverrideFADEBUG, String dpOverrideFAEXPATH, String dpOverrideFAIPADDR, String dpOverrideFAJOPTS, String dpOverrideFAJPATH, boolean haltPipelineOnFailure)
repositoryName
- Name of repository containing the specification to be executedresultsRepositoryName
- Name of the results repository where compare pro execution results will be storedselectExecutionTypeRadio
- Radio choice denoting whether single or multi specification executionspecificationName
- Name of the specification to be executedspecificationType
- Type of the specification to be executedspecificationList
- The specification list to be executed in case of multi-spec executionexitOnFailure
- The execution context file to be usedexecutionContext
- The custom execution timeoutexecutionTimeout
- If specification execution has to exit on encountering failure in case of multi-spec executiondefineCES
- If CES is being configured via the jenkins plugincesURL
- The URL for the CES to be used for license checkuseCloudCES
- If the CES URL provided is that of the BMC Cloud CEScloudCustomerNo
- The customer number for cloud CEScloudSiteID
- The site ID for cloud CESdefineManager
- If communication manager is to be defined via the jenkins plugincommunicationManager
- Communication Manager host name or ipcommunicationManagerPort
- Communication Manager's portdefineServer
- If execution server is to be defined via the jenkins pluginexecutionServer
- Execution Server Host name or ipexecutionServerPort
- Execution Server's portdefineHost
- If execution host is to be defined via the jenkins pluginconnectionId
- Execution Host Connection IDincludeCred
- If execution host credentials is to be defined via the jenkins plugincredentialsID
- Execution Host - Credentials IDdefineJobcard
- If jobcard preferences are to be defined via the jenkins pluginjclJobcardLine1
- JCL Jobcard Line 1jclJobcardLine2
- JCL Jobcard Line 2jclJobcardLine3
- JCL Jobcard Line 3jclJobcardLine4
- JCL Jobcard Line 4jclJobcardLine5
- JCL Jobcard Line 5defineQualifiers
- If dataset qualifiers are to be defined via the jenkins plugindatasetHighLevelQualifier
- Highlevel qualifiers to be used for DatasetstemporaryDatasetPrefix
- Prefix to be used for temporary datasetstemporaryDatasetSuffix
- Suffix to be used for temporary datasetsdefineDataprivacyOverride
- If dataprivacy overrides are to be defined via the jenkins plugindpOverrideFADEBUG
- Data Privacy Override FADEBUDdpOverrideFAEXPATH
- Data Privacy Override FAEXPATHdpOverrideFAIPADDR
- Data Privacy Override FAIPADDRdpOverrideFAJOPTS
- Data Privacy Override FAJOPTSdpOverrideFAJPATH
- Data Privacy Override FAJPATHhaltPipelineOnFailure
- Flag to denote if the pipeline is to be halted on Failurepublic void perform(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener) throws InterruptedException, IOException
perform
in interface SimpleBuildStep
InterruptedException
IOException
public void validateParameters(Launcher launcher, TaskListener listener, Item project)
launcher
- launcherlistener
- tasklistenerproject
- projectpublic Descriptor<Builder> getDescriptor()
getDescriptor
in interface Describable<Builder>
getDescriptor
in class Builder
public String getSelectExecutionType()
String
value of the selectProgramsRadio option.public boolean isSingleSpecExecution()
true
if Select JSON option is selected, otherwise false
.public boolean isMultiSpecExecution()
true
if Select JSON option is selected, otherwise false
.public String getRepositoryName()
String
@DataBoundSetter public void setRepositoryName(String repositoryName)
repositoryName
- String
public String getResultsRepositoryName()
String
@DataBoundSetter public void setResultsRepositoryName(String resultsRepositoryName)
resultsRepositoryName
- String
public String getSelectExecutionTypeRadio()
String
@DataBoundSetter public void setSelectExecutionTypeRadio(String selectExecutionTypeRadio)
selectExecutionTypeRadio
- String
public String getSpecificationName()
String
@DataBoundSetter public void setSpecificationName(String specificationName)
specificationName
- String
public String getSpecificationType()
String
@DataBoundSetter public void setSpecificationType(String specificationType)
specificationType
- String
public String getSpecificationList()
String
@DataBoundSetter public void setSpecificationList(String specificationList)
specificationList
- String
public String getExecutionContext()
String
@DataBoundSetter public void setExecutionContext(String executionContext)
executionContext
- String
public boolean getExitOnFailure()
boolean
@DataBoundSetter public void setExitOnFailure(boolean exitOnFailure)
exitOnFailure
- boolean
public String getExecutionTimeout()
String
@DataBoundSetter public void setExecutionTimeout(String executionTimeout)
executionTimeout
- String
public boolean getDefineCES()
boolean
@DataBoundSetter public void setDefineCES(boolean defineCES)
defineCES
- boolean
public boolean getUseCloudCES()
boolean
@DataBoundSetter public void setUseCloudCES(boolean useCloudCES)
useCloudCES
- boolean
public String getCesURL()
String
@DataBoundSetter public void setCesURL(String cesURL)
cesURL
- String
public String getCloudCustomerNo()
String
@DataBoundSetter public void setCloudCustomerNo(String cloudCustomerNo)
cloudCustomerNo
- String
public String getCloudSiteID()
String
@DataBoundSetter public void setCloudSiteID(String cloudSiteID)
cloudSiteID
- String
public boolean getDefineManager()
boolean
@DataBoundSetter public void setDefineManager(boolean defineManager)
defineManager
- boolean
public String getCommunicationManager()
String
@DataBoundSetter public void setCommunicationManager(String communicationManager)
communicationManager
- String
public String getCommunicationManagerPort()
String
@DataBoundSetter public void setCommunicationManagerPort(String communicationManagerPort)
communicationManagerPort
- String
public boolean getDefineServer()
boolean
@DataBoundSetter public void setDefineServer(boolean defineServer)
defineServer
- boolean
public String getExecutionServer()
String
@DataBoundSetter public void setExecutionServer(String executionServer)
executionServer
- String
public String getExecutionServerPort()
String
@DataBoundSetter public void setExecutionServerPort(String executionServerPort)
executionServerPort
- String
public boolean getDefineHost()
boolean
@DataBoundSetter public void setDefineHost(boolean defineHost)
defineHost
- boolean
public String getConnectionId()
String
@DataBoundSetter public void setConnectionId(String connectionId)
connectionId
- String
public boolean getIncludeCred()
boolean
@DataBoundSetter public void setIncludeCred(boolean includeCred)
includeCred
- boolean
public String getCredentialsId()
String
@DataBoundSetter public void setCredentialsId(String credentialsId)
credentialsId
- String
public boolean getDefineJobcard()
boolean
@DataBoundSetter public void setDefineJobcard(boolean defineJobcard)
defineJobcard
- boolean
public String getJclJobcardLine1()
String
@DataBoundSetter public void setJclJobcardLine1(String jclJobcardLine1)
jclJobcardLine1
- String
public String getJclJobcardLine2()
String
@DataBoundSetter public void setJclJobcardLine2(String jclJobcardLine2)
jclJobcardLine2
- String
public String getJclJobcardLine3()
String
@DataBoundSetter public void setJclJobcardLine3(String jclJobcardLine3)
jclJobcardLine3
- String
public String getJclJobcardLine4()
String
@DataBoundSetter public void setJclJobcardLine4(String jclJobcardLine4)
jclJobcardLine4
- String
public String getJclJobcardLine5()
String
@DataBoundSetter public void setJclJobcardLine5(String jclJobcardLine5)
jclJobcardLine5
- String
public boolean getDefineQualifiers()
boolean
@DataBoundSetter public void setDefineQualifiers(boolean defineQualifiers)
defineQualifiers
- boolean
public String getDatasetHighLevelQualifier()
String
@DataBoundSetter public void setDatasetHighLevelQualifier(String datasetHighLevelQualifier)
datasetHighLevelQualifier
- String
public String getTemporaryDatasetPrefix()
String
@DataBoundSetter public void setTemporaryDatasetPrefix(String temporaryDatasetPrefix)
temporaryDatasetPrefix
- String
public String getTemporaryDatasetSuffix()
String
@DataBoundSetter public void setTemporaryDatasetSuffix(String temporaryDatasetSuffix)
temporaryDatasetSuffix
- String
public boolean getDefineDataprivacyOverride()
boolean
@DataBoundSetter public void setDefineDataprivacyOverride(boolean defineDataprivacyOverride)
defineDataprivacyOverride
- boolean
public String getDpOverrideFADEBUG()
String
@DataBoundSetter public void setDpOverrideFADEBUG(String dpOverrideFADEBUG)
dpOverrideFADEBUG
- String
public String getDpOverrideFAEXPATH()
String
@DataBoundSetter public void setDpOverrideFAEXPATH(String dpOverrideFAEXPATH)
dpOverrideFAEXPATH
- String
public String getDpOverrideFAIPADDR()
String
@DataBoundSetter public void setDpOverrideFAIPADDR(String dpOverrideFAIPADDR)
dpOverrideFAIPADDR
- String
public String getDpOverrideFAJOPTS()
String
@DataBoundSetter public void setDpOverrideFAJOPTS(String dpOverrideFAJOPTS)
dpOverrideFAJOPTS
- String
public String getDpOverrideFAJPATH()
String
@DataBoundSetter public void setDpOverrideFAJPATH(String dpOverrideFAJPATH)
dpOverrideFAJPATH
- String
public boolean getHaltPipelineOnFailure()
true
indicates pipeline should stop error is detected.
false
indicates pipeline should not stop error is detected.@DataBoundSetter public void setHaltPipelineOnFailure(boolean haltPipelineOnFailure)
haltPipelineOnFailure
- true
indicates pipeline should stop error is detected.
false
indicates pipeline should not stop error is detected.public final String getHaltPipelineTitle()
String
The "Halt pipeline if errors occur" field titleCopyright © 2016–2023. All rights reserved.