hudson.plugins.clearcase

Class ClearCaseUcmSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.clearcase.AbstractClearCaseScm

hudson.plugins.clearcase.ClearCaseUcmSCM

All Implemented Interfaces:

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

public class ClearCaseUcmSCM
extends AbstractClearCaseScm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClearCaseUcmSCM.ClearCaseUcmScmDescriptor ClearCase UCM SCM descriptor

Nested classes/interfaces inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

AbstractClearCaseScm.AbstractClearCaseScmDescriptor<T extends AbstractClearCaseScm>, AbstractClearCaseScm.ChangeSetLevel

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

CLEARCASE_VIEWNAME_ENVSTR, CLEARCASE_VIEWPATH_ENVSTR, CLEARCASE_VIEWTAG_ENVSTR, REGEX_WHITESPACE

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
ClearCaseUcmSCM(String stream, String loadrules, String viewTag, boolean usedynamicview, String viewdrive, String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean useUpdate, boolean rmviewonrename) Deprecated.
ClearCaseUcmSCM(String stream, String loadrules, String viewTag, boolean usedynamicview, String viewdrive, String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean useUpdate, boolean rmviewonrename, String excludedRegions, String multiSitePollBuffer, String overrideBranchName, boolean createDynView, boolean freezeCode, boolean recreateView, boolean allocateViewName, String viewPath, boolean useManualLoadRules, AbstractClearCaseScm.ChangeSetLevel changeset, ViewStorage viewStorage, boolean buildFoundationBaseline)

Method Summary

Modifier and Type	Method and Description
hudson.scm.ChangeLogParser	createChangeLogParser()
protected CheckoutAction	createCheckOutAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build) Create a CheckOutAction that will be used by the checkout method.
ClearTool	createClearTool(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher)
ClearTool	createClearTool(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher)
protected UcmHistoryAction	createHistoryAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build, hudson.scm.SCMRevisionState baseline, boolean useRecurse) Create a HistoryAction that will be used by the pollChanges() and checkout() method.
protected hudson.scm.SCMRevisionState	createRevisionState(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener, Date date)
protected SaveChangeLogAction	createSaveChangeLogAction(ClearToolLauncher launcher) Create a SaveChangeLog action that is used to save a change log
String	generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver, String modViewName) Returns a normalized view name that will be used in cleartool commands.
String[]	getBranchNames(hudson.util.VariableResolver<String> variableResolver) Return string array containing the branch names that should be used when polling for changes.
ClearCaseUcmSCM.ClearCaseUcmScmDescriptor	getDescriptor()
String	getOverrideBranchName() Return the branch type used for changelog and polling.
String	getStream() Return the stream that is used to create the UCM view.
String	getStream(hudson.util.VariableResolver<String> variableResolver)
String[]	getViewPaths(hudson.util.VariableResolver<String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher, boolean forPolling) Return string array containing the paths in the view that should be used when polling for changes.
protected boolean	invalidRevisionState(hudson.scm.SCMRevisionState baseline)
boolean	isAllocateViewName()
boolean	isBuildFoundationBaseline()
protected boolean	isFirstBuild(hudson.scm.SCMRevisionState baseline)
boolean	isUseManualLoadRules()
Object	readResolve()
void	setAllocateViewName(boolean allocateViewName)
void	setBuildFoundationBaseline(boolean buildFoundationBaseline)

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

buildEnvVars, calcRevisionsFromBuild, calcRevisionsFromPoll, checkout, compareRemoteRevisionWith, computeExtendedViewPath, configureFilters, createClearToolLauncher, generateNormalizedViewName, generateNormalizedViewName, getBranchNames, getBuildComputer, getBuildTime, getChangeset, getCurrentComputer, getExcludedRegions, getExcludedRegionsNormalized, getLoadRules, getLoadRules, getLoadRules, getLoadRulesForPolling, getMkviewOptionalParam, getModuleRoot, getModuleRoot, getMultiSitePollBuffer, getNormalizedViewName, getNormalizedViewPath, getViewDrive, getViewName, getViewName, getViewPath, getViewPath, getViewPaths, getViewPathsRegexp, getViewStorage, getViewStorageOrDefault, getWorkflow, hasNewConfigSpec, inspectConfigAction, isCreateDynView, isExtractLoadRules, isFilteringOutDestroySubBranchEvent, isFreezeCode, isRecreateView, isRemoveViewOnRename, isUseDynamicView, isUseOtherLoadRulesForPolling, isUseUpdate, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, setChangeset, setExtendedViewPath, setLoadRules, setNormalizedViewName, setNormalizedViewPath, setViewStorage, setWorkflow, supportsPolling

Methods inherited from class hudson.scm.SCM

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClearCaseUcmSCM

@Deprecated
public ClearCaseUcmSCM(String stream,
                                   String loadrules,
                                   String viewTag,
                                   boolean usedynamicview,
                                   String viewdrive,
                                   String mkviewoptionalparam,
                                   boolean filterOutDestroySubBranchEvent,
                                   boolean useUpdate,
                                   boolean rmviewonrename)

Deprecated.

ClearCaseUcmSCM

@DataBoundConstructor
public ClearCaseUcmSCM(String stream,
                                             String loadrules,
                                             String viewTag,
                                             boolean usedynamicview,
                                             String viewdrive,
                                             String mkviewoptionalparam,
                                             boolean filterOutDestroySubBranchEvent,
                                             boolean useUpdate,
                                             boolean rmviewonrename,
                                             String excludedRegions,
                                             String multiSitePollBuffer,
                                             String overrideBranchName,
                                             boolean createDynView,
                                             boolean freezeCode,
                                             boolean recreateView,
                                             boolean allocateViewName,
                                             String viewPath,
                                             boolean useManualLoadRules,
                                             AbstractClearCaseScm.ChangeSetLevel changeset,
                                             ViewStorage viewStorage,
                                             boolean buildFoundationBaseline)

Method Detail

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

createClearTool

public ClearTool createClearTool(hudson.model.AbstractBuild<?,?> build,
                                 hudson.Launcher launcher)
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

createClearTool

public ClearTool createClearTool(hudson.util.VariableResolver<String> variableResolver,
                                 ClearToolLauncher launcher)

Overrides:

createClearTool in class AbstractClearCaseScm

generateNormalizedViewName

public String generateNormalizedViewName(hudson.util.VariableResolver<String> variableResolver,
                                         String modViewName)

Description copied from class: AbstractClearCaseScm

Returns a normalized view name that will be used in cleartool commands.

It will replace :

• ${NODE_NAME} with the name of the node
• ${JOB_NAME} with the name of the job
• ${USER_NAME} with the name of the user

This way it will be easier to add new jobs without trying to find an unique view name. It will also replace invalid chars from a view name.

Overrides:

generateNormalizedViewName in class AbstractClearCaseScm

Returns:

a string containing no invalid chars.

getBranchNames

public String[] getBranchNames(hudson.util.VariableResolver<String> variableResolver)

Description copied from class: AbstractClearCaseScm

Return string array containing the branch names that should be used when polling for changes.

Specified by:

getBranchNames in class AbstractClearCaseScm

Returns:

a string array, can not be empty

getDescriptor

public ClearCaseUcmSCM.ClearCaseUcmScmDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.scm.SCM>

Overrides:

getDescriptor in class hudson.scm.SCM

getOverrideBranchName

public String getOverrideBranchName()

Return the branch type used for changelog and polling. By default this will be the empty string, and the stream will be split to get the branch.

Returns:

string containing the branch type.

getStream

public String getStream()

Return the stream that is used to create the UCM view.

Returns:

string containing the stream selector.

getStream

public String getStream(hudson.util.VariableResolver<String> variableResolver)

getViewPaths

public String[] getViewPaths(hudson.util.VariableResolver<String> variableResolver,
                             hudson.model.AbstractBuild build,
                             hudson.Launcher launcher,
                             boolean forPolling)
                      throws IOException,
                             InterruptedException

Description copied from class: AbstractClearCaseScm

Return string array containing the paths in the view that should be used when polling for changes.

Overrides:

getViewPaths in class AbstractClearCaseScm

Parameters:

variableResolver - [anb0s: HUDSON-8497]

build - TODO

launcher - TODO

forPolling - used for polling?

Returns:

string array that will be used by the lshistory command and for constructing the config spec, etc.

Throws:

IOException

InterruptedException

isAllocateViewName

public boolean isAllocateViewName()

isBuildFoundationBaseline

public boolean isBuildFoundationBaseline()

isUseManualLoadRules

public boolean isUseManualLoadRules()

readResolve

public Object readResolve()

Overrides:

readResolve in class AbstractClearCaseScm

setAllocateViewName

public void setAllocateViewName(boolean allocateViewName)

setBuildFoundationBaseline

public void setBuildFoundationBaseline(boolean buildFoundationBaseline)

createCheckOutAction

protected CheckoutAction createCheckOutAction(hudson.util.VariableResolver<String> variableResolver,
                                              ClearToolLauncher launcher,
                                              hudson.model.AbstractBuild<?,?> build)
                                       throws IOException,
                                              InterruptedException

Description copied from class: AbstractClearCaseScm

Create a CheckOutAction that will be used by the checkout method.

Specified by:

createCheckOutAction in class AbstractClearCaseScm

launcher - the command line launcher

Returns:

an action that can check out code from a ClearCase repository.

Throws:

IOException

InterruptedException

createHistoryAction

protected UcmHistoryAction createHistoryAction(hudson.util.VariableResolver<String> variableResolver,
                                               ClearToolLauncher launcher,
                                               hudson.model.AbstractBuild<?,?> build,
                                               hudson.scm.SCMRevisionState baseline,
                                               boolean useRecurse)
                                        throws IOException,
                                               InterruptedException

Description copied from class: AbstractClearCaseScm

Create a HistoryAction that will be used by the pollChanges() and checkout() method.

Specified by:

createHistoryAction in class AbstractClearCaseScm

launcher - the command line launcher

build - the current build if applicable

baseline - the baseline for comparison

useRecurse - whether to use the -recurse option in cleartool to call lshistory

Returns:

an action that can poll if there are any changes a ClearCase repository. Never null.

Throws:

IOException

InterruptedException

createSaveChangeLogAction

protected SaveChangeLogAction createSaveChangeLogAction(ClearToolLauncher launcher)

Description copied from class: AbstractClearCaseScm

Create a SaveChangeLog action that is used to save a change log

Specified by:

createSaveChangeLogAction in class AbstractClearCaseScm

Parameters:

launcher - the command line launcher

Returns:

an action that can save a change log to the Hudson changlog file

invalidRevisionState

protected boolean invalidRevisionState(hudson.scm.SCMRevisionState baseline)

Overrides:

invalidRevisionState in class AbstractClearCaseScm

isFirstBuild

protected boolean isFirstBuild(hudson.scm.SCMRevisionState baseline)

Specified by:

isFirstBuild in class AbstractClearCaseScm

createRevisionState

protected hudson.scm.SCMRevisionState createRevisionState(hudson.model.AbstractBuild<?,?> build,
                                                          hudson.Launcher launcher,
                                                          hudson.model.TaskListener taskListener,
                                                          Date date)
                                                   throws IOException,
                                                          InterruptedException

Overrides:

createRevisionState in class AbstractClearCaseScm

Throws:

IOException

InterruptedException