hudson.plugins.clearcase
Interface ClearTool

All Known Implementing Classes:

ClearToolDynamic, ClearToolDynamicUCM, ClearToolExec, ClearToolSnapshot

public interface ClearTool

Method Summary

java.lang.String	catcs(java.lang.String viewName) Retrieves the config spec for the specified view name
boolean	doesViewExist(java.lang.String viewName) Checks whether the given view tag already exists in the ClearCase region.
void	endView(java.lang.String viewName) Ends the view
ClearToolLauncher	getLauncher() Get the inner CLearToolLauncher.
java.util.Properties	getViewData(java.lang.String viewName) Gets the view UUID, for thorough view deletion.
void	logRedundantCleartoolError(java.lang.String[] cmd, java.lang.Exception ex)
java.io.Reader	lsactivity(java.lang.String activity, java.lang.String commandFormat, java.lang.String viewname) Lists activities .......(?)
java.lang.String	lscurrentview(java.lang.String viewPath) Given a relative path, return the associated view tag if it exists.
java.io.Reader	lshistory(java.lang.String format, java.util.Date lastBuildDate, java.lang.String viewName, java.lang.String branch, java.lang.String[] pathsInView) Returns Reader containing output from lshistory.
java.util.List<java.lang.String>	lsview(boolean onlyActiveDynamicViews) Lists view registry entries.
java.util.List<java.lang.String>	lsvob(boolean onlyMOunted) Lists VOB registry entries
void	mklabel(java.lang.String viewName, java.lang.String label) Attaches version labels to versions of elements
void	mkview(java.lang.String viewName, java.lang.String streamSelector) Creates and registers a view
void	mkview(java.lang.String viewName, java.lang.String streamSelector, java.lang.String defaultStorageDir) Creates and registers a view
void	mountVobs() Mounts all VOBs.
java.lang.String	pwv(java.lang.String viewName) Retrieves the canonical working directory for a given view.
void	rmview(java.lang.String viewName) Removes the view from a VOB
void	rmviewtag(java.lang.String viewName) Removes the view tag from the ClearCase registry - used when the view storage in the workspace has already been deleted.
void	rmviewUuid(java.lang.String viewUuid) Removes the view (as identified by UUID) from all VOBs
void	setcs(java.lang.String viewName, java.lang.String configSpec) Sets the config spec of the view
void	startView(java.lang.String viewTags) Starts or connects to a dynamic view's view_server process
void	syncronizeViewWithStream(java.lang.String viewName, java.lang.String stream) Syncronizes the Dynamic UCM view with the streams recomended baseline
void	unregisterView(java.lang.String viewUuid) Unregisters the view tag for a given UUID.
void	update(java.lang.String viewName, java.lang.String[] loadRules) Updates the elements in the view

Method Detail

getLauncher

ClearToolLauncher getLauncher()

Get the inner CLearToolLauncher.

Returns:

The inner CLearToolLauncher.

update

void update(java.lang.String viewName,
            java.lang.String[] loadRules)
            throws java.io.IOException,
                   java.lang.InterruptedException

Updates the elements in the view

Parameters:

viewName - the name of the view

loadRules - optional load rules, null if not used.

Throws:

java.io.IOException

java.lang.InterruptedException

endView

void endView(java.lang.String viewName)
             throws java.io.IOException,
                    java.lang.InterruptedException

Ends the view

Parameters:

viewName - the name of the view

Throws:

java.io.IOException

java.lang.InterruptedException

rmview

void rmview(java.lang.String viewName)
            throws java.io.IOException,
                   java.lang.InterruptedException

Removes the view from a VOB

Parameters:

viewName - the name of the view

Throws:

java.io.IOException

java.lang.InterruptedException

unregisterView

void unregisterView(java.lang.String viewUuid)
                    throws java.io.IOException,
                           java.lang.InterruptedException

Unregisters the view tag for a given UUID.

Parameters:

viewUuid - the unique identifier for the view.

Throws:

java.io.IOException

java.lang.InterruptedException

rmviewUuid

void rmviewUuid(java.lang.String viewUuid)
                throws java.io.IOException,
                       java.lang.InterruptedException

Removes the view (as identified by UUID) from all VOBs

Parameters:

viewUuid - the unique identifier for the view

Throws:

java.io.IOException

java.lang.InterruptedException

rmviewtag

void rmviewtag(java.lang.String viewName)
               throws java.io.IOException,
                      java.lang.InterruptedException

Removes the view tag from the ClearCase registry - used when the view storage in the workspace has already been deleted.

Parameters:

viewName - the name of the view

Throws:

java.io.IOException

java.lang.InterruptedException

mkview

void mkview(java.lang.String viewName,
            java.lang.String streamSelector)
            throws java.io.IOException,
                   java.lang.InterruptedException

Creates and registers a view

Parameters:

launcher - launcher for launching the command

viewName - the name of the view

streamSelector - optional stream selector, null if not used.

Throws:

java.io.IOException

java.lang.InterruptedException

mkview

void mkview(java.lang.String viewName,
            java.lang.String streamSelector,
            java.lang.String defaultStorageDir)
            throws java.io.IOException,
                   java.lang.InterruptedException

Creates and registers a view

Parameters:

launcher - launcher for launching the command

viewName - the name of the view

streamSelector - optional stream selector, null if not used.

Throws:

java.io.IOException

java.lang.InterruptedException

setcs

void setcs(java.lang.String viewName,
           java.lang.String configSpec)
           throws java.io.IOException,
                  java.lang.InterruptedException

Sets the config spec of the view

Parameters:

viewName - the name of the view

configSpec - the name of the file containing a config spec

Throws:

java.io.IOException

java.lang.InterruptedException

mklabel

void mklabel(java.lang.String viewName,
             java.lang.String label)
             throws java.io.IOException,
                    java.lang.InterruptedException

Attaches version labels to versions of elements

Parameters:

viewName - the name of the view

label - the label name

Throws:

java.io.IOException

java.lang.InterruptedException

lshistory

java.io.Reader lshistory(java.lang.String format,
                         java.util.Date lastBuildDate,
                         java.lang.String viewName,
                         java.lang.String branch,
                         java.lang.String[] pathsInView)
                         throws java.io.IOException,
                                java.lang.InterruptedException

Returns Reader containing output from lshistory.

Parameters:

format - format that should be used by the lshistory command

lastBuildDate - lists events recorded since (that is, at or after) the specified date-time

viewName - the name of the view

branch - the name of the branch to get history events for; if null then history events for all branches are listed

pathsInView - view paths that should be added to the lshistory command. The view paths must be relative.

Returns:

Reader containing output from command

Throws:

java.io.IOException

java.lang.InterruptedException

lsactivity

java.io.Reader lsactivity(java.lang.String activity,
                          java.lang.String commandFormat,
                          java.lang.String viewname)
                          throws java.io.IOException,
                                 java.lang.InterruptedException

Lists activities .......(?)

Returns:

reader containing command output

Throws:

java.lang.InterruptedException

java.io.IOException

lsview

java.util.List<java.lang.String> lsview(boolean onlyActiveDynamicViews)
                                        throws java.io.IOException,
                                               java.lang.InterruptedException

Lists view registry entries. This command needs to be run inside a view.

Parameters:

onlyActiveDynamicViews - true for only return active dynamic views; false all views are returned

Returns:

list of view names

Throws:

java.io.IOException

java.lang.InterruptedException

lscurrentview

java.lang.String lscurrentview(java.lang.String viewPath)
                               throws java.io.IOException,
                                      java.lang.InterruptedException

Given a relative path, return the associated view tag if it exists. Otherwise, it will return null

Returns:

Throws:

java.io.IOException

java.lang.InterruptedException

lsvob

java.util.List<java.lang.String> lsvob(boolean onlyMOunted)
                                       throws java.io.IOException,
                                              java.lang.InterruptedException

Lists VOB registry entries

Parameters:

onlyMOunted - true for only return mounted vobs; false all vobs are returned

Returns:

list of vob names

Throws:

java.io.IOException

java.lang.InterruptedException

doesViewExist

boolean doesViewExist(java.lang.String viewName)
                      throws java.io.IOException,
                             java.lang.InterruptedException

Checks whether the given view tag already exists in the ClearCase region.

Parameters:

viewName - the view tag to check

Returns:

true if the view tag exists, false otherwise.

Throws:

java.io.IOException

java.lang.InterruptedException

pwv

java.lang.String pwv(java.lang.String viewName)
                     throws java.io.IOException,
                            java.lang.InterruptedException

Retrieves the canonical working directory for a given view.

Parameters:

viewName - the view to use

Returns:

the return from "cleartool pwv"

Throws:

java.io.IOException

java.lang.InterruptedException

catcs

java.lang.String catcs(java.lang.String viewName)
                       throws java.io.IOException,
                              java.lang.InterruptedException

Retrieves the config spec for the specified view name

Parameters:

viewName - the name of the view

Returns:

a string containing the config spec

Throws:

java.io.IOException

java.lang.InterruptedException

startView

void startView(java.lang.String viewTags)
               throws java.io.IOException,
                      java.lang.InterruptedException

Starts or connects to a dynamic view's view_server process

Parameters:

viewTags - One or more currently registered view tags (that is, view tags visible to lsview).

Throws:

java.io.IOException

java.lang.InterruptedException

mountVobs

void mountVobs()
               throws java.io.IOException,
                      java.lang.InterruptedException

Mounts all VOBs.

Throws:

java.io.IOException

java.lang.InterruptedException

syncronizeViewWithStream

void syncronizeViewWithStream(java.lang.String viewName,
                              java.lang.String stream)
                              throws java.io.IOException,
                                     java.lang.InterruptedException

Syncronizes the Dynamic UCM view with the streams recomended baseline

Parameters:

viewName -

stream -

Throws:

java.io.IOException

java.lang.InterruptedException

getViewData

java.util.Properties getViewData(java.lang.String viewName)
                                 throws java.io.IOException,
                                        java.lang.InterruptedException

Gets the view UUID, for thorough view deletion.

Parameters:

viewName -

Throws:

java.io.IOException

java.lang.InterruptedException

logRedundantCleartoolError

void logRedundantCleartoolError(java.lang.String[] cmd,
                                java.lang.Exception ex)