com.compuware.jenkins.build

Class SubmitJclBaseBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.compuware.jenkins.build.SubmitJclBaseBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

SubmitJclBuilder, SubmitJclMemberBuilder

public abstract class SubmitJclBaseBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Captures the common configuration information for a Submit JCL or JCL Member build step.

Nested Class Summary

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

Modifier	Constructor and Description
	SubmitJclBaseBuilder()
protected	SubmitJclBaseBuilder(String connectionId) Constructor.
protected	SubmitJclBaseBuilder(String connectionId, String credentialsId, String maxConditionCode) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract 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.
String	getConnectionId() Gets the unique identifier of the 'Host connection'.
String	getCredentialsId() Gets the value of the 'Login credentials'.
String	getMaxConditionCode() Gets the value of the 'Maximum Condition Code'.
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Performs the JCL Submit.

Methods inherited from class hudson.tasks.Builder

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

SubmitJclBaseBuilder

public SubmitJclBaseBuilder()

SubmitJclBaseBuilder

protected SubmitJclBaseBuilder(String connectionId)

Constructor.

Parameters:

connectionId - a unique host connection identifier

SubmitJclBaseBuilder

protected SubmitJclBaseBuilder(String connectionId,
                               String credentialsId,
                               String maxConditionCode)

Constructor.

Parameters:

connectionId - a unique host connection identifier

credentialsId - unique id of the selected credential

maxConditionCode - a maximum condition code

Method Detail

getConnectionId

public String getConnectionId()

Gets the unique identifier of the 'Host connection'.

Returns:

String value of connectionId

getCredentialsId

public String getCredentialsId()

Gets the value of the 'Login credentials'.

Returns:

String value of credentialsId

getMaxConditionCode

public String getMaxConditionCode()

Gets the value of the 'Maximum Condition Code'.

Returns:

String value of maxConditionCode

perform

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

Performs the JCL Submit.

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

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

addArguments

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

Adds arguments to be sent to the CLI.

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

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.