Package com.atlassian.bamboo.specs.api.builders.repository

Class VcsRepository<T extends VcsRepository<T,E>,E extends VcsRepositoryProperties>

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<T>

com.atlassian.bamboo.specs.api.builders.RootEntityPropertiesBuilder<E>

com.atlassian.bamboo.specs.api.builders.repository.VcsRepository<T,E>

Direct Known Subclasses:

AnyVcsRepository, BitbucketCloudRepository, BitbucketServerRepository, GitHubRepository, GitRepository

public abstract class VcsRepository<T extends VcsRepository<T,E>,E extends VcsRepositoryProperties>
extends RootEntityPropertiesBuilder<E>

Represents a definition of VCS repository.

This class contains common data only. In order to define a specific type of repository one should use the specialised implementation or, if such is not available, AnyVcsRepository class.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	name
protected BambooOidProperties	oid
protected String	parent
protected ProjectProperties	project
protected VcsRepositoryViewerProperties	repositoryViewer
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
VcsRepository()	Specifies a new repository definition.

Method Summary

Modifier and Type	Method	Description
protected abstract E	build()
T	description(@Nullable String description)	Sets repository description.
@NotNull VcsRepositoryIdentifier	getIdentifier()	Returns identifier for this object.
@NotNull String	getName()	Returns repository name, which serves as identifier for this object.
@NotNull BambooOid	getOid()	Returns repository's oid.
String	humanReadableId()	Entity type and id representation that is shown to human.
String	humanReadableType()	Entity type that is shown to human.
T	name(@Nullable String name)	Sets the name by which repository will be identified by Bamboo.
T	oid(@Nullable BambooOid oid)	Sets the repository's oid.
T	oid(@Nullable String oid)	Sets the repository's oid from string.
T	parent(@Nullable String parent)	Sets the parent of this repository should inherit data from.
T	project(@Nullable Project project)	Set the repository's project.
T	repositoryViewer(@Nullable VcsRepositoryViewer repositoryViewer)	Sets a web repository viewer to be used with this repository.

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

parent

protected String parent

name

protected String name

oid

protected BambooOidProperties oid

description

protected String description

project

protected ProjectProperties project

repositoryViewer

protected VcsRepositoryViewerProperties repositoryViewer

Constructor Details

VcsRepository

public VcsRepository()
              throws PropertiesValidationException

Specifies a new repository definition.

A repository can be global, in which case any changes made to a repository are automatically applied to all plans or jobs that use that repository. Also repository can be project, in which case it can be used only in plans from corresponding project. Repository can also be defined in scope of a Plan, in which case it is only accessible in context of plan it is defined for.

Throws:

PropertiesValidationException

Method Details

name

public T name(@Nullable
 @Nullable String name)
       throws PropertiesValidationException

Sets the name by which repository will be identified by Bamboo. In the absence of oid, the name is used to identify the repository. If the repository with given name does not exist, a new one is created, otherwise existing one is updated.

The name should be unique in scope a repository is defined in.

The name must not be set if repository inherits data from another repository.

Throws:

PropertiesValidationException

See Also:

• parent(String)

oid

public T oid(@Nullable
 @Nullable String oid)
      throws PropertiesValidationException

Sets the repository's oid from string.

If set, it is used to identify the repository. If the repository with given oid does not exist, a new one is created, otherwise existing one is updated. Setting both oid and name may result in existing repository being renamed.

Throws:

PropertiesValidationException

oid

public T oid(@Nullable
 @Nullable BambooOid oid)
      throws PropertiesValidationException

Sets the repository's oid.

If set, it is used to identify the repository. If the repository with given oid does not exist, a new one is created, otherwise existing one is updated. Setting both oid and name may result in existing repository being renamed.

Throws:

PropertiesValidationException

parent

public T parent(@Nullable
 @Nullable String parent)
         throws PropertiesValidationException

Sets the parent of this repository should inherit data from. When defining repository for a plan user can decide to inherit its data from an existing global repository instead of creating it from scratch. In that case, any change to parent's repository configuration will automatically be applied to all its children, unless a respective data has been overridden.

Throws:

PropertiesValidationException

description

public T description(@Nullable
 @Nullable String description)
              throws PropertiesValidationException

Sets repository description.

The description must not be set if repository inherits from another repository.

Throws:

PropertiesValidationException

repositoryViewer

public T repositoryViewer(@Nullable
 @Nullable VcsRepositoryViewer repositoryViewer)
                   throws PropertiesValidationException

Sets a web repository viewer to be used with this repository.

Web repository viewer allows Bamboo to render correct links to commits, files, etc. in the Bamboo UI.

Throws:

PropertiesValidationException

See Also:

• VcsRepositoryViewer

project

public T project(@Nullable
 @Nullable Project project)

Set the repository's project. Available for Bamboo DC only.

If set, it is Project repository, otherwise it is Global or plan repository.

Since:

8.0

getName

@NotNull
public @NotNull String getName()

Returns repository name, which serves as identifier for this object.

Throws:

IllegalStateException - if name is undefined

getOid

@NotNull
public @NotNull BambooOid getOid()

Returns repository's oid.

Throws:

IllegalStateException - if oid is undefined

getIdentifier

@NotNull
public @NotNull VcsRepositoryIdentifier getIdentifier()

Returns identifier for this object.

Throws:

IllegalStateException - if key is undefined

humanReadableType

public String humanReadableType()

Description copied from class: RootEntityPropertiesBuilder

Entity type that is shown to human.

Specified by:

humanReadableType in class RootEntityPropertiesBuilder<E extends VcsRepositoryProperties>

humanReadableId

public String humanReadableId()

Description copied from class: RootEntityPropertiesBuilder

Entity type and id representation that is shown to human.

Specified by:

humanReadableId in class RootEntityPropertiesBuilder<E extends VcsRepositoryProperties>

build

protected abstract E build()
                    throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<E extends VcsRepositoryProperties>

Throws:

PropertiesValidationException