com.compuware.jenkins.build

Class SubmitJclBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.compuware.jenkins.build.SubmitJclBaseBuilder

com.compuware.jenkins.build.SubmitJclBuilder

All Implemented Interfaces:

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

public class SubmitJclBuilder
extends SubmitJclBaseBuilder

Captures the configuration information for a Submit JCL build step.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubmitJclBuilder.DescriptorImpl DescriptorImpl is used to create instances of SubmitJclBuilder.

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
SubmitJclBuilder(String connectionId)
SubmitJclBuilder(String connectionId, String credentialsId, String maxConditionCode, String jcl) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addArguments(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.util.ArgumentListBuilder args) Adds arguments to be sent to the CLI.
protected void	cleanUp() Handle clean up when finished builder execution.
SubmitJclBuilder.DescriptorImpl	getDescriptor()
String	getJcl() Gets the value of the 'JCL' statements.
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Performs the JCL Submit.

Methods inherited from class com.compuware.jenkins.build.SubmitJclBaseBuilder

getConnectionId, getCredentialsId, getMaxConditionCode

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

SubmitJclBuilder

public SubmitJclBuilder(String connectionId)

SubmitJclBuilder

@DataBoundConstructor
public SubmitJclBuilder(String connectionId,
                                               String credentialsId,
                                               String maxConditionCode,
                                               String jcl)

Constructor.

Parameters:

connectionId - a unique host connection identifier

credentialsId - unique id of the selected credential

maxConditionCode - a maximum condition code

jcl - the JCL statements

Method Detail

getJcl

public String getJcl()

Gets the value of the 'JCL' statements.

Returns:

String value of jcl

getDescriptor

public SubmitJclBuilder.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder

addArguments

protected void addArguments(hudson.model.Run<?,?> run,
                            hudson.FilePath workspace,
                            hudson.Launcher launcher,
                            hudson.model.TaskListener listener,
                            hudson.util.ArgumentListBuilder args)
                     throws IOException,
                            InterruptedException

Description copied from class: SubmitJclBaseBuilder

Adds arguments to be sent to the CLI.

Extensions of this class should call this method to add their own arguments.

Specified by:

addArguments in class SubmitJclBaseBuilder

Parameters:

run - the current running Jenkins build

workspace - the Jenkins job workspace directory

launcher - the way to start a process

listener - the build listener

args - the argument list builder to add CLI arguments to

Throws:

IOException - if an error in the communication between VirtualChannels when attempting to get remote system properties.

InterruptedException - if the current thread is interrupted while waiting for the completion of a call to get remote system properties.

perform

public void perform(hudson.model.Run<?,?> run,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws IOException,
                    InterruptedException

Description copied from class: SubmitJclBaseBuilder

Performs the JCL Submit.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Overrides:

perform in class SubmitJclBaseBuilder

Parameters:

run - the current running Jenkins build

workspace - the Jenkins job workspace directory

launcher - the way to start a process

listener - the build listener

Throws:

IOException - if an error in checking CLI compatibility, retrieving the environment or launching the CLI command

InterruptedException - if an error in checking CLI compatibility, retrieving the environment or launching the CLI command

cleanUp

protected void cleanUp()
                throws IOException,
                       InterruptedException

Handle clean up when finished builder execution.

A temporary JCL file is created during builder execution that is consumed by the CLI and is deleted when execution is finished.

Throws:

IOException - if unable to delete temporary JCL file

InterruptedException - if unable to delete temporary JCL file