com.compuware.jenkins.scm

Class PdsConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.AbstractConfiguration

com.compuware.jenkins.scm.CpwrScmConfiguration

com.compuware.jenkins.scm.PdsConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>

public class PdsConfiguration
extends CpwrScmConfiguration

Captures the configuration information for a PDS SCM.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.compuware.jenkins.scm.AbstractConfiguration

m_codePage, m_connectionId, m_hostPort, m_isMigrated

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
PdsConfiguration(String connectionId, String filterPattern, String fileExtension, String credentialsId, String targetFolder) Gets the data from the configuration page.

Method Summary

Modifier and Type	Method and Description
SCMRevisionState	calcRevisionsFromBuild(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener) Calculates any revisions from previous builds.
void	checkout(Run<?,?> build, Launcher launcher, FilePath workspaceFilePath, TaskListener listener, File changelogFile, SCMRevisionState baseline) Method that is first called when a build is run.
PdsConfiguration.PdsDescriptorImpl	getDescriptor() Returns the ScmDescriptor for the SCM object.
boolean	supportsPolling() Plugin does not support polling.

Methods inherited from class com.compuware.jenkins.scm.CpwrScmConfiguration

createChangeLogParser, getConnectionId, getCredentialsId, getFileExtension, getFilterPattern, getLoginInformation, getTargetFolder, validateParameters, validateTargetFolder

Methods inherited from class com.compuware.jenkins.scm.AbstractConfiguration

isMigrated, jobLoaded, readResolve

Methods inherited from class hudson.scm.SCM

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PdsConfiguration

@DataBoundConstructor
public PdsConfiguration(String connectionId,
                                               String filterPattern,
                                               String fileExtension,
                                               String credentialsId,
                                               String targetFolder)

Gets the data from the configuration page. The parameter names must match the field names set by config.jelly.

Parameters:

connectionId - a unique host connection identifier

filterPattern - filter for the datasets to be retrieved from the mainframe

fileExtension - file extension for the incoming datasets

credentialsId - unique id of the selected credential

targetFolder - source download location

Method Detail

checkout

public void checkout(Run<?,?> build,
                     Launcher launcher,
                     FilePath workspaceFilePath,
                     TaskListener listener,
                     File changelogFile,
                     SCMRevisionState baseline)
              throws IOException,
                     InterruptedException

Method that is first called when a build is run. All dataset retrieval stems from here.

Overrides:

checkout in class SCM

Parameters:

launcher - the machine that the files will be checked out

workspaceFilePath - a directory to check out the source code

listener - build listener

changelogFile - upon a successful return, this file should capture the changelog. When there's no change, this file should contain an empty entry

baseline - used for polling (this parameter is not used)

Throws:

IOException - if an I/O error occurs downloading source

InterruptedException - if downloading source is interrupted by another thread

supportsPolling

public boolean supportsPolling()

Plugin does not support polling. We handle file changes in the CLI.

Overrides:

supportsPolling in class SCM

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(Run<?,?> build,
                                               FilePath workspace,
                                               Launcher launcher,
                                               TaskListener listener)
                                        throws IOException,
                                               InterruptedException

Calculates any revisions from previous builds. Method required to support Pipeline. We handle file changes in the CLI.

Overrides:

calcRevisionsFromBuild in class SCM

Throws:

IOException

InterruptedException

getDescriptor

public PdsConfiguration.PdsDescriptorImpl getDescriptor()

Returns the ScmDescriptor for the SCM object. The ScmDescriptor is used to create new instances of the SCM.

Specified by:

getDescriptor in interface Describable<SCM>

Overrides:

getDescriptor in class SCM