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

static class

ClearCaseSCM.ClearCaseScmDescriptor ClearCase SCM descriptor

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

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

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

ClearCaseSCM(java.lang.String branch, java.lang.String label, java.lang.String configspec, java.lang.String viewTag, boolean useupdate, java.lang.String loadRules, boolean usedynamicview, java.lang.String viewdrive, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean doNotUpdateConfigSpec, boolean rmviewonrename, java.lang.String excludedRegions, java.lang.String multiSitePollBuffer, boolean useTimeRule, boolean createDynView, java.lang.String winDynStorageDir, java.lang.String unixDynStorageDir, java.lang.String viewPath)

Method Summary

void	buildEnvVars(hudson.model.AbstractBuild<?,?> build, java.util.Map<java.lang.String,java.lang.String> env) Adds the env variable for the ClearCase SCMs.
hudson.scm.SCMRevisionState	calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
hudson.scm.SCMRevisionState	calcRevisionsFromPoll(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
Filter	configureFilters(hudson.util.VariableResolver<java.lang.String> variableResolver, hudson.model.AbstractBuild build, hudson.Launcher launcher)
hudson.scm.ChangeLogParser	createChangeLogParser()
protected CheckOutAction	createCheckOutAction(hudson.util.VariableResolver<java.lang.String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build) Create a CheckOutAction that will be used by the checkout method.
protected ClearTool	createClearTool(hudson.util.VariableResolver<java.lang.String> variableResolver, ClearToolLauncher launcher)
protected HistoryAction	createHistoryAction(hudson.util.VariableResolver<java.lang.String> variableResolver, ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build) Create a HistoryAction that will be used by the pollChanges() and checkout() method.
protected SaveChangeLogAction	createSaveChangeLogAction(ClearToolLauncher launcher) Create a SaveChangeLog action that is used to save a change log
java.lang.String	getBranch()
java.lang.String[]	getBranchNames(hudson.util.VariableResolver<java.lang.String> variableResolver) Split the branch names into a string array.
java.lang.String	getConfigSpec()
ClearCaseSCM.ClearCaseScmDescriptor	getDescriptor()
java.lang.String	getLabel()
java.lang.String[]	getLabelNames(hudson.util.VariableResolver<java.lang.String> variableResolver)
boolean	isDoNotUpdateConfigSpec()
protected boolean	isFirstBuild(hudson.scm.SCMRevisionState baseline)
boolean	isUseTimeRule()

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

checkout, compareRemoteRevisionWith, createClearToolLauncher, generateNormalizedViewName, generateNormalizedViewName, generateNormalizedViewName, getBranchNames, getBuildComputer, getBuildTime, getCurrentComputer, getExcludedRegions, getExcludedRegionsNormalized, getLoadRules, getMkviewOptionalParam, getModuleRoot, getModuleRoot, getMultiSitePollBuffer, getNormalizedUnixDynStorageDir, getNormalizedViewName, getNormalizedViewPath, getNormalizedWinDynStorageDir, getUnixDynStorageDir, getViewDrive, getViewName, getViewName, getViewPath, getViewPath, getViewPaths, getViewPathsRegexp, getWinDynStorageDir, isCreateDynView, isFilteringOutDestroySubBranchEvent, isFreezeCode, isRecreateView, isRemoveViewOnRename, isUseDynamicView, isUseUpdate, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, setNormalizedViewName, setNormalizedViewPath, supportsPolling

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, all, createEmptyChangeLog, getApi, getBrowser, getEffectiveBrowser, getModuleRoots, getType, nullify, poll, pollChanges

Methods inherited from class java.lang.Object

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

Constructor Detail

ClearCaseSCM

@DataBoundConstructor
public ClearCaseSCM(java.lang.String branch,
                                         java.lang.String label,
                                         java.lang.String configspec,
                                         java.lang.String viewTag,
                                         boolean useupdate,
                                         java.lang.String loadRules,
                                         boolean usedynamicview,
                                         java.lang.String viewdrive,
                                         java.lang.String mkviewoptionalparam,
                                         boolean filterOutDestroySubBranchEvent,
                                         boolean doNotUpdateConfigSpec,
                                         boolean rmviewonrename,
                                         java.lang.String excludedRegions,
                                         java.lang.String multiSitePollBuffer,
                                         boolean useTimeRule,
                                         boolean createDynView,
                                         java.lang.String winDynStorageDir,
                                         java.lang.String unixDynStorageDir,
                                         java.lang.String viewPath)

ClearCaseSCM

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

Method Detail

getBranch

public java.lang.String getBranch()

getLabel

public java.lang.String getLabel()

getConfigSpec

public java.lang.String getConfigSpec()

isDoNotUpdateConfigSpec

public boolean isDoNotUpdateConfigSpec()

isUseTimeRule

public boolean isUseTimeRule()

getDescriptor

public ClearCaseSCM.ClearCaseScmDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.scm.SCM

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class hudson.scm.SCM

buildEnvVars

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

Description copied from class: AbstractClearCaseScm

Adds the env variable for the ClearCase SCMs.

• CLEARCASE_VIEWTAG - The clearcase view tag.
• CLEARCASE_VIEWNAME - The name of the clearcase view folder (relative to workspace).
• CLEARCASE_VIEWPATH - The absolute path to the clearcase view.

Overrides:

buildEnvVars in class AbstractClearCaseScm

createCheckOutAction

protected CheckOutAction createCheckOutAction(hudson.util.VariableResolver<java.lang.String> variableResolver,
                                              ClearToolLauncher launcher,
                                              hudson.model.AbstractBuild<?,?> build)
                                       throws java.io.IOException,
                                              java.lang.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:

java.io.IOException

java.lang.InterruptedException

createHistoryAction

protected HistoryAction createHistoryAction(hudson.util.VariableResolver<java.lang.String> variableResolver,
                                            ClearToolLauncher launcher,
                                            hudson.model.AbstractBuild<?,?> build)
                                     throws java.io.IOException,
                                            java.lang.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

Returns:

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

Throws:

java.io.IOException

java.lang.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

getBranchNames

public java.lang.String[] getBranchNames(hudson.util.VariableResolver<java.lang.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)

getLabelNames

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

configureFilters

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

Overrides:

configureFilters in class AbstractClearCaseScm

Throws:

java.io.IOException

java.lang.InterruptedException

createClearTool

protected ClearTool createClearTool(hudson.util.VariableResolver<java.lang.String> variableResolver,
                                    ClearToolLauncher launcher)

Overrides:

createClearTool in class AbstractClearCaseScm

isFirstBuild

protected boolean isFirstBuild(hudson.scm.SCMRevisionState baseline)

Specified by:

isFirstBuild in class AbstractClearCaseScm

calcRevisionsFromBuild

public hudson.scm.SCMRevisionState calcRevisionsFromBuild(hudson.model.AbstractBuild<?,?> build,
                                                          hudson.Launcher launcher,
                                                          hudson.model.TaskListener taskListener)
                                                   throws java.io.IOException,
                                                          java.lang.InterruptedException

Specified by:

calcRevisionsFromBuild in class hudson.scm.SCM

Throws:

java.io.IOException

java.lang.InterruptedException

calcRevisionsFromPoll

public hudson.scm.SCMRevisionState calcRevisionsFromPoll(hudson.model.AbstractBuild<?,?> build,
                                                         hudson.Launcher launcher,
                                                         hudson.model.TaskListener taskListener)
                                                  throws java.io.IOException,
                                                         java.lang.InterruptedException

Specified by:

calcRevisionsFromPoll in class AbstractClearCaseScm

Throws:

java.io.IOException

java.lang.InterruptedException