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

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

ClearCaseSCM(java.lang.String branch, java.lang.String configspec, java.lang.String viewname, boolean useupdate, java.lang.String vobpaths, boolean usedynamicview, java.lang.String viewdrive, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean doNotUpdateConfigSpec, boolean rmviewonrename)

ClearCaseSCM(java.lang.String branch, java.lang.String configspec, java.lang.String viewname, boolean useupdate, java.lang.String vobpaths, boolean usedynamicview, java.lang.String viewdrive, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean doNotUpdateConfigSpec, boolean rmviewonrename, java.lang.String excludedRegions)

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.ChangeLogParser	createChangeLogParser()
protected CheckOutAction	createCheckOutAction(hudson.util.VariableResolver variableResolver, ClearToolLauncher launcher) Create a CheckOutAction that will be used by the checkout method.
protected ClearTool	createClearTool(hudson.util.VariableResolver variableResolver, ClearToolLauncher launcher)
protected HistoryAction	createHistoryAction(hudson.util.VariableResolver variableResolver, ClearToolLauncher launcher) 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() Split the branch names into a string array.
java.lang.String	getConfigSpec()
ClearCaseSCM.ClearCaseScmDescriptor	getDescriptor()
hudson.FilePath	getModuleRoot(hudson.FilePath workspace)
java.lang.String	getViewDrive()
java.lang.String[]	getViewPaths(hudson.FilePath viewPath) Return the view paths that will be used when getting changes for a view.
java.lang.String	getVobPaths()
boolean	isDoNotUpdateConfigSpec()
boolean	isUseDynamicView()

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

checkout, configureFilters, createAndRegisterListener, createClearToolLauncher, generateNormalizedViewName, getExcludedRegions, getExcludedRegionsNormalized, getMkviewOptionalParam, getNormalizedViewName, getViewName, isFilteringOutDestroySubBranchEvent, isRemoveViewOnRename, isUseUpdate, pollChanges, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling, setNormalizedViewName, supportsPolling

Methods inherited from class hudson.scm.SCM

_for, all, createEmptyChangeLog, getBrowser, getEffectiveBrowser, getModuleRoots, nullify

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 configspec,
                                         java.lang.String viewname,
                                         boolean useupdate,
                                         java.lang.String vobpaths,
                                         boolean usedynamicview,
                                         java.lang.String viewdrive,
                                         java.lang.String mkviewoptionalparam,
                                         boolean filterOutDestroySubBranchEvent,
                                         boolean doNotUpdateConfigSpec,
                                         boolean rmviewonrename,
                                         java.lang.String excludedRegions)

ClearCaseSCM

public ClearCaseSCM(java.lang.String branch,
                    java.lang.String configspec,
                    java.lang.String viewname,
                    boolean useupdate,
                    java.lang.String vobpaths,
                    boolean usedynamicview,
                    java.lang.String viewdrive,
                    java.lang.String mkviewoptionalparam,
                    boolean filterOutDestroySubBranchEvent,
                    boolean doNotUpdateConfigSpec,
                    boolean rmviewonrename)

Method Detail

getBranch

public java.lang.String getBranch()

getConfigSpec

public java.lang.String getConfigSpec()

isUseDynamicView

public boolean isUseDynamicView()

getViewDrive

public java.lang.String getViewDrive()

getVobPaths

public java.lang.String getVobPaths()

isDoNotUpdateConfigSpec

public boolean isDoNotUpdateConfigSpec()

getViewPaths

public java.lang.String[] getViewPaths(hudson.FilePath viewPath)
                                throws java.io.IOException,
                                       java.lang.InterruptedException

Return the view paths that will be used when getting changes for a view. If the user configured vob paths field is empty, then the folder within the view will be used as view paths.

Specified by:

getViewPaths in class AbstractClearCaseScm

Parameters:

viewPath - the file path for the view

Returns:

the view paths that will be used when getting changes for a view.

Throws:

java.io.IOException

java.lang.InterruptedException

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_VIEWNAME - The name of the clearcase view. CLEARCASE_VIEWPATH - The absolute path to the clearcase view.

Overrides:

buildEnvVars in class AbstractClearCaseScm

getModuleRoot

public hudson.FilePath getModuleRoot(hudson.FilePath workspace)

Overrides:

getModuleRoot in class AbstractClearCaseScm

createCheckOutAction

protected CheckOutAction createCheckOutAction(hudson.util.VariableResolver variableResolver,
                                              ClearToolLauncher launcher)

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.

createHistoryAction

protected HistoryAction createHistoryAction(hudson.util.VariableResolver variableResolver,
                                            ClearToolLauncher launcher)

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.

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()

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)

createClearTool

protected ClearTool createClearTool(hudson.util.VariableResolver variableResolver,
                                    ClearToolLauncher launcher)

Overrides:

createClearTool in class AbstractClearCaseScm