hudson.scm

Class IntegritySCM

java.lang.Object

hudson.scm.SCM

hudson.scm.AbstractIntegritySCM

hudson.scm.IntegritySCM

All Implemented Interfaces:

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

public class IntegritySCM
extends AbstractIntegritySCM
implements Serializable

This class provides an integration between Hudson/Jenkins for Continuous Builds and PTC Integrity for Configuration Management

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegritySCM.DescriptorImpl The relationship of Descriptor and SCM (the describable) is akin to class and object.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.scm.AbstractIntegritySCM

alternateWorkspace, browser, checkoutThreadPoolSize, checkoutThreadTimeout, checkpointBeforeBuild, checkpointLabel, ciServerURL, cleanCopy, configPath, configurationName, CPBasedMode, DEFAULT_CHECKOUT_THREAD_TIMEOUT, DEFAULT_DATE_FORMAT, DEFAULT_THREAD_POOL_SIZE, deleteNonMembers, excludeList, fetchChangedWorkspaceFiles, FS, includeList, integrityURL, lineTerminator, localClient, LOGGER, MAX_PORT_VALUE, MIN_PORT_VALUE, NL, password, projects, restoreTimestamp, RETURNED_EXIT_CODE, sandboxScope, SDF, serverConfig, skipAuthorInfo, SQL_EXCEPTION_CAUGHT, userName

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
IntegritySCM(IntegrityRepositoryBrowser browser, String serverConfig, String userName, String password, String configPath, String includeList, String excludeList, boolean cleanCopy, String lineTerminator, boolean restoreTimestamp, boolean skipAuthorInfo, boolean checkpointBeforeBuild, String checkpointLabel, String alternateWorkspace, boolean fetchChangedWorkspaceFiles, boolean deleteNonMembers, int checkoutThreadPoolSize, String configurationName) Deprecated.
IntegritySCM(String serverConfig, String configPath, String configurationName)

Method Summary

Modifier and Type	Method and Description
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, Map<String,String> env) Adds Integrity CM Project info to the build variables
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Overridden calcRevisionsFromBuild function Returns the current project configuration which can be used to difference any future configurations
void	checkout(hudson.model.Run<?,?> run, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, File changeLogFile, hudson.scm.SCMRevisionState baseline) Overridden checkout function This is the real invocation of this plugin.
hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.Job<?,?> job, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState baseline) Overridden compareRemoteRevisionWith function that against the current to determine if the project has changed Loads up the previous project configuration and compares
String	getKey()
com.mks.api.response.Response	initializeCMProject(hudson.EnvVars environment, String projectCacheTable) Primes the Integrity Project metadata information

Methods inherited from class hudson.scm.AbstractIntegritySCM

createChangeLogParser, findProject, getAlternateWorkspace, getBrowser, getCheckoutThreadPoolSize, getCheckoutThreadTimeout, getCheckpointBeforeBuild, getCheckpointLabel, getCleanCopy, getConfigPath, getConfigurationName, getCPBasedMode, getDeleteNonMembers, getDescriptor, getExcludeList, getFetchChangedWorkspaceFiles, getIncludeList, getIntegrityProject, getLineTerminator, getLocalClient, getPassword, getProjectSettings, getRestoreTimestamp, getSandboxScope, getSecretPassword, getServerConfig, getSkipAuthorInfo, getUserName, hasProject, requiresWorkspaceForPolling, setAlternateWorkspace, setBrowser, setCheckoutThreadPoolSize, setCheckoutThreadTimeout, setCheckpointBeforeBuild, setCheckpointLabel, setCleanCopy, setConfigPath, setConfigurationName, setCPBasedMode, setDeleteNonMembers, setExcludeList, setFetchChangedWorkspaceFiles, setIncludeList, setLineTerminator, setLocalClient, setPassword, setRestoreTimestamp, setSandboxScope, setServerConfig, setSkipAuthorInfo, setUserName, supportsPolling

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getEffectiveBrowser, 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

IntegritySCM

@Deprecated
public IntegritySCM(IntegrityRepositoryBrowser browser,
                                 String serverConfig,
                                 String userName,
                                 String password,
                                 String configPath,
                                 String includeList,
                                 String excludeList,
                                 boolean cleanCopy,
                                 String lineTerminator,
                                 boolean restoreTimestamp,
                                 boolean skipAuthorInfo,
                                 boolean checkpointBeforeBuild,
                                 String checkpointLabel,
                                 String alternateWorkspace,
                                 boolean fetchChangedWorkspaceFiles,
                                 boolean deleteNonMembers,
                                 int checkoutThreadPoolSize,
                                 String configurationName)

Deprecated.

Create a constructor that takes non-transient fields, and add the annotation @DataBoundConstructor to it. Using the annotation helps the Stapler class to find which constructor that should be used when automatically copying values from a web form to a class.

IntegritySCM

@DataBoundConstructor
public IntegritySCM(String serverConfig,
                                           String configPath,
                                           String configurationName)

Method Detail

buildEnvVars

public void buildEnvVars(hudson.model.AbstractBuild<?,?> build,
                         Map<String,String> env)

Adds Integrity CM Project info to the build variables

Overrides:

buildEnvVars in class hudson.scm.SCM

calcRevisionsFromBuild

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

Overridden calcRevisionsFromBuild function Returns the current project configuration which can be used to difference any future configurations

Overrides:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

initializeCMProject

public com.mks.api.response.Response initializeCMProject(hudson.EnvVars environment,
                                                         String projectCacheTable)
                                                  throws Exception

Primes the Integrity Project metadata information

Returns:

response Integrity API Response

Throws:

Exception

checkout

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

Overridden checkout function This is the real invocation of this plugin. Currently, we will do a project info and determine the true nature of the project Subsequent to that we will run a view project command and cache the information on each member, so that we can execute project checkout commands. This obviously eliminates the need for a sandbox and can wily nilly delete the workspace directory as needed

Overrides:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

compareRemoteRevisionWith

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

Overridden compareRemoteRevisionWith function that against the current to determine if the project has changed Loads up the previous project configuration and compares

Overrides:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

getKey

public String getKey()

Overrides:

getKey in class hudson.scm.SCM