org.jenkinsci.plugins.IBM_zOS_Connector

Class SCLMSCM

java.lang.Object

hudson.scm.SCM

org.jenkinsci.plugins.IBM_zOS_Connector.SCLMSCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>

public class SCLMSCM
extends hudson.scm.SCM

SCLMSCM

Class implementing SCM functionality for SCLM.s

Version:

1.0

Author:

Alexander Shcherbakov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SCLMSCM.SCLMSCMDescriptor SCLMSCMDescriptor Descriptor for SCLMSCM.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
SCLMSCM() Dummy constructor
SCLMSCM(String server, int port, String userID, String password, String project, String alternate, String group, String types, boolean custJobStep, String JobStep, boolean custJobHeader, String JobHeader) Constructor that is invoked from project configuration page.

Method Summary

Modifier and Type	Method and Description
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Calculate revision from build.
void	checkout(hudson.model.Run<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, File changelogFile, hudson.scm.SCMRevisionState baseline) Checkout remote changes to the workspace.
hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.Job<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState _baseline) Compare remote revision with old one.
hudson.scm.ChangeLogParser	createChangeLogParser() Get parser for changelog.xml .
String	getAlternate() Get SCM Alternate Project Definition.
boolean	getCustJobHeader() Get custJobHeader.
boolean	getCustJobStep() Get custJobStep.
SCLMSCM.SCLMSCMDescriptor	getDescriptor() Get descriptor.
String	getGroup() Get SCLM Group.
String	getJobHeader() Get Job header.
String	getJobStep() Get Job step.
String	getPassword() Get User password.
int	getPort() Get FTP port to connect to.
String	getProject() Get SCLM Project Name.
String	getServer() Get LPAR name or IP address.
String	getTypes() Get SCLM file types under interest.
String	getUserID() Get User ID.
boolean	requiresWorkspaceForPolling() Whether SCM requires workspace for polling process.
boolean	supportsPolling() Whether SCM supports polling.

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion

Methods inherited from class java.lang.Object

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

Constructor Detail

SCLMSCM

@DataBoundConstructor
public SCLMSCM(String server,
                                      int port,
                                      String userID,
                                      String password,
                                      String project,
                                      String alternate,
                                      String group,
                                      String types,
                                      boolean custJobStep,
                                      String JobStep,
                                      boolean custJobHeader,
                                      String JobHeader)

Constructor that is invoked from project configuration page.

Parameters:

server - LPAR name of IP address.

port - FTP port to connect to.

userID - User ID.

password - User password.

project - SCLM Project Name.

alternate - SCLM Alternate Project Definition.

group - SCLM Group.

types - Types under interest (separated by comma).

custJobStep - Whether user defines own FLMCMD job step.

JobStep - User-supplies FLMCMD job step.

custJobHeader - Whether user supplied own job header.

JobHeader - User-supplied job header.

SCLMSCM

public SCLMSCM()

Dummy constructor

Method Detail

getCustJobHeader

public boolean getCustJobHeader()

Get custJobHeader.

Returns:

custJobHeader

getCustJobStep

public boolean getCustJobStep()

Get custJobStep.

Returns:

custJobStep

getServer

public String getServer()

Get LPAR name or IP address.

Returns:

server

getPort

public int getPort()

Get FTP port to connect to.

Returns:

port

getUserID

public String getUserID()

Get User ID.

Returns:

userID

getPassword

public String getPassword()

Get User password.

Returns:

password

getProject

public String getProject()

Get SCLM Project Name.

Returns:

project

getAlternate

public String getAlternate()

Get SCM Alternate Project Definition.

Returns:

alternate

getGroup

public String getGroup()

Get SCLM Group.

Returns:

group

getJobHeader

public String getJobHeader()

Get Job header.

Returns:

JobHeader

getJobStep

public String getJobStep()

Get Job step.

Returns:

JobStep

getTypes

public String getTypes()

Get SCLM file types under interest.

Returns:

types

supportsPolling

public boolean supportsPolling()

Whether SCM supports polling.

Overrides:

supportsPolling in class hudson.scm.SCM

Returns:

true

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Whether SCM requires workspace for polling process.

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

Returns:

false

compareRemoteRevisionWith

public hudson.scm.PollingResult compareRemoteRevisionWith(@Nonnull
                                                          hudson.model.Job<?,?> project,
                                                          hudson.Launcher launcher,
                                                          hudson.FilePath workspace,
                                                          @Nonnull
                                                          hudson.model.TaskListener listener,
                                                          @Nonnull
                                                          hudson.scm.SCMRevisionState _baseline)
                                                   throws IOException,
                                                          InterruptedException

Compare remote revision with old one.

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Parameters:

project - Current project.

launcher - Current launcher.

workspace - Current workspace.

listener - Current listener.

_baseline - Old revision.

Returns:

PollingResult with comparison.

Throws:

IOException

InterruptedException

See Also:

PollingResult, SCLMSCMRevisionState, getNewRevision(SCLMSCMRevisionState)

checkout

public void checkout(@Nonnull
                     hudson.model.Run<?,?> build,
                     @Nonnull
                     hudson.Launcher launcher,
                     @Nonnull
                     hudson.FilePath workspace,
                     @Nonnull
                     hudson.model.TaskListener listener,
                     File changelogFile,
                     hudson.scm.SCMRevisionState baseline)
              throws IOException,
                     InterruptedException

Checkout remote changes to the workspace.
As the build itself is performed via SCLM, the checkout's main task is generation of revision.

Overrides:

checkout in class hudson.scm.SCM

Parameters:

build - Current build.

launcher - Current launcher.

workspace - Current workspace.

listener - Current listener.

changelogFile - Current changeLogFile.

baseline - Last revision.

Throws:

IOException

InterruptedException

See Also:

SCLMSCMRevisionState, getNewRevision(SCLMSCMRevisionState)

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(@Nonnull
                                                          hudson.model.Run<?,?> build,
                                                          hudson.FilePath workspace,
                                                          hudson.Launcher launcher,
                                                          @Nonnull
                                                          hudson.model.TaskListener listener)
                                                   throws IOException,
                                                          InterruptedException

Calculate revision from build. Dummy.

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Parameters:

build - Current build.

workspace - Current workspace.

launcher - Current launcher.

listener - Current listener.

Returns:

Actual revision.

Throws:

IOException

InterruptedException

See Also:

SCLMSCMRevisionState

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Get parser for changelog.xml .

Specified by:

createChangeLogParser in class hudson.scm.SCM

Returns:

SCLMChangeLogParser instance.

getDescriptor

public SCLMSCM.SCLMSCMDescriptor getDescriptor()

Get descriptor.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.scm.SCM>

Overrides:

getDescriptor in class hudson.scm.SCM

Returns:

Descriptor for SCLMSCM.