com.compuware.jenkins.scm

Class IspwConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.AbstractConfiguration

com.compuware.jenkins.scm.IspwConfiguration

All Implemented Interfaces:

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

public class IspwConfiguration
extends AbstractConfiguration

Captures the configuration information for a ISPW SCM.

Nested Class Summary

Nested Classes

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

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
IspwConfiguration(String connectionId, String credentialsId, String serverConfig, String serverStream, String serverApplication, String serverLevel, String levelOption, String componentType, String folderName)

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	getComponentType() Gets the value of the 'Component type'
String	getConnectionId() Gets the unique identifier of the 'Host connection'.
String	getCredentialsId() Gets the value of the 'Login Credentials'
String	getFilterFiles() Gets the value of the 'Components' checkbox
String	getFilterFolders() Gets the value of the 'Folders' checkbox
String	getFolderName() Gets the value of the 'Folder Name'
String	getLevelOption() Gets the value of the 'Level Option'
protected com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getLoginInformation(hudson.model.Item project) Retrieves login information given a credential ID
String	getServerApplication() Gets the value of the 'Application'
String	getServerConfig() Gets the value of the 'Config'
String	getServerLevel() Gets the value of the 'Level'
String	getServerStream() Gets the value of the 'Stream'
boolean	supportsPolling() Plugin does not support polling.
void	validateParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the 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, 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

IspwConfiguration

@DataBoundConstructor
public IspwConfiguration(String connectionId,
                                                String credentialsId,
                                                String serverConfig,
                                                String serverStream,
                                                String serverApplication,
                                                String serverLevel,
                                                String levelOption,
                                                String componentType,
                                                String folderName)

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

getConnectionId

public String getConnectionId()

Gets the unique identifier of the 'Host connection'.

Returns:

String value of m_connectionId

getCredentialsId

public String getCredentialsId()

Gets the value of the 'Login Credentials'

Returns:

String value of m_credentialsId

getServerConfig

public String getServerConfig()

Gets the value of the 'Config'

Returns:

String value of m_serverConfig

getServerStream

public String getServerStream()

Gets the value of the 'Stream'

Returns:

String value of m_serverStream

getServerApplication

public String getServerApplication()

Gets the value of the 'Application'

Returns:

String value of m_serverApplication

getServerLevel

public String getServerLevel()

Gets the value of the 'Level'

Returns:

String value of m_serverLevel

getLevelOption

public String getLevelOption()

Gets the value of the 'Level Option'

Returns:

String value of m_levelOption

getComponentType

public String getComponentType()

Gets the value of the 'Component type'

Returns:

String value of m_componentType

getFolderName

public String getFolderName()

Gets the value of the 'Folder Name'

Returns:

String value of m_folderName

getFilterFiles

public String getFilterFiles()

Gets the value of the 'Components' checkbox

Returns:

String value of m_filterFiles

getFilterFolders

public String getFilterFolders()

Gets the value of the 'Folders' checkbox

Returns:

String value of m_filterFolders

getLoginInformation

protected com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getLoginInformation(hudson.model.Item project)

Retrieves login information given a credential ID

Parameters:

project - the Jenkins project

Returns:

a Jenkins credential with login information

validateParameters

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

Validates the configuration parameters.

Parameters:

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

listener - Build listener

project - the Jenkins project

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