net.praqma.clearcase.ucm.entities

Class Stream

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.entities.UCMEntity

net.praqma.clearcase.ucm.entities.Stream

All Implemented Interfaces:

Serializable, Diffable, StreamContainable

public class Stream
extends UCMEntity
implements Diffable, Serializable, StreamContainable

This is the OO implementation of the ClearCase entity Stream

Author:

wolfgang

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

UCMEntity.Kind, UCMEntity.LabelStatus

Field Summary

Fields inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

date, dateFormatter, fqname, kind, labelStatus, loaded, mastership, pattern_std_fqname, pattern_tag_fqname, pattern_version_fqname, pvob, rx_ccdef_allowed, rx_ccdef_cc_name, rx_ccdef_filename, rx_ccdef_vob, shortname, user, vob

Fields inherited from class net.praqma.clearcase.ClearCase

rx_attr_find

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Constructor Summary

Constructors

Constructor and Description
Stream()

Method Summary

Modifier and Type	Method and Description
void	addFoundationBaseline(Baseline baseline) Add a foundation Baseline for this Stream
static Stream	create(StreamContainable parent, String nstream, boolean readonly, List<Baseline> baselines) Create a new stream in ClearCase, given a parent Stream, a fully qualified name for the new Stream and whether the Stream is read only or not
static Stream	create(Stream parent, String nstream, boolean readonly, Baseline baseline)
static Stream	createIntegration(String name, Project project, Baseline baseline)
static Stream	createIntegration(String name, Project project, List<Baseline> baselines) Create an integration Stream in ClearCase
boolean	exists()
void	generate() Update the config spec of the Stream
static Stream	get(String name)
static Stream	get(String name, PVob pvob)
List<Stream>	getChildStreams(boolean multisitePolling)
Stream	getDefaultTarget() This method returns the default Stream the given Stream will deliver to.
Stream	getDeliveringStream(boolean isMultiSite) Get the Stream delivering to this Stream.
Stream	getDeliveringStream(boolean isMultiSite, List<Stream> streams)
List<Stream>	getDeliveringStreamsUsingHlink(String hyperLinkName) For JENKINS-26484
Deliver.Status	getDeliverStatus()
Baseline	getFoundationBaseline() Get the first foundation baseline.
List<Baseline>	getFoundationBaselines()
Baseline	getLatestBaseline(Component component) Get the latest Baseline from this Stream and a Component.
List<Baseline>	getLatestBaselines()
String	getOriginalMastership() Get the original mastership from ClearCase
Stream	getParent()
List<Baseline>	getPostedBaselines(Component component, Project.PromotionLevel plevel)
Project	getProject()
List<Baseline>	getRecommendedBaselines()
List<Baseline>	getRecommendedBaselines(boolean force)
List<Stream>	getSiblingStreams() For each project return their integration streams
Component	getSingleTopComponent()
List<UCMView>	getViews()
boolean	hasPostedDelivery()
boolean	isReadOnly()
Stream	load() Default load functionality for the entity.
void	recommendBaseline(Baseline baseline) Recommend the Baseline for this Stream in ClearCase
void	remove() Remove this Stream from ClearCase
void	setDefaultTarget(Stream stream) Set the default target Stream in ClearCase
void	setFoundationBaseline(Baseline baseline)
void	setParent(Stream parent)
void	setProject(Project project) Set the Project of the Stream
void	setReadOnly(boolean readOnly)
static boolean	streamExists(String fqname) Determines whether a Stream exists, given a fully qualified name
String	stringify() Returns a string representation of the entity object

Methods inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

autoLoad, changeOwnership, changeOwnership, equals, getargComment, getargIn, getComment, getDate, getEntity, getEntity, getEntitySelector, getFqname, getFullyQualifiedName, getHyperlinks, getKind, getLabelStatus, getLabelStatusFromString, getMastership, getNamePart, getNormalizedName, getObjectId, getObjectId, getPVob, getShortname, getTag, getUser, hashCode, initialize, isCreated, isLoaded, loadDate, setComment, setCreated, setDate, setDate, setFqname, setKind, setLabelStatusFromString, setMastership, setUser, toString

Methods inherited from class net.praqma.clearcase.ClearCase

createSimpleAttributeType, getAttribute, getAttributes, getAttributes, getAttributes, setAttribute, setAttribute

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.praqma.clearcase.interfaces.Diffable

getFullyQualifiedName

Methods inherited from interface net.praqma.clearcase.interfaces.StreamContainable

getFullyQualifiedName, getPVob

Constructor Detail

Stream

public Stream()

Method Detail

create

public static Stream create(Stream parent,
                            String nstream,
                            boolean readonly,
                            Baseline baseline)
                     throws UnableToCreateEntityException,
                            UnableToInitializeEntityException

Throws:

UnableToCreateEntityException

UnableToInitializeEntityException

create

public static Stream create(StreamContainable parent,
                            String nstream,
                            boolean readonly,
                            List<Baseline> baselines)
                     throws UnableToCreateEntityException,
                            UnableToInitializeEntityException

Create a new stream in ClearCase, given a parent Stream, a fully qualified name for the new Stream and whether the Stream is read only or not

Parameters:

parent - The parent Stream

nstream - The fully qualified name of the new Stream

readonly - Whether the new Stream is read only or not

baselines - Initial configuration of baselines for the stream

Returns:

A new Stream given the parameters

Throws:

UnableToCreateEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

createIntegration

public static Stream createIntegration(String name,
                                       Project project,
                                       Baseline baseline)
                                throws UnableToCreateEntityException,
                                       UCMEntityNotFoundException,
                                       UnableToGetEntityException,
                                       UnableToInitializeEntityException

Throws:

UnableToCreateEntityException

UCMEntityNotFoundException

UnableToGetEntityException

UnableToInitializeEntityException

createIntegration

public static Stream createIntegration(String name,
                                       Project project,
                                       List<Baseline> baselines)
                                throws UnableToCreateEntityException,
                                       UCMEntityNotFoundException,
                                       UnableToGetEntityException,
                                       UnableToInitializeEntityException

Create an integration Stream in ClearCase

Parameters:

name - The name of the new integration stream

project - The project under which the stream is created

baselines - Initial configuration of baselines

Returns:

The created Stream

Throws:

UnableToCreateEntityException - Thrown when ClearCase reports errors

UCMEntityNotFoundException - Thrown when ClearCase reports errors

UnableToGetEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

load

public Stream load()
            throws UCMEntityNotFoundException,
                   UnableToLoadEntityException,
                   UnableToInitializeEntityException

Description copied from class: UCMEntity

Default load functionality for the entity. Every UCM entity should implement this method itself.

Overrides:

load in class UCMEntity

Returns:

The current UCMEntity

Throws:

UCMEntityNotFoundException - Thrown when ClearCase reports errors

UnableToLoadEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

getChildStreams

public List<Stream> getChildStreams(boolean multisitePolling)
                             throws UnableToInitializeEntityException,
                                    CleartoolException

Throws:

UnableToInitializeEntityException

CleartoolException

getPostedBaselines

public List<Baseline> getPostedBaselines(Component component,
                                         Project.PromotionLevel plevel)
                                  throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

hasPostedDelivery

public boolean hasPostedDelivery()
                          throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

setProject

public void setProject(Project project)

Set the Project of the Stream

Parameters:

project - The Project

setDefaultTarget

public void setDefaultTarget(Stream stream)
                      throws CleartoolException

Set the default target Stream in ClearCase

Parameters:

stream - The Stream

Throws:

CleartoolException - Thrown when ClearCase reports errors

getSiblingStreams

public List<Stream> getSiblingStreams()
                               throws UnableToListProjectsException,
                                      UnableToInitializeEntityException,
                                      UnableToLoadEntityException,
                                      UCMEntityNotFoundException

For each project return their integration streams

Returns:

A list of Streams

Throws:

UnableToListProjectsException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

UnableToLoadEntityException - Thrown when ClearCase reports errors

UCMEntityNotFoundException - Thrown when ClearCase reports errors

getDeliveringStreamsUsingHlink

public List<Stream> getDeliveringStreamsUsingHlink(String hyperLinkName)
                                            throws UnableToListProjectsException,
                                                   UnableToInitializeEntityException,
                                                   UnableToLoadEntityException,
                                                   UCMEntityNotFoundException,
                                                   HyperlinkException

For JENKINS-26484

Parameters:

hyperLinkName - The name of the hyperlink

Returns:

A list of streams

Throws:

UnableToListProjectsException - Thrown when ClearCase cannot list projects

UnableToInitializeEntityException - Thrown when ClearCase reports error

UnableToLoadEntityException - Thrown when ClearCase reports error

UCMEntityNotFoundException - Thrown when ClearCase reports error

HyperlinkException - Thrown when a ClearTool error occurs

streamExists

public static boolean streamExists(String fqname)

Determines whether a Stream exists, given a fully qualified name

Parameters:

fqname - Fully qualified name

Returns:

True if the Stream exists, false otherwise Is thrown if the fully qualified name is not a valid name

exists

public boolean exists()

getDeliveringStream

public Stream getDeliveringStream(boolean isMultiSite)
                           throws ClearCaseException

Get the Stream delivering to this Stream. Null if no Deliver is in progress.

Parameters:

isMultiSite - Multisite

Returns:

The delivering Stream

Throws:

ClearCaseException - Thrown when ClearCase reports errors

getDeliveringStream

public Stream getDeliveringStream(boolean isMultiSite,
                                  List<Stream> streams)
                           throws ClearCaseException

Parameters:

isMultiSite - Is multisite enabled?

streams - Streams

Returns:

The delivering Stream

Throws:

ClearCaseException - Thrown when ClearCase reports errors

getDeliverStatus

public Deliver.Status getDeliverStatus()
                                throws ClearCaseException

Throws:

ClearCaseException

getRecommendedBaselines

public List<Baseline> getRecommendedBaselines()
                                       throws UnableToListBaselinesException,
                                              UnableToInitializeEntityException

Throws:

UnableToListBaselinesException

UnableToInitializeEntityException

generate

public void generate()
              throws CleartoolException

Update the config spec of the Stream

Throws:

CleartoolException - Thrown when ClearCase reports error

getRecommendedBaselines

public List<Baseline> getRecommendedBaselines(boolean force)
                                       throws UnableToListBaselinesException,
                                              UnableToInitializeEntityException

Throws:

UnableToListBaselinesException

UnableToInitializeEntityException

recommendBaseline

public void recommendBaseline(Baseline baseline)
                       throws CleartoolException

Recommend the Baseline for this Stream in ClearCase

Parameters:

baseline - The Baseline to recommend

Throws:

CleartoolException - Thrown when ClearCase reports errors

getLatestBaselines

public List<Baseline> getLatestBaselines()
                                  throws UnableToInitializeEntityException,
                                         CleartoolException

Throws:

UnableToInitializeEntityException

CleartoolException

getLatestBaseline

public Baseline getLatestBaseline(Component component)
                           throws UnableToInitializeEntityException,
                                  CleartoolException

Get the latest Baseline from this Stream and a Component.

Parameters:

component - The Component

Returns:

The latest Baseline under the given Component

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

getSingleTopComponent

public Component getSingleTopComponent()
                                throws NoSingleTopComponentException,
                                       UnableToInitializeEntityException

Throws:

NoSingleTopComponentException

UnableToInitializeEntityException

getProject

public Project getProject()

getViews

public List<UCMView> getViews()
                       throws CleartoolException,
                              ViewException

Throws:

CleartoolException

ViewException

remove

public void remove()
            throws UnableToRemoveEntityException

Remove this Stream from ClearCase

Throws:

UnableToRemoveEntityException - Thrown when ClearCase reports errors

getDefaultTarget

public Stream getDefaultTarget()

This method returns the default Stream the given Stream will deliver to.

Returns:

A Stream

setReadOnly

public void setReadOnly(boolean readOnly)

isReadOnly

public boolean isReadOnly()

setFoundationBaseline

public void setFoundationBaseline(Baseline baseline)

Parameters:

baseline - The Baseline to use as foundation for this Stream

addFoundationBaseline

public void addFoundationBaseline(Baseline baseline)

Add a foundation Baseline for this Stream

Parameters:

baseline - The Baseline to add as a foundation baselin to this Stream

getFoundationBaseline

public Baseline getFoundationBaseline()

Get the first foundation baseline. This is a method implemented to maintain backwards compatibility.

Returns:

The foundation Baseline

getFoundationBaselines

public List<Baseline> getFoundationBaselines()

Returns:

A list of Baselines, never null

setParent

public void setParent(Stream parent)

getParent

public Stream getParent()

getOriginalMastership

public String getOriginalMastership()
                             throws CleartoolException

Get the original mastership from ClearCase

Returns:

The original mastership

Throws:

CleartoolException - Thrown when ClearCase reports errors

stringify

public String stringify()

Description copied from class: UCMEntity

Returns a string representation of the entity object

Overrides:

stringify in class UCMEntity

Returns:

A String

get

public static Stream get(String name)
                  throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

get

public static Stream get(String name,
                         PVob pvob)
                  throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException