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

SCM for ClearCaseUCM. This SCM will create a UCM view from a stream and apply a list of load rules to it.

Nested Class Summary

static class

ClearCaseUcmSCM.ClearCaseUcmScmDescriptor ClearCase UCM 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

ClearCaseUcmSCM(java.lang.String stream, java.lang.String loadrules, java.lang.String viewname, boolean usedynamicview, java.lang.String viewdrive, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean useUpdate, boolean rmviewonrename)

ClearCaseUcmSCM(java.lang.String stream, java.lang.String loadrules, java.lang.String viewname, boolean usedynamicview, java.lang.String viewdrive, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent, boolean useUpdate, boolean rmviewonrename, java.lang.String excludedRegions)

Method Summary

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[]	getBranchNames() Return string array containing the branch names that should be used when polling for changes.
ClearCaseUcmSCM.ClearCaseUcmScmDescriptor	getDescriptor()
java.lang.String	getLoadRules() Return the load rules for the UCM view.
hudson.FilePath	getModuleRoot(hudson.FilePath workspace)
java.lang.String	getStream() Return the stream that is used to create the UCM view.
java.lang.String	getViewDrive()
java.lang.String[]	getViewPaths(hudson.FilePath viewPath) Return string array containing the paths in the view that should be used when polling for changes.
boolean	isUseDynamicView()

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

buildEnvVars, 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

ClearCaseUcmSCM

@DataBoundConstructor
public ClearCaseUcmSCM(java.lang.String stream,
                                            java.lang.String loadrules,
                                            java.lang.String viewname,
                                            boolean usedynamicview,
                                            java.lang.String viewdrive,
                                            java.lang.String mkviewoptionalparam,
                                            boolean filterOutDestroySubBranchEvent,
                                            boolean useUpdate,
                                            boolean rmviewonrename,
                                            java.lang.String excludedRegions)

ClearCaseUcmSCM

public ClearCaseUcmSCM(java.lang.String stream,
                       java.lang.String loadrules,
                       java.lang.String viewname,
                       boolean usedynamicview,
                       java.lang.String viewdrive,
                       java.lang.String mkviewoptionalparam,
                       boolean filterOutDestroySubBranchEvent,
                       boolean useUpdate,
                       boolean rmviewonrename)

Method Detail

getLoadRules

public java.lang.String getLoadRules()

Return the load rules for the UCM view.

Returns:

string containing the load rules.

getStream

public java.lang.String getStream()

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

Returns:

string containing the stream selector.

isUseDynamicView

public boolean isUseDynamicView()

getViewDrive

public java.lang.String getViewDrive()

getDescriptor

public ClearCaseUcmSCM.ClearCaseUcmScmDescriptor 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

getBranchNames

public java.lang.String[] getBranchNames()

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

getViewPaths

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

Description copied from class: AbstractClearCaseScm

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

Specified by:

getViewPaths in class AbstractClearCaseScm

Parameters:

viewPath - the file path for the view

Returns:

string array that will be used by the lshistory command

Throws:

java.io.IOException

java.lang.InterruptedException

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

createClearTool

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

Overrides:

createClearTool in class AbstractClearCaseScm