org.jenkinsci.plugins.IBM_zOS_Connector

Class zFTPConnector

java.lang.Object

org.jenkinsci.plugins.IBM_zOS_Connector.zFTPConnector

public class zFTPConnector
extends Object

zFTPConnector

FTP-based communication with z/OS-like systems. Used for submitting jobs, fetching job log and extraction of MaxCC.

Version:

1.0

Author:

Alexander Shcherbakov

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.net.ftp.FTPClient	FTPClient FTPClient from Apache Commons-Net.
protected boolean	JESINTERFACELEVEL1
protected static Pattern	JesJobName Pattern for search of jobName
protected String	jobCC Job's MaxCC.
protected String	jobID JobID in JES.
protected String	jobName Jobname in JES.
protected static Logger	logger Simple logger.
protected String	logPrefix Log prefix (default: "zFTPConnector")
protected String	password User password.
protected int	port FTP port for connection
protected String	server LPAR name or IP to connect to.
protected String	userID UserID.
protected static long	waitInterval Will ask LPAR once in 10 seconds.
protected long	waitTime Time to wait before giving up in milliseconds.

Constructor Summary

Constructors

Constructor and Description
zFTPConnector(String server, int port, String userID, String password, boolean JESINTERFACELEVEL1, String logPrefix) Basic constructor with minimal parameters required.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkJobAvailability()
protected boolean	connect() Try to connect to the server using the parameters passed to the constructor.
protected void	deleteJobLog() Delete job log from spool.
protected boolean	fetchJobLog(OutputStream outputStream) Fetch job log from spool.
String	getJobCC() Get JobCC.
String	getJobID() Get JobID.
String	getJobName() Get Jobname.
protected boolean	logon() Try to logon to the server using the parameters passed to the constructor.
protected boolean	obtainJobRC()
boolean	submit(InputStream inputStream, boolean wait, int waitTime, OutputStream outputStream, boolean deleteLogFromSpool) Submit job for execution.
protected boolean	waitForCompletion(OutputStream outputStream) Wait for he completion of the job.

Methods inherited from class java.lang.Object

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

Field Detail

server

protected String server

LPAR name or IP to connect to.

port

protected int port

FTP port for connection

userID

protected String userID

UserID.

password

protected String password

User password.

waitTime

protected long waitTime

Time to wait before giving up in milliseconds. If set to 0 will wait forever.

jobID

protected String jobID

JobID in JES.

jobName

protected String jobName

Jobname in JES.

jobCC

protected String jobCC

Job's MaxCC.

JESINTERFACELEVEL1

protected boolean JESINTERFACELEVEL1

waitInterval

protected static final long waitInterval

Will ask LPAR once in 10 seconds.

See Also:

Constant Field Values

FTPClient

protected org.apache.commons.net.ftp.FTPClient FTPClient

FTPClient from Apache Commons-Net. Used for FTP communication.

logPrefix

protected String logPrefix

Log prefix (default: "zFTPConnector")

JesJobName

protected static final Pattern JesJobName

Pattern for search of jobName

logger

protected static final Logger logger

Simple logger.

Constructor Detail

zFTPConnector

public zFTPConnector(String server,
                     int port,
                     String userID,
                     String password,
                     boolean JESINTERFACELEVEL1,
                     String logPrefix)

Basic constructor with minimal parameters required.

Parameters:

server - LPAR name or IP address to connect to.

port - LPAR password.

userID - UserID.

password - User password.

JESINTERFACELEVEL1 - Is FTP server configured for JESINTERFACELEVEL=1?

logPrefix - Log prefix.

Method Detail

connect

protected boolean connect()

Try to connect to the server using the parameters passed to the constructor.

Returns:

Whether the connection was established using the parameters passed to the constructor.

See Also:

zFTPConnector(String, int, String, String, boolean, String)

logon

protected boolean logon()

Try to logon to the server using the parameters passed to the constructor. Also, site filetype=jes jesjobname=* jesowner=* command is invoked.

Returns:

Whether the credentials supplied are valid and the connection was established.

See Also:

zFTPConnector(String, int, String, String, boolean, String), connect()

submit

public boolean submit(InputStream inputStream,
                      boolean wait,
                      int waitTime,
                      OutputStream outputStream,
                      boolean deleteLogFromSpool)

Submit job for execution.

Parameters:

inputStream - JCL text of the job.

wait - Whether we need for the job to complete.

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

outputStream - Stream to put job log. Can be Null.

deleteLogFromSpool - Whether the job log should be deleted fro spool upon job end.

Returns:

Whether the job was successfully submitted and the job log was fetched.
jobCC holds the response of the operation (including errors).

See Also:

connect(), logon(), waitForCompletion(OutputStream), deleteJobLog()

waitForCompletion

protected boolean waitForCompletion(OutputStream outputStream)

Wait for he completion of the job.

Parameters:

outputStream - Stream to hold job log.

Returns:

Whether the job finished in time.

See Also:

submit(InputStream, boolean, int, OutputStream, boolean), fetchJobLog(OutputStream)

checkJobAvailability

protected boolean checkJobAvailability()

Returns:

true if job can be listed through FTP.

fetchJobLog

protected boolean fetchJobLog(OutputStream outputStream)

Fetch job log from spool.

Parameters:

outputStream - Stream to hold the job log.

Returns:

Whether the job log was fetched from the LPAR.

See Also:

waitForCompletion(OutputStream)

obtainJobRC

protected boolean obtainJobRC()

Returns:

Whether job RC was correctly obtained or not.

deleteJobLog

protected void deleteJobLog()

Delete job log from spool. Job is distinguished by previously obtained jobID.

See Also:

submit(InputStream, boolean, int, OutputStream, boolean)

getJobID

public String getJobID()

Get JobID.

Returns:

Current jobID.

getJobName

public String getJobName()

Get Jobname.

Returns:

Current jobName.

getJobCC

public String getJobCC()

Get JobCC.

Returns:

Current jobCC.