hudson.plugins.clearcase.action
Class AbstractCheckoutAction

java.lang.Object
  hudson.plugins.clearcase.action.AbstractCheckoutAction

All Implemented Interfaces:

CheckOutAction

Direct Known Subclasses:

SnapshotCheckoutAction, UcmSnapshotCheckoutAction

public abstract class AbstractCheckoutAction
extends java.lang.Object
implements CheckOutAction

Check out action that will check out files into a snapshot view.

Nested Class Summary

static class

AbstractCheckoutAction.LoadRulesDelta

Field Summary

protected ClearTool	cleartool
protected java.lang.String[]	loadRules
protected boolean	useUpdate
protected java.lang.String	viewPath

Constructor Summary

AbstractCheckoutAction(ClearTool cleartool, java.lang.String[] loadRules, boolean useUpdate, java.lang.String viewPath)

Method Summary

protected boolean	cleanAndCreateViewIfNeeded(hudson.FilePath workspace, java.lang.String viewTag, java.lang.String viewPath, java.lang.String streamSelector) Manages the re-creation of the view if needed.
protected AbstractCheckoutAction.LoadRulesDelta	getLoadRulesDelta(java.util.Set<java.lang.String> configSpecLoadRules, hudson.Launcher launcher)
boolean	isViewValid(hudson.Launcher launcher, hudson.FilePath workspace, java.lang.String viewTag)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.plugins.clearcase.action.CheckOutAction

checkout

Field Detail

cleartool

protected final ClearTool cleartool

loadRules

protected final java.lang.String[] loadRules

useUpdate

protected final boolean useUpdate

viewPath

protected final java.lang.String viewPath

Constructor Detail

AbstractCheckoutAction

public AbstractCheckoutAction(ClearTool cleartool,
                              java.lang.String[] loadRules,
                              boolean useUpdate,
                              java.lang.String viewPath)

Method Detail

isViewValid

public boolean isViewValid(hudson.Launcher launcher,
                           hudson.FilePath workspace,
                           java.lang.String viewTag)
                    throws java.io.IOException,
                           java.lang.InterruptedException

Specified by:

isViewValid in interface CheckOutAction

Throws:

java.io.IOException

java.lang.InterruptedException

cleanAndCreateViewIfNeeded

protected boolean cleanAndCreateViewIfNeeded(hudson.FilePath workspace,
                                             java.lang.String viewTag,
                                             java.lang.String viewPath,
                                             java.lang.String streamSelector)
                                      throws java.io.IOException,
                                             java.lang.InterruptedException

Manages the re-creation of the view if needed. If something exists but not referenced correctly as a view, it will be renamed and the view will be created

Parameters:

workspace - The job's workspace

viewTag - The view identifier on server. Must be unique on server

viewPath - The workspace relative path of the view

streamSelector - The stream selector, using streamName[@pvob] format

Returns:

true if a mkview has been done, false if a view existed and is reused

Throws:

java.io.IOException

java.lang.InterruptedException

getLoadRulesDelta

protected AbstractCheckoutAction.LoadRulesDelta getLoadRulesDelta(java.util.Set<java.lang.String> configSpecLoadRules,
                                                                  hudson.Launcher launcher)