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

Class PlanPermissions

java.lang.Object

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

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

com.atlassian.bamboo.specs.api.builders.permission.PlanPermissions

public final class PlanPermissions
extends RootEntityPropertiesBuilder<PlanPermissionsProperties>

Entity representing permissions for plans. Note that this object needs to be published separately from associated Plan. Pre-existing permissions that are not defined in associated Permissions object are revoked when this object is published.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor	Description
PlanPermissions(BambooKey projectKey, BambooKey planKey)
PlanPermissions(BambooOid planOid)
PlanPermissions(PlanIdentifier planIdentifier)

Method Summary

Modifier and Type	Method	Description
PlanPermissions	addDefaultPermissions()	Adds defaults permissions, ie.
protected PlanPermissionsProperties	build()
Permissions	getPermissions()
@NotNull PlanIdentifier	getPlanIdentifier()
java.lang.String	humanReadableId()	Entity type and id representation that is shown to human.
java.lang.String	humanReadableType()	Entity type that is shown to human.
PlanPermissions	permissions(@NotNull Permissions permissions)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlanPermissions

public PlanPermissions(BambooOid planOid)

PlanPermissions

public PlanPermissions(BambooKey projectKey,
                       BambooKey planKey)

PlanPermissions

public PlanPermissions(PlanIdentifier planIdentifier)

Method Detail

permissions

public PlanPermissions permissions(@NotNull
                                   @NotNull Permissions permissions)

addDefaultPermissions

public PlanPermissions addDefaultPermissions()

Adds defaults permissions, ie. PermissionType.VIEW for logged-in and anonymous users.

getPlanIdentifier

@NotNull
public @NotNull PlanIdentifier getPlanIdentifier()

getPermissions

public Permissions getPermissions()

build

protected PlanPermissionsProperties build()

Specified by:

build in class EntityPropertiesBuilder<PlanPermissionsProperties>

humanReadableType

public java.lang.String humanReadableType()

Description copied from class: RootEntityPropertiesBuilder

Entity type that is shown to human.

Specified by:

humanReadableType in class RootEntityPropertiesBuilder<PlanPermissionsProperties>

humanReadableId

public java.lang.String humanReadableId()

Description copied from class: RootEntityPropertiesBuilder

Entity type and id representation that is shown to human.

Specified by:

humanReadableId in class RootEntityPropertiesBuilder<PlanPermissionsProperties>