com.atlassian.bamboo.specs.api.builders.credentials

Class SharedCredentials<B extends SharedCredentials<B,C>,C extends SharedCredentialsProperties>

java.lang.Object

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

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

com.atlassian.bamboo.specs.api.builders.credentials.SharedCredentials<B,C>

Direct Known Subclasses:

AnySharedCredentials, SshCredentials, UsernamePasswordCredentials

public abstract class SharedCredentials<B extends SharedCredentials<B,C>,C extends SharedCredentialsProperties>
extends RootEntityPropertiesBuilder<C>

Represents a shared credentials data. Global shared credentials can be used by any plan. Project shared credentials can be used only by plans in Project.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected BambooOidProperties	oid
protected ProjectProperties	project
static String	TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SharedCredentials()
protected	SharedCredentials(@NotNull String name)

Method Summary

Modifier and Type	Method and Description
protected abstract C	build()
String	humanReadableId() Entity type and id representation that is shown to human.
String	humanReadableType() Entity type that is shown to human.
B	name(@NotNull String name) Set the name by which credentials will be identified by Bamboo.
B	oid(@Nullable BambooOid oid) Set the credential's oid from oid string.
B	oid(@Nullable String oid) Set the credential's oid.
B	project(@NotNull Project project) Set the credential's project.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

name

protected String name

oid

protected BambooOidProperties oid

project

protected ProjectProperties project

Constructor Detail

SharedCredentials

protected SharedCredentials()

SharedCredentials

protected SharedCredentials(@NotNull
                            @NotNull String name)
                     throws PropertiesValidationException

Throws:

PropertiesValidationException

Method Detail

name

public B name(@NotNull
              @NotNull String name)

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

See Also:

oid(BambooOid)

oid

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

Set the credential's oid.

If set, it is used to identify the shared credential. If the shared credential 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 shared credential being renamed.

Throws:

PropertiesValidationException

oid

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

Set the credential's oid from oid string.

If set, it is used to identify the shared credential. If the shared credential 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 shared credential being renamed.

Throws:

PropertiesValidationException

project

public B project(@NotNull
                 @NotNull Project project)

Set the credential's project.

If set, it is Project shared credentials, otherwise it is Global Shared Credentials.

humanReadableType

public String humanReadableType()

Description copied from class: RootEntityPropertiesBuilder

Entity type that is shown to human.

Specified by:

humanReadableType in class RootEntityPropertiesBuilder<C extends SharedCredentialsProperties>

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<C extends SharedCredentialsProperties>

build

protected abstract C build()

Specified by:

build in class EntityPropertiesBuilder<C extends SharedCredentialsProperties>