Package org.jenkinsci.plugins.IBM_zOS_Connector

Class ZOSJobSubmitter

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.IBM_zOS_Connector.ZOSJobSubmitter

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class ZOSJobSubmitter
extends Builder
implements SimpleBuildStep

ZOSJobSubmitter

Build step action for submitting JCL job.

Version:

1.0

Author:

Alexander Shcherbakov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ZOSJobSubmitter.ZOSJobSubmitterDescriptor	zOSJobSubmitterDescriptor

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ZOSJobSubmitter(String server, int port, String credentialsId, boolean wait, int waitTime, boolean deleteJobFromSpool, boolean jobLogToConsole, String jobFile, String MaxCC, boolean JESINTERFACELEVEL1, boolean FTPActiveMode)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getCredentialsId()
boolean	getDeleteJobFromSpool()	Get deleteJobFromSpool.
ZOSJobSubmitter.ZOSJobSubmitterDescriptor	getDescriptor()	Get descriptor for this class.
boolean	getFTPActiveMode()	Get FTPActiveMode
boolean	getJESINTERFACELEVEL1()	Get JESINTERFACELEVEL1.
String	getJobFile()
boolean	getJobLogToConsole()	Get jobLogToConsole.
String	getMaxCC()
int	getPort()	Get FTP port to connect to.
String	getServer()	Get LPAR name of IP address.
boolean	getWait()	Get wait.
int	getWaitTime()	Get wait time.
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)	Submit the job for execution.

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

ZOSJobSubmitter

@DataBoundConstructor
public ZOSJobSubmitter(String server,
 int port,
 String credentialsId,
 boolean wait,
 int waitTime,
 boolean deleteJobFromSpool,
 boolean jobLogToConsole,
 String jobFile,
 String MaxCC,
 boolean JESINTERFACELEVEL1,
 boolean FTPActiveMode)

Constructor. Invoked when 'Apply' or 'Save' button is pressed on the project configuration page.

Parameters:

MaxCC - Maximum allowed CC for job to be considered OK.

server - LPAR name or IP address.

port - FTP port to connect to.

credentialsId - Credentials id..

wait - Whether we need to wait for the job completion.

waitTime - Maximum wait time. If set to 0 will wait forever.

deleteJobFromSpool - Whether the job log will be deleted from the spool after end.

jobLogToConsole - Whether the job log will be printed to console.

jobFile - File with JCL of the job to be submitted.

JESINTERFACELEVEL1 - Is FTP server configured for JESINTERFACELEVEL=1?

FTPActiveMode - FTP data transfer mode (true=active, false=passive)

Method Details

perform

public void perform(@Nonnull
 Run<?,?> run,
 @Nonnull
 FilePath workspace,
 @Nonnull
 Launcher launcher,
 @Nonnull
 TaskListener listener)
             throws IOException

Submit the job for execution.

Specified by:

perform in interface SimpleBuildStep

Parameters:

run - Current run

workspace - Current workspace

launcher - Current launcher

listener - Current listener

Always true if wait is false.

Throws:

IOException

See Also:

• ZFTPConnector

getServer

public String getServer()

Get LPAR name of IP address.

Returns:

server

getPort

public int getPort()

Get FTP port to connect to.

Returns:

port

getCredentialsId

public String getCredentialsId()

Returns:

credentials id provided.

getJobFile

public String getJobFile()

Returns:

job file provided.

getWait

public boolean getWait()

Get wait.

Returns:

wait

getJESINTERFACELEVEL1

public boolean getJESINTERFACELEVEL1()

Get JESINTERFACELEVEL1.

Returns:

JESINTERFACELEVEL1

getDeleteJobFromSpool

public boolean getDeleteJobFromSpool()

Get deleteJobFromSpool.

Returns:

deleteJobFromSpool

getJobLogToConsole

public boolean getJobLogToConsole()

Get jobLogToConsole.

Returns:

jobLogToConsole

getWaitTime

public int getWaitTime()

Get wait time.

Returns:

waitTime

getMaxCC

public String getMaxCC()

Returns:

MaxCC of the job to be considered OK

getFTPActiveMode

public boolean getFTPActiveMode()

Get FTPActiveMode

Returns:

FTPActiveMode

getDescriptor

public ZOSJobSubmitter.ZOSJobSubmitterDescriptor getDescriptor()

Get descriptor for this class.

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder

Returns:

descriptor for this class.