com.compuware.jenkins.scm

Class PdsConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.CpwrScmConfiguration

com.compuware.jenkins.scm.PdsConfiguration

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.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.DescriptorImpl DescriptorImpl is used to create instances of PdsConfiguration.

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
PdsConfiguration(String hostPort, String filterPattern, String fileExtension, String credentialsId, String codePage) Gets the data from the configuration page.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkout(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.FilePath workspaceFilePath, hudson.model.BuildListener listener, File changelogFile) Method that is first called when a build is run.
PdsConfiguration.DescriptorImpl	getDescriptor() Returns the ScmDescriptor for the SCM object.
void	validateParameters(hudson.Launcher launcher, hudson.model.BuildListener listener) Validates the configuration parameters.

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

createChangeLogParser, getCodePage, getCredentialsId, getFileExtension, getFilterPattern, getHost, getHostPort, getLoginInformation, getPort, getTopazCLILocation, validateHostPort

Methods inherited from class hudson.scm.SCM

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

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 hostPort,
                                     String filterPattern,
                                     String fileExtension,
                                     String credentialsId,
                                     String codePage)

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

Parameters:

hostPort - 'Host':'Port'

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

codePage - code page

Method Detail

checkout

public boolean checkout(hudson.model.AbstractBuild<?,?> build,
               hudson.Launcher launcher,
               hudson.FilePath workspaceFilePath,
               hudson.model.BuildListener listener,
               File changelogFile)
                 throws IOException,
                        InterruptedException

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

Overrides:

checkout in class hudson.scm.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

Returns:

boolean if the build was successful

Throws:

IOException

InterruptedException

validateParameters

public void validateParameters(hudson.Launcher launcher,
                      hudson.model.BuildListener listener)

Validates the configuration parameters.

Parameters:

launcher - The machine that the files will be checked out.

listener - Build listener

getDescriptor

public PdsConfiguration.DescriptorImpl getDescriptor()

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

Specified by:

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

Overrides:

getDescriptor in class hudson.scm.SCM