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 normal Clearcase repositories.

Author:

Erik Ramfelt

Nested Class Summary

static class

ClearCaseSCM.ClearCaseScmDescriptor ClearCase SCM descriptor

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)

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.
protected CheckOutAction	createCheckOutAction(ClearToolLauncher launcher) Create a CheckOutAction that will be used by the checkout method.
protected PollAction	createPollAction(ClearToolLauncher launcher) Create a PollAction that will be used by the pollChanges() method.
java.lang.String	getBranch()
java.lang.String[]	getBranchNames() Split the branch names into a string array.
java.lang.String	getConfigSpec()
ClearCaseSCM.ClearCaseScmDescriptor	getDescriptor()
java.lang.String	getViewDrive()
java.lang.String	getVobPaths() Return the user configured vob paths that will be used when getting changes for a view.
boolean	isUseDynamicView()
boolean	isUseUpdate()

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

checkout, checkout, createChangeLogParser, createClearToolLauncher, getMkviewOptionalParam, getViewName, pollChanges, supportsPolling

Methods inherited from class hudson.scm.SCM

createEmptyChangeLog, getBrowser, getEffectiveBrowser, getModuleRoot, getModuleRoots, nullify, requiresWorkspaceForPolling

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)

Method Detail

getBranch

public java.lang.String getBranch()

getConfigSpec

public java.lang.String getConfigSpec()

isUseUpdate

public boolean isUseUpdate()

isUseDynamicView

public boolean isUseDynamicView()

getViewDrive

public java.lang.String getViewDrive()

getVobPaths

public java.lang.String getVobPaths()

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

Specified by:

getVobPaths in class AbstractClearCaseScm

Returns:

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

getDescriptor

public ClearCaseSCM.ClearCaseScmDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor 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

createCheckOutAction

protected CheckOutAction createCheckOutAction(ClearToolLauncher launcher)

Description copied from class: AbstractClearCaseScm

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

Specified by:

createCheckOutAction in class AbstractClearCaseScm

Parameters:

launcher - the command line launcher

Returns:

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

createPollAction

protected PollAction createPollAction(ClearToolLauncher launcher)

Description copied from class: AbstractClearCaseScm

Create a PollAction that will be used by the pollChanges() method.

Specified by:

createPollAction in class AbstractClearCaseScm

Parameters:

launcher - the command line launcher

Returns:

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

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)