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

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, java.lang.String mkviewoptionalparam, boolean filterOutDestroySubBranchEvent)

Method Summary

protected ChangeLogAction	createChangeLogAction(ClearToolLauncher launcher, hudson.model.AbstractBuild<?,?> build) Create a ChangeLogAction that will be used to get the change logs for a CC repository
hudson.scm.ChangeLogParser	createChangeLogParser()
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.
protected SaveChangeLogAction	createSaveChangeLogAction(ClearToolLauncher launcher) Create a SaveChangeLog action that is used to save a change log
protected TaggingAction	createTaggingAction(ClearToolLauncher clearToolLauncher) Create a TaggingAction that will be used at the end of the build to tag the CC repository
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.
java.lang.String	getStream() Return the stream that is used to create the UCM view.
java.lang.String[]	getViewPaths(hudson.FilePath viewPath) Return string array containing the paths in the view that should be used when polling for changes.

Methods inherited from class hudson.plugins.clearcase.AbstractClearCaseScm

buildEnvVars, checkout, createClearTool, createClearToolLauncher, getMkviewOptionalParam, getModuleRoot, getNormalizedViewName, getViewName, isFilteringOutDestroySubBranchEvent, pollChanges, requiresWorkspaceForPolling, supportsPolling

Methods inherited from class hudson.scm.SCM

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,
                                            java.lang.String mkviewoptionalparam,
                                            boolean filterOutDestroySubBranchEvent)

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.

getDescriptor

public ClearCaseUcmSCM.ClearCaseUcmScmDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class AbstractClearCaseScm

createChangeLogParser

public hudson.scm.ChangeLogParser createChangeLogParser()

Overrides:

createChangeLogParser in class AbstractClearCaseScm

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

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.

createChangeLogAction

protected ChangeLogAction createChangeLogAction(ClearToolLauncher launcher,
                                                hudson.model.AbstractBuild<?,?> build)

Description copied from class: AbstractClearCaseScm

Create a ChangeLogAction that will be used to get the change logs for a CC repository

Specified by:

createChangeLogAction in class AbstractClearCaseScm

Parameters:

launcher - the command line launcher

build - the current build

Returns:

an action that returns the change logs for a CC 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

createTaggingAction

protected TaggingAction createTaggingAction(ClearToolLauncher clearToolLauncher)

Description copied from class: AbstractClearCaseScm

Create a TaggingAction that will be used at the end of the build to tag the CC repository

Specified by:

createTaggingAction in class AbstractClearCaseScm

Returns:

an action that can tag the CC repository; can be null.