hudson.plugins.clearcase

Interface ClearTool

All Known Implementing Classes:

ClearToolDynamic, ClearToolExec, ClearToolSnapshot

public interface ClearTool

Abstraction to cleartool commands

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClearTool.DefaultPromotionLevel
static class	ClearTool.DiffBlOptions
static class	ClearTool.SetcsOption

Method Summary

Modifier and Type	Method and Description
String	catcs(String viewTag) Retrieves the config spec for the specified view name
Reader	describe(String format, String objectSelector) Call the cleartool describe with the provided format on the specified object selector See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options
Reader	describe(String format, String[] objectSelectors) Call the cleartool describe with the provided format on the specified object selectors See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options
Reader	describe(String format, String viewPath, String objectSelector) Call the cleartool describe with the provided format on the specified object selector See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options
Reader	diffbl(EnumSet<ClearTool.DiffBlOptions> options, String baseline1, String baseline2, String viewPath) Call diffbl using the two provided baselines (can be stream or baseline)
boolean	doesSetcsSupportOverride()
boolean	doesStreamExist(String streamSelector)
boolean	doesViewExist(String viewTag) Checks whether the given view tag already exists in the ClearCase region.
void	endView(String viewTag) Ends the view
void	endViewServer(String viewTag) Ends the view, with -server option
ClearToolLauncher	getLauncher() Get the inner CLearToolLauncher.
Properties	getViewData(String viewTag) Gets the view UUID, for thorough view deletion.
boolean	lock(String comment, String objectSelector) Lock an object.
void	logRedundantCleartoolError(String[] cmd, Exception ex)
Reader	lsactivity(String activity, String commandFormat, String viewPath) Call lsactivity (see on Rational ClearCase Commands Reference for details)
Reader	lsactivityIn(String streamSelector, String commandFormat, String viewPath)
String	lsbl(String baselineName, String format) List attributes of a baseline
String	lscurrentview(String viewPath) Given a relative path, return the associated view tag if it exists.
LsHistoryCommand	lshistory() Returns a lsHistoryCommand to prepare execution of a cleartool lshistory
Reader	lshistory(String format, Date lastBuildDate, String viewPath, String branch, String[] pathsInView, boolean getMinor) Deprecated. use ClearTool#lshistory(LsHistoryParameters) instead.
Reader	lshistory(String format, Date lastBuildDate, String viewPath, String branch, String[] pathsInView, boolean getMinor, boolean useRecurse) Deprecated. use ClearTool#lshistory(LsHistoryParameters) instead.
String	lsproject(String viewTag, String format) List attributes of a project
String	lsstream(String stream, String viewTag, String format) List attributes of a stream
List<String>	lsview(boolean onlyActiveDynamicViews) Lists view registry entries.
List<String>	lsvob(boolean onlyMounted) Lists VOB registry entries
List<Baseline>	mkbl(String name, String viewTag, String comment, boolean fullBaseline, boolean identical, List<String> components, String dDependOn, String aDependOn) Creates a new baseline
void	mklabel(String viewPath, String label) Attaches version labels to versions of elements
void	mkstream(String parentStream, String stream) Make a new stream
void	mkview(MkViewParameters params)
void	mkview(String viewPath, String viewTag, String streamSelector) Creates and registers a view
void	mkview(String viewPath, String viewTag, String streamSelector, String defaultStorageDir) Creates and registers a view
void	mountVobs() Mounts all VOBs.
String	pwv(String viewPath) Retrieves the canonical working directory for a given view.
void	rebaseDynamic(String viewTag, String baseline) Rebase a dynamic view
void	recommendBaseline(String streamSelector) Recommend the latest baselines on the stream that matches the minimum promotion level of the stream
void	rmtag(String tag) Removes a view tag or a VOB tag from the networkwide storage registry
void	rmview(String viewPath) Removes the view from a VOB
void	rmviewtag(String viewTag) Removes the view tag from the ClearCase registry - used when the view storage in the workspace has already been deleted.
void	rmviewUuid(String viewUuid) Removes the view (as identified by UUID) from all VOBs
void	setBaselinePromotionLevel(String baselineName, ClearTool.DefaultPromotionLevel promotionLevel)
void	setBaselinePromotionLevel(String baselineName, String promotionLevel) Set the baseline promotion level to the given level.
void	setcs(String viewPath, ClearTool.SetcsOption option, String configSpec) Deprecated. use setcs2 instead.
CleartoolUpdateResult	setcs2(String viewPath, ClearTool.SetcsOption current, String configSpec) Sets the config spec of the view
void	setcsTag(String viewTag, ClearTool.SetcsOption option, String configSpec) Synchronizes the Dynamic UCM view with the streams recommended baseline
void	startView(String viewTags) Starts or connects to a dynamic view's view_server process
void	unlock(String comment, String objectSelector) Unlock an object
void	unregisterView(String viewUuid) Unregisters the view tag for a given UUID.
void	update(String viewPath, String[] loadRules) Deprecated. use update2 instead
CleartoolUpdateResult	update2(String viewPath, String[] loadRules) Updates the elements in the view
CleartoolVersion	version()

Method Detail

getLauncher

ClearToolLauncher getLauncher()

Get the inner CLearToolLauncher.

Returns:

The inner CLearToolLauncher.

lsbl

String lsbl(String baselineName,
            String format)
     throws IOException,
            InterruptedException

List attributes of a baseline

Parameters:

baselineName -

format -

Returns:

Throws:

IOException

InterruptedException

catcs

String catcs(String viewTag)
      throws IOException,
             InterruptedException

Retrieves the config spec for the specified view name

Parameters:

viewTag - The view tag the client want the config spec for.

Returns:

a string containing the config spec

Throws:

IOException

InterruptedException

describe

Reader describe(String format,
                String objectSelector)
         throws IOException,
                InterruptedException

Call the cleartool describe with the provided format on the specified object selector See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options

Parameters:

format -

objectSelector -

Returns:

A reader to the command output

Throws:

IOException - If cleartool throws an error code

InterruptedException - If the process is interrupted

Since:

1.3

describe

Reader describe(String format,
                String viewPath,
                String objectSelector)
         throws IOException,
                InterruptedException

Call the cleartool describe with the provided format on the specified object selector See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options

Parameters:

format -

viewPath -

objectSelector -

Returns:

A reader to the command output

Throws:

IOException - If cleartool throws an error code

InterruptedException - If the process is interrupted

Since:

1.3

describe

Reader describe(String format,
                String[] objectSelectors)
         throws IOException,
                InterruptedException

Call the cleartool describe with the provided format on the specified object selectors See http://www.ipnom.com/ClearCase-Commands/describe.html for valid options

Parameters:

format -

viewPath -

objectSelectors -

Returns:

A reader to the command output

Throws:

IOException - If cleartool throws an error code

InterruptedException - If the process is interrupted

Since:

1.3

diffbl

Reader diffbl(EnumSet<ClearTool.DiffBlOptions> options,
              String baseline1,
              String baseline2,
              String viewPath)
       throws IOException

Call diffbl using the two provided baselines (can be stream or baseline)

Parameters:

options - see http://www.ipnom.com/ClearCase-Commands/diffbl.html

baseline1 -

baseline2 -

viewPath - A view path name needed to retrieve versions from

Returns:

Throws:

IOException - if unable to do I/O operations

doesSetcsSupportOverride

boolean doesSetcsSupportOverride()
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

doesStreamExist

boolean doesStreamExist(String streamSelector)
                 throws IOException,
                        InterruptedException

Parameters:

streamSelector -

Returns:

true if the specified stream exists

Throws:

IOException

InterruptedException

doesViewExist

boolean doesViewExist(String viewTag)
               throws IOException,
                      InterruptedException

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

Parameters:

viewTag - the view tag to check

Returns:

true if the view tag exists, false otherwise.

Throws:

IOException

InterruptedException

endView

void endView(String viewTag)
      throws IOException,
             InterruptedException

Ends the view

Parameters:

viewTag - the view tag

Throws:

IOException

InterruptedException

endViewServer

void endViewServer(String viewTag)
            throws IOException,
                   InterruptedException

Ends the view, with -server option

Parameters:

viewTag - the view tag

Throws:

IOException

InterruptedException

getViewData

Properties getViewData(String viewTag)
                throws IOException,
                       InterruptedException

Gets the view UUID, for thorough view deletion.

Parameters:

viewTag -

Throws:

IOException

InterruptedException

lock

boolean lock(String comment,
             String objectSelector)
      throws IOException,
             InterruptedException

Lock an object. See http://www.ipnom.com/ClearCase-Commands/lock.html

Parameters:

comment - Can be null

objectSelector - Object select. Cannot be null

Returns:

true if the lock succeeded.

Throws:

IOException

InterruptedException

logRedundantCleartoolError

void logRedundantCleartoolError(String[] cmd,
                                Exception ex)

lsactivity

Reader lsactivity(String activity,
                  String commandFormat,
                  String viewPath)
           throws IOException,
                  InterruptedException

Call lsactivity (see on Rational ClearCase Commands Reference for details)

Parameters:

activity - Specifies one or more activities to list.
You can specify an activity as a simple name or as an object selector of the form [activity]:name@vob-selector, where vob-selector specifies a project VOB (see the cleartool reference page).
If you specify a simple name and the current directory is not a project VOB, this command assumes that the activity resides in the project VOB associated with the stream attached to the current view.
If the current directory is a project VOB, that project VOB is the context for identifying the activity.

commandFormat - The output format to be used (-fmt <commandFormat>)

viewPath - view path name to use in order to list activity

Returns:

A reader to the lsactivity command output

Throws:

IOException

InterruptedException

lsactivityIn

Reader lsactivityIn(String streamSelector,
                    String commandFormat,
                    String viewPath)
             throws IOException,
                    InterruptedException

Throws:

IOException

InterruptedException

lscurrentview

String lscurrentview(String viewPath)
              throws IOException,
                     InterruptedException

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

Returns:

Throws:

IOException

InterruptedException

lshistory

LsHistoryCommand lshistory()
                    throws IOException,
                           InterruptedException

Returns a lsHistoryCommand to prepare execution of a cleartool lshistory

Throws:

IOException

InterruptedException

Since:

1.4

lshistory

@Deprecated
Reader lshistory(String format,
                             Date lastBuildDate,
                             String viewPath,
                             String branch,
                             String[] pathsInView,
                             boolean getMinor)
                      throws IOException,
                             InterruptedException

Deprecated. use ClearTool#lshistory(LsHistoryParameters) instead.

Throws:

IOException

InterruptedException

lshistory

@Deprecated
Reader lshistory(String format,
                             Date lastBuildDate,
                             String viewPath,
                             String branch,
                             String[] pathsInView,
                             boolean getMinor,
                             boolean useRecurse)
                      throws IOException,
                             InterruptedException

Deprecated. use ClearTool#lshistory(LsHistoryParameters) instead.

Throws:

IOException

InterruptedException

lsproject

String lsproject(String viewTag,
                 String format)
          throws InterruptedException,
                 IOException

List attributes of a project

Parameters:

viewTag - View tag of a view attached to a stream of the project

format -

Returns:

Throws:

InterruptedException

IOException

lsstream

String lsstream(String stream,
                String viewTag,
                String format)
         throws IOException,
                InterruptedException

List attributes of a stream

Parameters:

stream - TODO

viewTag - The view tag of a view on the wanted stream

format -

Returns:

Throws:

IOException

InterruptedException

lsview

List<String> lsview(boolean onlyActiveDynamicViews)
             throws IOException,
                    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:

IOException

InterruptedException

lsvob

List<String> lsvob(boolean onlyMounted)
            throws IOException,
                   InterruptedException

Lists VOB registry entries

Parameters:

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

Returns:

list of vob names

Throws:

IOException

InterruptedException

mkbl

List<Baseline> mkbl(String name,
                    String viewTag,
                    String comment,
                    boolean fullBaseline,
                    boolean identical,
                    List<String> components,
                    String dDependOn,
                    String aDependOn)
             throws IOException,
                    InterruptedException

Creates a new baseline

Parameters:

name - The base name for the baseline

viewTag - The view from which to create baseline. Baselines are created in the stream linked to this view

comment -

fullBaseline -

identical -

components -

dDependOn - TODO

aDependOn - TODO

Returns:

Throws:

IOException

InterruptedException

mklabel

void mklabel(String viewPath,
             String label)
      throws IOException,
             InterruptedException

Attaches version labels to versions of elements

Parameters:

viewPath - The view path name (relative to the workspace)

label - the label name

Throws:

IOException

InterruptedException

mkstream

void mkstream(String parentStream,
              String stream)
       throws IOException,
              InterruptedException

Make a new stream

Parameters:

parentStream - The parent stream name

stream - The new stream name

Throws:

IOException

InterruptedException

mkview

void mkview(MkViewParameters params)
     throws IOException,
            InterruptedException

Throws:

IOException

InterruptedException

mkview

void mkview(String viewPath,
            String viewTag,
            String streamSelector)
     throws IOException,
            InterruptedException

Creates and registers a view

Parameters:

viewPath - The view path name (relative to the workspace)

viewTag - the name of the view

streamSelector - optional stream selector, null if not used.

launcher - launcher for launching the command

Throws:

IOException

InterruptedException

mkview

void mkview(String viewPath,
            String viewTag,
            String streamSelector,
            String defaultStorageDir)
     throws IOException,
            InterruptedException

Creates and registers a view

Parameters:

viewPath - The view path name (relative to the workspace)

viewTag - The view tag (unique server identifier for the view)

streamSelector - optional stream selector, null if not used.

launcher - launcher for launching the command

Throws:

IOException

InterruptedException

mountVobs

void mountVobs()
        throws IOException,
               InterruptedException

Mounts all VOBs.

Throws:

IOException

InterruptedException

pwv

String pwv(String viewPath)
    throws IOException,
           InterruptedException

Retrieves the canonical working directory for a given view.

Parameters:

viewPath - The view path to use to execute pwv

Returns:

the return from "cleartool pwv"

Throws:

IOException

InterruptedException

rebaseDynamic

void rebaseDynamic(String viewTag,
                   String baseline)
            throws IOException,
                   InterruptedException

Rebase a dynamic view

Parameters:

viewTag - the view to rebase. It must be a dynamic view

baseline - The new foundation baseline to use

Throws:

IOException

InterruptedException

recommendBaseline

void recommendBaseline(String streamSelector)
                throws IOException,
                       InterruptedException

Recommend the latest baselines on the stream that matches the minimum promotion level of the stream

Parameters:

streamSelector -

Throws:

IOException

InterruptedException

rmtag

void rmtag(String tag)
    throws IOException,
           InterruptedException

Removes a view tag or a VOB tag from the networkwide storage registry

Parameters:

tag -

Throws:

IOException

InterruptedException

rmview

void rmview(String viewPath)
     throws IOException,
            InterruptedException

Removes the view from a VOB

Parameters:

viewPath - The path used for the view

Throws:

IOException

InterruptedException

rmviewtag

void rmviewtag(String viewTag)
        throws IOException,
               InterruptedException

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

Parameters:

viewTag - The view tag (server identifier of the view)

Throws:

IOException

InterruptedException

rmviewUuid

void rmviewUuid(String viewUuid)
         throws IOException,
                InterruptedException

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

Parameters:

viewUuid - the unique identifier for the view

Throws:

IOException

InterruptedException

setBaselinePromotionLevel

void setBaselinePromotionLevel(String baselineName,
                               ClearTool.DefaultPromotionLevel promotionLevel)
                        throws IOException,
                               InterruptedException

Throws:

IOException

InterruptedException

setBaselinePromotionLevel

void setBaselinePromotionLevel(String baselineName,
                               String promotionLevel)
                        throws IOException,
                               InterruptedException

Set the baseline promotion level to the given level. The predefined promotion levels are defined in ClearTool.DefaultPromotionLevel.

Parameters:

baselineName -

promotionLevel -

Throws:

IOException

InterruptedException

setcs

@Deprecated
void setcs(String viewPath,
                       ClearTool.SetcsOption option,
                       String configSpec)
                throws IOException,
                       InterruptedException

Deprecated. use setcs2 instead.

Sets the config spec of the view

Parameters:

viewPath - The view path name (relative to the workspace)

option - The type of setcs that needs to be performed

configSpec - the name of the file containing a config spec

Throws:

IOException

InterruptedException

setcs2

CleartoolUpdateResult setcs2(String viewPath,
                             ClearTool.SetcsOption current,
                             String configSpec)
                      throws IOException,
                             InterruptedException

Sets the config spec of the view

Parameters:

viewPath - The view path name (relative to the workspace)

option - The type of setcs that needs to be performed

configSpec - the name of the file containing a config spec

Throws:

IOException

InterruptedException

setcsTag

void setcsTag(String viewTag,
              ClearTool.SetcsOption option,
              String configSpec)
       throws IOException,
              InterruptedException

Synchronizes the Dynamic UCM view with the streams recommended baseline

Parameters:

viewTag -

option - The option to use

configSpec - The config spec to apply. If omitted, the view tag

Throws:

IOException

InterruptedException

startView

void startView(String viewTags)
        throws IOException,
               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:

IOException

InterruptedException

unlock

void unlock(String comment,
            String objectSelector)
     throws IOException,
            InterruptedException

Unlock an object

Parameters:

comment -

objectSelector -

Throws:

IOException

InterruptedException

unregisterView

void unregisterView(String viewUuid)
             throws IOException,
                    InterruptedException

Unregisters the view tag for a given UUID.

Parameters:

viewUuid - the unique identifier for the view.

Throws:

IOException

InterruptedException

update

@Deprecated
void update(String viewPath,
                        String[] loadRules)
                 throws IOException,
                        InterruptedException

Deprecated. use update2 instead

Updates the elements in the view

Parameters:

viewPath - the name of the view

loadRules - optional load rules, null if not used.

Throws:

IOException

InterruptedException

update2

CleartoolUpdateResult update2(String viewPath,
                              String[] loadRules)
                       throws IOException,
                              InterruptedException

Updates the elements in the view

Parameters:

viewPath - the name of the view

loadRules - optional load rules, null if not used.

Returns:

A tuple given access to the update logs and warnings returned

Throws:

IOException

InterruptedException

version

CleartoolVersion version()
                  throws IOException,
                         InterruptedException,
                         CleartoolVersionParsingException

Throws:

IOException

InterruptedException

CleartoolVersionParsingException