net.praqma.hudson.scm

Class CCUCMScm

java.lang.Object

hudson.scm.SCM

net.praqma.hudson.scm.CCUCMScm

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>

public class CCUCMScm
extends SCM

is responsible for everything regarding Hudsons connection to ClearCase pre-build. This class defines all the files required by the user. The information can be entered on the config page.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CCUCMScm.CCUCMScmDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	HLINK_DEFAULT

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
CCUCMScm() Default constructor, mainly used for unit tests.
CCUCMScm(String loadModule, boolean newest, PollingMode mode, String stream, String treatUnstable, String nameTemplate, boolean forceDeliver, boolean recommend, boolean makeTag, boolean setDescription, String buildProject, boolean removeViewPrivateFiles, boolean trimmedChangeSet, boolean discard)
CCUCMScm(String component, String loadModule, boolean newest, PollingMode mode, String stream, String treatUnstable, String nameTemplate, boolean forceDeliver, boolean recommend, boolean makeTag, boolean setDescription, String buildProject, boolean removeViewPrivateFiles, boolean trimmedChangeSet, boolean discard) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	buildEnvVars(AbstractBuild<?,?> build, Map<String,String> env)
SCMRevisionState	calcRevisionsFromBuild(AbstractBuild<?,?> build, Launcher launcher, TaskListener listener)
boolean	checkout(AbstractBuild<?,?> build, Launcher launcher, FilePath workspace, BuildListener listener, File changelogFile)
PollingResult	compareRemoteRevisionWith(AbstractProject<?,?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState rstate) This method polls the version control system to see if there are any changes in the source code.
ChangeLogParser	createChangeLogParser()
void	ensurePublisher(AbstractBuild build)
void	generateChangeLog(AbstractBuild<?,?> build, CCUCMBuildAction state, BuildListener listener, File changelogFile, net.praqma.clearcase.ucm.view.SnapshotView snapshotView) Generate the change log for poll/sibling mode
String	getBaseline()
String	getBaselineValue(AbstractBuild<?,?> build)
String	getBuildProject()
String	getComponent()
boolean	getForceDeliver()
String	getHLinkFeedFrom()
static CCUCMBuildAction	getLastAction(AbstractProject<?,?> project) Returns the last CCUCMBuildAction, that has a valid Baseline
String	getLevelToPoll()
String	getLoadModule()
PollingMode	getMode()
boolean	getMultisitePolling()
String	getNameTemplate()
String	getPolling()
boolean	getSlavePolling()
String	getStream()
net.praqma.clearcase.ucm.entities.Stream	getStreamObject()
String	getTreatUnstable()
net.praqma.clearcase.ucm.view.SnapshotView	initializeDeliverView(AbstractBuild<?,?> build, CCUCMBuildAction state, BuildListener listener) Initialise the deliver view
boolean	isCreateBaseline()
boolean	isDiscard()
boolean	isMakeTag()
boolean	isRecommend()
boolean	isRemoveViewPrivateFiles()
boolean	isSetDescription()
boolean	isTrimmedChangeSet()
void	postCheckout(AbstractBuild<?,?> build, Launcher launcher, FilePath workspace, BuildListener listener)
void	printBaselines(List<net.praqma.clearcase.ucm.entities.Baseline> baselines, PrintStream ps)
Object	readResolve()
void	resolveBaselineInput(AbstractBuild<?,?> build, String baselineInput, CCUCMBuildAction action, BuildListener listener) Resolve the Baseline parameter and store the information in the Action
void	setAddPostBuild(boolean addPostBuild)
void	setDiscard(boolean discard)
void	setMode(PollingMode mode)
void	setMultisitePolling(boolean mp)
void	setStream(String stream)

Methods inherited from class hudson.scm.SCM

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

Methods inherited from class java.lang.Object

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

Field Detail

HLINK_DEFAULT

public static final String HLINK_DEFAULT

See Also:

Constant Field Values

Constructor Detail

CCUCMScm

public CCUCMScm()

Default constructor, mainly used for unit tests.

CCUCMScm

@DataBoundConstructor
public CCUCMScm(String loadModule,
                                      boolean newest,
                                      PollingMode mode,
                                      String stream,
                                      String treatUnstable,
                                      String nameTemplate,
                                      boolean forceDeliver,
                                      boolean recommend,
                                      boolean makeTag,
                                      boolean setDescription,
                                      String buildProject,
                                      boolean removeViewPrivateFiles,
                                      boolean trimmedChangeSet,
                                      boolean discard)

CCUCMScm

@Deprecated
public CCUCMScm(String component,
                            String loadModule,
                            boolean newest,
                            PollingMode mode,
                            String stream,
                            String treatUnstable,
                            String nameTemplate,
                            boolean forceDeliver,
                            boolean recommend,
                            boolean makeTag,
                            boolean setDescription,
                            String buildProject,
                            boolean removeViewPrivateFiles,
                            boolean trimmedChangeSet,
                            boolean discard)

Deprecated.

Method Detail

readResolve

public Object readResolve()

checkout

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

Overrides:

checkout in class SCM

Throws:

IOException

InterruptedException

postCheckout

public void postCheckout(AbstractBuild<?,?> build,
                         Launcher launcher,
                         FilePath workspace,
                         BuildListener listener)
                  throws IOException,
                         InterruptedException

Overrides:

postCheckout in class SCM

Throws:

IOException

InterruptedException

ensurePublisher

public void ensurePublisher(AbstractBuild build)
                     throws IOException

Throws:

IOException

setAddPostBuild

public void setAddPostBuild(boolean addPostBuild)

resolveBaselineInput

public void resolveBaselineInput(AbstractBuild<?,?> build,
                                 String baselineInput,
                                 CCUCMBuildAction action,
                                 BuildListener listener)
                          throws net.praqma.clearcase.exceptions.UnableToInitializeEntityException,
                                 IOException,
                                 InterruptedException

Resolve the Baseline parameter and store the information in the Action

Parameters:

build - The build to look for the baseline input

baselineInput - The Special CC_BASELINE environment variable

action - The action in which we store the baseline specified in the environment

listener - Listener

Throws:

net.praqma.clearcase.exceptions.UnableToInitializeEntityException - Thrown when cleartool cannot load the resolved input baseline

IOException - Thrown on system error or Jenkins failure

InterruptedException - Thrown on system error or Jenkins failure

getBaselineValue

public String getBaselineValue(AbstractBuild<?,?> build)

initializeDeliverView

public net.praqma.clearcase.ucm.view.SnapshotView initializeDeliverView(AbstractBuild<?,?> build,
                                                                        CCUCMBuildAction state,
                                                                        BuildListener listener)
                                                                 throws IOException,
                                                                        InterruptedException

Initialise the deliver view

Parameters:

build - Build

state - State

listener - Listener

Returns:

A SnapshotView in which we perform the deliver

Throws:

IOException - Thrown on system error

InterruptedException - Thrown on system error

generateChangeLog

public void generateChangeLog(AbstractBuild<?,?> build,
                              CCUCMBuildAction state,
                              BuildListener listener,
                              File changelogFile,
                              net.praqma.clearcase.ucm.view.SnapshotView snapshotView)
                       throws IOException,
                              InterruptedException

Generate the change log for poll/sibling mode

Parameters:

build - Build

state - State

listener - Listener

changelogFile - File

snapshotView - Snapshot view

Throws:

IOException - Generic system error

InterruptedException - Generic system error

createChangeLogParser

public ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class SCM

buildEnvVars

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

Overrides:

buildEnvVars in class SCM

compareRemoteRevisionWith

public PollingResult compareRemoteRevisionWith(AbstractProject<?,?> project,
                                               Launcher launcher,
                                               FilePath workspace,
                                               TaskListener listener,
                                               SCMRevisionState rstate)
                                        throws IOException,
                                               InterruptedException

This method polls the version control system to see if there are any changes in the source code.

Overrides:

compareRemoteRevisionWith in class SCM

Parameters:

project - Project

launcher - Launcher

workspace - Workspace

listener - Listener

rstate - RevisionState

Returns:

A PollingResult

Throws:

IOException - Generic system error

InterruptedException - Generic system error

getLastAction

public static CCUCMBuildAction getLastAction(AbstractProject<?,?> project)

Returns the last CCUCMBuildAction, that has a valid Baseline

Parameters:

project - Project

Returns:

An Action

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(AbstractBuild<?,?> build,
                                               Launcher launcher,
                                               TaskListener listener)
                                        throws IOException,
                                               InterruptedException

Overrides:

calcRevisionsFromBuild in class SCM

Throws:

IOException

InterruptedException

printBaselines

public void printBaselines(List<net.praqma.clearcase.ucm.entities.Baseline> baselines,
                           PrintStream ps)

getLevelToPoll

public String getLevelToPoll()

getComponent

public String getComponent()

getStream

public String getStream()

getLoadModule

public String getLoadModule()

getStreamObject

public net.praqma.clearcase.ucm.entities.Stream getStreamObject()

getBaseline

@Exported
public String getBaseline()

getSlavePolling

public boolean getSlavePolling()

getHLinkFeedFrom

public String getHLinkFeedFrom()

getMultisitePolling

public boolean getMultisitePolling()

getPolling

@Exported
public String getPolling()

getTreatUnstable

@Exported
public String getTreatUnstable()

getBuildProject

public String getBuildProject()

getForceDeliver

public boolean getForceDeliver()

isTrimmedChangeSet

public boolean isTrimmedChangeSet()

isRemoveViewPrivateFiles

public boolean isRemoveViewPrivateFiles()

isCreateBaseline

public boolean isCreateBaseline()

getNameTemplate

public String getNameTemplate()

isMakeTag

public boolean isMakeTag()

isSetDescription

public boolean isSetDescription()

isRecommend

public boolean isRecommend()

setMultisitePolling

public void setMultisitePolling(boolean mp)

isDiscard

public boolean isDiscard()

setDiscard

public void setDiscard(boolean discard)

getMode

public PollingMode getMode()

Returns:

the mode

setMode

public void setMode(PollingMode mode)

Parameters:

mode - the mode to set

setStream

public void setStream(String stream)

Parameters:

stream - the stream to set