com.compuware.jenkins.scm

Class AbstractIspwConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.AbstractConfiguration

com.compuware.jenkins.scm.AbstractIspwConfiguration

All Implemented Interfaces:

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

Direct Known Subclasses:

IspwConfiguration, IspwContainerConfiguration

public abstract class AbstractIspwConfiguration
extends AbstractConfiguration

Captures the configuration information for a ISPW SCM.

Nested Class Summary

Nested classes/interfaces inherited from class com.compuware.jenkins.scm.AbstractConfiguration

AbstractConfiguration.AbstractConfigurationImpl<T extends hudson.scm.SCM>

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.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
AbstractIspwConfiguration(String connectionId, String credentialsId, String serverConfig)

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) Calculates any revisions from previous builds.
void	checkout(hudson.model.Run<?,?> build, hudson.Launcher launcher, hudson.FilePath workspaceFilePath, hudson.model.TaskListener listener, File changelogFile, hudson.scm.SCMRevisionState baseline) Method that is first called when a build is run.
hudson.scm.ChangeLogParser	createChangeLogParser()
String	getConnectionId() Gets the unique identifier of the 'Host connection'.
String	getCredentialsId() Gets the value of the 'Login credentials'
String	getServerConfig() Gets the value of the 'Runtime configuration'
protected String	getTrimmedValue(String value) Returns a copy of the string, with leading and trailing whitespace omitted.
boolean	supportsPolling() Plugin does not support polling.
void	validateCliLocation(com.compuware.jenkins.common.configuration.CpwrGlobalConfiguration globalConfig, hudson.Launcher launcher, hudson.model.TaskListener listener) Validates the Cli location.
abstract void	validateFilterParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the filter configuration parameters.
abstract void	validateParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the configuration parameters
void	validateServerParameters(com.compuware.jenkins.common.configuration.CpwrGlobalConfiguration globalConfig, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the server configuration parameters.

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, getDescriptor, 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

AbstractIspwConfiguration

public AbstractIspwConfiguration(String connectionId,
                                 String credentialsId,
                                 String serverConfig)

Method Detail

checkout

public void checkout(hudson.model.Run<?,?> build,
                     hudson.Launcher launcher,
                     hudson.FilePath workspaceFilePath,
                     hudson.model.TaskListener listener,
                     File changelogFile,
                     hudson.scm.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 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

baseline - used for polling - this parameter is not used

Throws:

IOException

InterruptedException

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

getTrimmedValue

protected String getTrimmedValue(String value)

Returns a copy of the string, with leading and trailing whitespace omitted.

Parameters:

value - the string to trim

Returns:

String the trimmed value or an empty string if the value is null

getConnectionId

public String getConnectionId()

Gets the unique identifier of the 'Host connection'.

Returns:

String value of connectionId

getServerConfig

public String getServerConfig()

Gets the value of the 'Runtime configuration'

Returns:

String value of serverConfig

getCredentialsId

public String getCredentialsId()

Gets the value of the 'Login credentials'

Returns:

String value of credentialsId

validateServerParameters

public void validateServerParameters(com.compuware.jenkins.common.configuration.CpwrGlobalConfiguration globalConfig,
                                     hudson.Launcher launcher,
                                     hudson.model.TaskListener listener,
                                     hudson.model.Item project)
                              throws hudson.AbortException

Validates the server configuration parameters.

Parameters:

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

listener - Build listener

project - the Jenkins project

Throws:

hudson.AbortException - if an error occurs getting the credentials user

validateCliLocation

public void validateCliLocation(com.compuware.jenkins.common.configuration.CpwrGlobalConfiguration globalConfig,
                                hudson.Launcher launcher,
                                hudson.model.TaskListener listener)

Validates the Cli location.

Parameters:

globalConfig - The global configuration

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

listener - Build listener

validateFilterParameters

public abstract void validateFilterParameters(hudson.Launcher launcher,
                                              hudson.model.TaskListener listener,
                                              hudson.model.Item project)

Validates the filter configuration parameters.

Parameters:

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

listener - Build listener

project - the Jenkins project

validateParameters

public abstract void validateParameters(hudson.Launcher launcher,
                                        hudson.model.TaskListener listener,
                                        hudson.model.Item project)
                                 throws hudson.AbortException

Validates the configuration parameters

Parameters:

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

listener - Build listener

project - the Jenkins project

Throws:

hudson.AbortException - if an error occurs validating the parameters

supportsPolling

public boolean supportsPolling()

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

Overrides:

supportsPolling in class hudson.scm.SCM

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(hudson.model.Run<?,?> build,
                                                          hudson.FilePath workspace,
                                                          hudson.Launcher launcher,
                                                          hudson.model.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 hudson.scm.SCM

Throws:

IOException

InterruptedException