hudson.scm

Class IntegritySCM

java.lang.Object

hudson.scm.SCM

hudson.scm.IntegritySCM

All Implemented Interfaces:

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

public class IntegritySCM
extends hudson.scm.SCM
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

Modifier and Type	Field and Description
static int	DEFAULT_THREAD_POOL_SIZE
static String	FS
static int	MAX_PORT_VALUE
static int	MIN_PORT_VALUE
static String	NL
static SimpleDateFormat	SDF

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) Create a constructor that takes non-transient fields, and add the annotation @DataBoundConstructor to it.

Method Summary

Methods

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.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener) Overridden calcRevisionsFromBuild function Returns the current project configuration which can be used to difference any future configurations
boolean	checkout(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener, File changeLogFile) Overridden checkout function This is the real invocation of this plugin.
protected hudson.scm.PollingResult	compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener, hudson.scm.SCMRevisionState _baseline) Overridden compareRemoteRevisionWith function Loads up the previous project configuration and compares that against the current to determine if the project has changed
hudson.scm.ChangeLogParser	createChangeLogParser() Overridden createChangeLogParser function Creates a custom Integrity Change Log Parser, which compares two view project outputs
static IntegrityCMProject	findProject(String configurationName)
String	getAlternateWorkspace() Returns the alternate workspace directory
IntegrityRepositoryBrowser	getBrowser()
int	getCheckoutThreadPoolSize() Returns the size of the thread pool for parallel checkouts
boolean	getCheckpointBeforeBuild() Returns true/false depending on whether or not perform a checkpoint before the build
String	getCheckpointLabel() Returns the label string for the checkpoint performed before the build
boolean	getCleanCopy() Returns true/false depending on whether or not the workspace is required to be cleaned
String	getConfigPath() Returns the Project or Configuration Path for a Integrity Source Project
String	getConfigurationName() Returns the configuration name for this project Required when working with Multiple SCMs plug-in
boolean	getDeleteNonMembers() Returns the true/false depending on whether non members should be deleted before the build
hudson.scm.SCMDescriptor<IntegritySCM>	getDescriptor() Returns the SCMDescriptor for the SCM object.
String	getExcludeList() Returns the files that will be included
boolean	getFetchChangedWorkspaceFiles() Returns the true/false depending on whether or not to synchronize changed workspace files
String	getIncludeList() Returns the files that will be excluded
IntegrityCMProject	getIntegrityProject() Returns the Integrity Configuration Management Project
String	getLineTerminator() Returns the line terminator to apply when obtaining files from the Integrity Server
String	getPassword() Returns the project specific encrypted password of the user connecting to the Integrity Server
boolean	getRestoreTimestamp() Returns true/false depending on whether or not the restore timestamp option is in effect
hudson.util.Secret	getSecretPassword() Returns the project specific Secret password of the user connecting to the Integrity Server
String	getServerConfig() Returns the simple server configuration name
boolean	getSkipAuthorInfo() Returns true/false depending on whether or not to use 'si revisioninfo' to determine author information
String	getUserName() Returns the project specific User connecting to the Integrity Server
static boolean	hasProject(String configurationName)
boolean	requiresWorkspaceForPolling() Toggles whether or not a workspace is required for polling Since, we're using a Server Integration Point in the Integrity API, we do not require a workspace.
void	setAlternateWorkspace(String alternateWorkspace) Sets an alternate workspace for the checkout directory
void	setCheckoutThreadPoolSize(int checkoutThreadPoolSize) Sets the thread pool size of parallel checkout threads
void	setCheckpointBeforeBuild(boolean checkpointBeforeBuild) Toggles whether or not a checkpoint should be performed before the build
void	setCheckpointLabel(String checkpointLabel) Sets the label string for the checkpoint performed before the build
void	setCleanCopy(boolean cleanCopy) Toggles whether or not the workspace is required to be cleaned
void	setConfigPath(String configPath) Sets the Project or Configuration Path for an Integrity Source Project
void	setConfigurationName(String configurationName) Sets the configuration name for this project
void	setDeleteNonMembers(boolean deleteNonMembers) Toggles whether or not non members should be deleted
void	setExcludeList(String excludeList) Sets the files that will be not be included
void	setFetchChangedWorkspaceFiles(boolean fetchChangedWorkspaceFiles) Toggles whether or not changed workspace files should be synchronized
void	setIncludeList(String includeList) Sets the files that will be not be included
void	setLineTerminator(String lineTerminator) Sets the line terminator to apply when obtaining files from the Integrity Server
void	setPassword(String password) Sets the project specific encrypted Password of the user connecting to the Integrity Server
void	setRestoreTimestamp(boolean restoreTimestamp) Toggles whether or not to restore the timestamp for individual files
void	setServerConfig(String serverConfig) Sets the server configuration name for this project
void	setSkipAuthorInfo(boolean skipAuthorInfo) Toggles whether or not to use 'si revisioninfo' to determine author information
void	setUserName(String userName) Sets the project specific User connecting to the Integrity Server

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, all, createEmptyChangeLog, getApi, getEffectiveBrowser, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, nullify, poll, pollChanges, processWorkspaceBeforeDeletion, supportsPolling

Methods inherited from class java.lang.Object

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

Field Detail

NL

public static final String NL

FS

public static final String FS

MIN_PORT_VALUE

public static final int MIN_PORT_VALUE

See Also:

Constant Field Values

MAX_PORT_VALUE

public static final int MAX_PORT_VALUE

See Also:

Constant Field Values

DEFAULT_THREAD_POOL_SIZE

public static final int DEFAULT_THREAD_POOL_SIZE

See Also:

Constant Field Values

SDF

public static final SimpleDateFormat SDF

Constructor Detail

IntegritySCM

@DataBoundConstructor
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)

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.

Method Detail

getBrowser

@Exported
public IntegrityRepositoryBrowser getBrowser()

Overrides:

getBrowser in class hudson.scm.SCM

getServerConfig

public String getServerConfig()

Returns the simple server configuration name

Returns:

getUserName

public String getUserName()

Returns the project specific User connecting to the Integrity Server

Returns:

getPassword

public String getPassword()

Returns the project specific encrypted password of the user connecting to the Integrity Server

Returns:

getSecretPassword

public hudson.util.Secret getSecretPassword()

Returns the project specific Secret password of the user connecting to the Integrity Server

Returns:

getConfigPath

public String getConfigPath()

Returns the Project or Configuration Path for a Integrity Source Project

Returns:

getIncludeList

public String getIncludeList()

Returns the files that will be excluded

Returns:

getExcludeList

public String getExcludeList()

Returns the files that will be included

Returns:

getCleanCopy

public boolean getCleanCopy()

Returns true/false depending on whether or not the workspace is required to be cleaned

Returns:

getLineTerminator

public String getLineTerminator()

Returns the line terminator to apply when obtaining files from the Integrity Server

Returns:

getRestoreTimestamp

public boolean getRestoreTimestamp()

Returns true/false depending on whether or not the restore timestamp option is in effect

Returns:

getSkipAuthorInfo

public boolean getSkipAuthorInfo()

Returns true/false depending on whether or not to use 'si revisioninfo' to determine author information

Returns:

getCheckpointBeforeBuild

public boolean getCheckpointBeforeBuild()

Returns true/false depending on whether or not perform a checkpoint before the build

Returns:

getCheckpointLabel

public String getCheckpointLabel()

Returns the label string for the checkpoint performed before the build

Returns:

getAlternateWorkspace

public String getAlternateWorkspace()

Returns the alternate workspace directory

Returns:

getFetchChangedWorkspaceFiles

public boolean getFetchChangedWorkspaceFiles()

Returns the true/false depending on whether or not to synchronize changed workspace files

Returns:

getDeleteNonMembers

public boolean getDeleteNonMembers()

Returns the true/false depending on whether non members should be deleted before the build

Returns:

getCheckoutThreadPoolSize

public int getCheckoutThreadPoolSize()

Returns the size of the thread pool for parallel checkouts

Returns:

getConfigurationName

public String getConfigurationName()

Returns the configuration name for this project Required when working with Multiple SCMs plug-in

setServerConfig

public void setServerConfig(String serverConfig)

Sets the server configuration name for this project

Parameters:

serverConfig -

setUserName

public void setUserName(String userName)

Sets the project specific User connecting to the Integrity Server

setPassword

public void setPassword(String password)

Sets the project specific encrypted Password of the user connecting to the Integrity Server

Parameters:

password - - The clear password

setConfigPath

public void setConfigPath(String configPath)

Sets the Project or Configuration Path for an Integrity Source Project

setIncludeList

public void setIncludeList(String includeList)

Sets the files that will be not be included

setExcludeList

public void setExcludeList(String excludeList)

Sets the files that will be not be included

setCleanCopy

public void setCleanCopy(boolean cleanCopy)

Toggles whether or not the workspace is required to be cleaned

setLineTerminator

public void setLineTerminator(String lineTerminator)

Sets the line terminator to apply when obtaining files from the Integrity Server

setRestoreTimestamp

public void setRestoreTimestamp(boolean restoreTimestamp)

Toggles whether or not to restore the timestamp for individual files

setSkipAuthorInfo

public void setSkipAuthorInfo(boolean skipAuthorInfo)

Toggles whether or not to use 'si revisioninfo' to determine author information

setCheckpointBeforeBuild

public void setCheckpointBeforeBuild(boolean checkpointBeforeBuild)

Toggles whether or not a checkpoint should be performed before the build

Parameters:

checkpointBeforeBuild -

setCheckpointLabel

public void setCheckpointLabel(String checkpointLabel)

Sets the label string for the checkpoint performed before the build

Parameters:

checkpointLabel -

setAlternateWorkspace

public void setAlternateWorkspace(String alternateWorkspace)

Sets an alternate workspace for the checkout directory

Parameters:

alternateWorkspace -

setFetchChangedWorkspaceFiles

public void setFetchChangedWorkspaceFiles(boolean fetchChangedWorkspaceFiles)

Toggles whether or not changed workspace files should be synchronized

Parameters:

fetchChangedWorkspaceFiles -

setDeleteNonMembers

public void setDeleteNonMembers(boolean deleteNonMembers)

Toggles whether or not non members should be deleted

Parameters:

deleteNonMembers -

setCheckoutThreadPoolSize

public void setCheckoutThreadPoolSize(int checkoutThreadPoolSize)

Sets the thread pool size of parallel checkout threads

Parameters:

checkoutThreadPoolSize -

setConfigurationName

public void setConfigurationName(String configurationName)

Sets the configuration name for this project

Parameters:

configurationName - Name for this project configuration

getIntegrityProject

public IntegrityCMProject getIntegrityProject()

Returns the Integrity Configuration Management Project

Returns:

findProject

public static IntegrityCMProject findProject(String configurationName)

hasProject

public static boolean hasProject(String configurationName)

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.AbstractBuild<?,?> build,
                                                 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

Specified by:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

IOException

InterruptedException

See Also:

SCM.calcRevisionsFromBuild(hudson.model.AbstractBuild, hudson.Launcher, hudson.model.TaskListener)

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Toggles whether or not a workspace is required for polling Since, we're using a Server Integration Point in the Integrity API, we do not require a workspace.

Overrides:

requiresWorkspaceForPolling in class hudson.scm.SCM

checkout

public boolean checkout(hudson.model.AbstractBuild<?,?> build,
               hudson.Launcher launcher,
               hudson.FilePath workspace,
               hudson.model.BuildListener listener,
               File changeLogFile)
                 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

Specified by:

checkout in class hudson.scm.SCM

Throws:

IOException

InterruptedException

See Also:

SCM.checkout(hudson.model.AbstractBuild, hudson.Launcher, hudson.FilePath, hudson.model.BuildListener, java.io.File)

compareRemoteRevisionWith

protected hudson.scm.PollingResult compareRemoteRevisionWith(hudson.model.AbstractProject<?,?> project,
                                                 hudson.Launcher launcher,
                                                 hudson.FilePath workspace,
                                                 hudson.model.TaskListener listener,
                                                 hudson.scm.SCMRevisionState _baseline)
                                                      throws IOException,
                                                             InterruptedException

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

Specified by:

compareRemoteRevisionWith in class hudson.scm.SCM

Throws:

IOException

InterruptedException

See Also:

SCM.compareRemoteRevisionWith(hudson.model.AbstractProject, hudson.Launcher, hudson.FilePath, hudson.model.TaskListener, hudson.scm.SCMRevisionState)

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Overridden createChangeLogParser function Creates a custom Integrity Change Log Parser, which compares two view project outputs

Specified by:

createChangeLogParser in class hudson.scm.SCM

See Also:

SCM.createChangeLogParser()

getDescriptor

public hudson.scm.SCMDescriptor<IntegritySCM> 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