hudson.plugins.clearcase.action

Class SnapshotCheckoutAction

java.lang.Object

hudson.plugins.clearcase.action.CheckoutAction

hudson.plugins.clearcase.action.SnapshotCheckoutAction

Direct Known Subclasses:

BaseSnapshotCheckoutAction, UcmSnapshotCheckoutAction

public abstract class SnapshotCheckoutAction
extends CheckoutAction

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnapshotCheckoutAction.LoadRulesDelta

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	loadRules
protected boolean	useUpdate
protected String	viewPath

Constructor Summary

Constructors

Constructor and Description
SnapshotCheckoutAction(ClearTool cleartool, String[] loadRules, boolean useUpdate, String viewPath, ViewStorage viewStorage)

Method Summary

Modifier and Type	Method and Description
protected boolean	cleanAndCreateViewIfNeeded(hudson.FilePath workspace, String jobViewTag, String viewPath, String streamSelector) Manages the re-creation of the view if needed.
protected boolean	cleanIfRequiredAndReturnTrueIfViewCreationRequired(String jobViewTag, String viewPath, ClearTool ct, hudson.model.TaskListener listener, hudson.FilePath workspace)
protected void	createView(ClearTool ct, String viewTag, String viewPath, String streamSelector)
protected SnapshotCheckoutAction.LoadRulesDelta	getLoadRulesDelta(Set<String> configSpecLoadRules, hudson.Launcher launcher)
boolean	isViewValid(hudson.FilePath workspace, String viewTag)
boolean	isViewValid(hudson.Launcher launcher, hudson.FilePath workspace, String viewTag) Deprecated. Use isViewValid(FilePath,String) instead

Methods inherited from class hudson.plugins.clearcase.action.CheckoutAction

checkout, getCleartool, getUpdtFile, getViewStorage

Methods inherited from class java.lang.Object

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

Field Detail

loadRules

protected final String[] loadRules

useUpdate

protected final boolean useUpdate

viewPath

protected final String viewPath

Constructor Detail

SnapshotCheckoutAction

public SnapshotCheckoutAction(ClearTool cleartool,
                              String[] loadRules,
                              boolean useUpdate,
                              String viewPath,
                              ViewStorage viewStorage)

Method Detail

isViewValid

public boolean isViewValid(hudson.FilePath workspace,
                           String viewTag)
                    throws IOException,
                           InterruptedException

Specified by:

isViewValid in class CheckoutAction

Throws:

IOException

InterruptedException

isViewValid

@Deprecated
public boolean isViewValid(hudson.Launcher launcher,
                                       hudson.FilePath workspace,
                                       String viewTag)
                                throws IOException,
                                       InterruptedException

Deprecated. Use isViewValid(FilePath,String) instead

Overrides:

isViewValid in class CheckoutAction

Throws:

IOException

InterruptedException

cleanAndCreateViewIfNeeded

protected boolean cleanAndCreateViewIfNeeded(hudson.FilePath workspace,
                                             String jobViewTag,
                                             String viewPath,
                                             String streamSelector)
                                      throws IOException,
                                             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

jobViewTag - 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:

IOException

InterruptedException

cleanIfRequiredAndReturnTrueIfViewCreationRequired

protected boolean cleanIfRequiredAndReturnTrueIfViewCreationRequired(String jobViewTag,
                                                                     String viewPath,
                                                                     ClearTool ct,
                                                                     hudson.model.TaskListener listener,
                                                                     hudson.FilePath workspace)
                                                              throws IOException,
                                                                     InterruptedException

Throws:

IOException

InterruptedException

createView

protected void createView(ClearTool ct,
                          String viewTag,
                          String viewPath,
                          String streamSelector)
                   throws IOException,
                          InterruptedException

Throws:

IOException

InterruptedException

getLoadRulesDelta

protected SnapshotCheckoutAction.LoadRulesDelta getLoadRulesDelta(Set<String> configSpecLoadRules,
                                                                  hudson.Launcher launcher)