hudson.plugins.clearcase

Class ClearCaseSCM

java.lang.Object

hudson.scm.SCM

hudson.plugins.clearcase.AbstractClearCaseScm

hudson.plugins.clearcase.ClearCaseSCM

All Implemented Interfaces:

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

public class ClearCaseSCM
extends AbstractClearCaseScm

Base ClearCase SCM. This SCM is for base ClearCase repositories.

Author:

Erik Ramfelt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClearCaseSCM.ClearCaseScmDescriptor ClearCase 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

Modifier and Type	Field and Description
static String	CLEARCASE_CSFILENAME_ENVSTR

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
ClearCaseSCM(String branch, String label, boolean extractConfigSpec, String configSpecFileName, boolean refreshConfigSpec, String refreshConfigSpecCommand, String configSpec, String viewTag, boolean useupdate, boolean extractLoadRules, String loadRules, boolean useOtherLoadRulesForPolling, String loadRulesForPolling, boolean usedynamicview, String viewdrive, String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean doNotUpdateConfigSpec, boolean rmviewonrename, String excludedRegions, String multiSitePollBuffer, boolean useTimeRule, boolean createDynView, String viewPath, AbstractClearCaseScm.ChangeSetLevel changeset, ViewStorage viewStorage)
ClearCaseSCM(String branch, String label, String configspec, String viewTag, boolean useupdate, String loadRules, boolean usedynamicview, String viewdrive, String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean doNotUpdateConfigSpec, boolean rmviewonrename)

Method Summary

Modifier and Type	Method and Description
void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, Map<String,String> env) Adds the env variable for the ClearCase SCMs.
Filter	configureFilters(hudson.util.VariableResolver<String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher)
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.
protected HistoryAction	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	getBranch()
String[]	getBranchNames(hudson.util.VariableResolver<String> variableResolver) Split the branch names into a string array.
String	getConfigSpec()
String	getConfigSpec(hudson.util.VariableResolver<String> variableResolver)
String	getConfigSpecFileName()
String	getConfigSpecFileName(hudson.util.VariableResolver<String> variableResolver)
ClearCaseSCM.ClearCaseScmDescriptor	getDescriptor()
String	getLabel()
String[]	getLabelNames(hudson.util.VariableResolver<String> variableResolver)
String	getRefreshConfigSpecCommand()
String	getRefreshConfigSpecCommand(hudson.util.VariableResolver<String> variableResolver)
protected boolean	hasNewConfigSpec(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher cclauncher)
protected void	inspectConfigAction(hudson.util.VariableResolver<String> variableResolver, ClearToolLauncher cclauncher) inspect config action that will be used by the checkout method.
boolean	isDoNotUpdateConfigSpec()
boolean	isExtractConfigSpec()
protected boolean	isFirstBuild(hudson.scm.SCMRevisionState baseline)
boolean	isRefreshConfigSpec()
boolean	isUseTimeRule()
String	setConfigSpec(String scpec)

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

calcRevisionsFromBuild, calcRevisionsFromPoll, checkout, compareRemoteRevisionWith, computeExtendedViewPath, createClearTool, createClearToolLauncher, generateNormalizedViewName, 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, getViewPaths, getViewPathsRegexp, getViewStorage, getViewStorageOrDefault, getWorkflow, invalidRevisionState, isCreateDynView, isExtractLoadRules, isFilteringOutDestroySubBranchEvent, isFreezeCode, isRecreateView, isRemoveViewOnRename, isUseDynamicView, isUseOtherLoadRulesForPolling, isUseUpdate, processWorkspaceBeforeDeletion, readResolve, 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

Field Detail

CLEARCASE_CSFILENAME_ENVSTR

public static final String CLEARCASE_CSFILENAME_ENVSTR

See Also:

Constant Field Values

Constructor Detail

ClearCaseSCM

@DataBoundConstructor
public ClearCaseSCM(String branch,
                                          String label,
                                          boolean extractConfigSpec,
                                          String configSpecFileName,
                                          boolean refreshConfigSpec,
                                          String refreshConfigSpecCommand,
                                          String configSpec,
                                          String viewTag,
                                          boolean useupdate,
                                          boolean extractLoadRules,
                                          String loadRules,
                                          boolean useOtherLoadRulesForPolling,
                                          String loadRulesForPolling,
                                          boolean usedynamicview,
                                          String viewdrive,
                                          String mkviewoptionalparam,
                                          boolean filterOutDestroySubBranchEvent,
                                          boolean doNotUpdateConfigSpec,
                                          boolean rmviewonrename,
                                          String excludedRegions,
                                          String multiSitePollBuffer,
                                          boolean useTimeRule,
                                          boolean createDynView,
                                          String viewPath,
                                          AbstractClearCaseScm.ChangeSetLevel changeset,
                                          ViewStorage viewStorage)

ClearCaseSCM

public ClearCaseSCM(String branch,
                    String label,
                    String configspec,
                    String viewTag,
                    boolean useupdate,
                    String loadRules,
                    boolean usedynamicview,
                    String viewdrive,
                    String mkviewoptionalparam,
                    boolean filterOutDestroySubBranchEvent,
                    boolean doNotUpdateConfigSpec,
                    boolean rmviewonrename)

Method Detail

buildEnvVars

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

Adds the env variable for the ClearCase SCMs.

• CLEARCASE_CSFILENAME - The name of the clearcase config spec file.

Overrides:

buildEnvVars in class AbstractClearCaseScm

configureFilters

public Filter configureFilters(hudson.util.VariableResolver<String> variableResolver,
                               hudson.model.AbstractBuild build,
                               hudson.Launcher launcher)
                        throws IOException,
                               InterruptedException

Overrides:

configureFilters in class AbstractClearCaseScm

Throws:

IOException

InterruptedException

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

getBranch

public String getBranch()

getBranchNames

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

Split the branch names into a string array.

Specified by:

getBranchNames in class AbstractClearCaseScm

Parameters:

branchString - string containing none or several branches

Returns:

a string array (never empty)

getConfigSpec

public String getConfigSpec()

getConfigSpec

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

getConfigSpecFileName

public String getConfigSpecFileName()

getConfigSpecFileName

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

getDescriptor

public ClearCaseSCM.ClearCaseScmDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.scm.SCM

getLabel

public String getLabel()

getLabelNames

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

getRefreshConfigSpecCommand

public String getRefreshConfigSpecCommand()

getRefreshConfigSpecCommand

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

isDoNotUpdateConfigSpec

public boolean isDoNotUpdateConfigSpec()

isExtractConfigSpec

public boolean isExtractConfigSpec()

isRefreshConfigSpec

public boolean isRefreshConfigSpec()

isUseTimeRule

public boolean isUseTimeRule()

setConfigSpec

public String setConfigSpec(String scpec)

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 HistoryAction 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

hasNewConfigSpec

protected boolean hasNewConfigSpec(hudson.util.VariableResolver<String> variableResolver,
                                   ClearToolLauncher cclauncher)
                            throws IOException,
                                   InterruptedException

Overrides:

hasNewConfigSpec in class AbstractClearCaseScm

Throws:

IOException

InterruptedException

inspectConfigAction

protected void inspectConfigAction(hudson.util.VariableResolver<String> variableResolver,
                                   ClearToolLauncher cclauncher)
                            throws IOException,
                                   InterruptedException

Description copied from class: AbstractClearCaseScm

inspect config action that will be used by the checkout method.

Overrides:

inspectConfigAction in class AbstractClearCaseScm

Throws:

IOException

InterruptedException

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