com.atlassian.bamboo.plan

Interface FilteringPlanManager

All Known Subinterfaces:

CachedPlanManager

All Known Implementing Classes:

CachedPlanManagerImpl

public interface FilteringPlanManager

All methods in this class apply permission checks based on Acegi. When, possible they are done declaratively through applicationContextAcegiAuthorization.xml . In other cases, business code is responsible for applying permission checks.

Method Summary

Modifier and Type	Method and Description
boolean	assertPlanPermission(PlanIdentifier plan) Used to validate user permission for plan.
Optional<ImmutableChain>	getAnyPlan(Predicate<? super ImmutableChain> predicate) Returns a plan matching the supplied predicate.
List<ImmutableChainBranch>	getBranchesForChain(PlanIdentifier chain) Deprecated. since 6.2 use getBranchesOfChain(PlanKey) instead. Remember about sorting it for UI.
Stream<ImmutableChainBranch>	getBranchesOfChain(PlanKey chainKey) Get all feature branches associated with the given chain, unsorted
Iterable<ImmutableTopLevelPlan>	getEditablePlansByProject(Project project) Returns all Plan's filtered by Project and user can edit (EDIT permission assigned for plan to user)
Stream<ImmutableChain>	getFilteredPlansWithRepository(PlanRepositoryIndex.Query query) Returns chains that use repositories with given params
List<ImmutableTopLevelPlan>	getPlans() Returns all TopLevelPlan's.
<T extends ImmutablePlan> List<T>	getPlans(Class<T> planType) Returns all Plan's filtered by Class.
<T extends ImmutablePlan> List<T>	getPlans(Class<T> planType, com.google.common.base.Predicate<? super T> filter) Deprecated. since 5.11 this method warms the whole cache. Use it very carefully. Avoid it in core Bamboo.
List<ImmutableTopLevelPlan>	getPlansByProject(Project project) Returns all ImmutableTopLevelPlan's filtered by Project.
<T extends ImmutablePlan> List<T>	getPlansByProject(Project project, Class<T> planType) Returns all Plan's filtered by Project and Class.
<T extends ImmutablePlan> List<T>	getPlansByProject(Project project, Class<T> planType, com.google.common.base.Predicate<? super T> filter)
List<ImmutableChain>	getPlansForClone() Returns all Chain's.
<T extends ImmutablePlan> List<T>	getRunnablePlans(Project project, Class<T> planType) Returns all Plan's filtered by Project and Class.

Method Detail

assertPlanPermission

boolean assertPlanPermission(@NotNull
                             PlanIdentifier plan)

Used to validate user permission for plan. This method is Acegi-filtered.

Parameters:

plan - to check the permissions of

Returns:

true if the current user has read(?) permissions on the plan

getAnyPlan

Optional<ImmutableChain> getAnyPlan(Predicate<? super ImmutableChain> predicate)

Returns a plan matching the supplied predicate.

getBranchesForChain

@NotNull
 @Deprecated
List<ImmutableChainBranch> getBranchesForChain(@NotNull
                                                                     PlanIdentifier chain)

Deprecated. since 6.2 use getBranchesOfChain(PlanKey) instead. Remember about sorting it for UI.

Get all feature branches associated with the given chain, sorted

Parameters:

chain - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchesOfChain

@NotNull
Stream<ImmutableChainBranch> getBranchesOfChain(@NotNull
                                                         PlanKey chainKey)

Get all feature branches associated with the given chain, unsorted

Parameters:

chainKey - - the master

Returns:

List ChainBranchs associated with the given chain.

getEditablePlansByProject

@NotNull
Iterable<ImmutableTopLevelPlan> getEditablePlansByProject(Project project)

Returns all Plan's filtered by Project and user can edit (EDIT permission assigned for plan to user)

Parameters:

project - - that the plans will belong to

Returns:

editable plans for project

getPlans

@NotNull
List<ImmutableTopLevelPlan> getPlans()

Returns all TopLevelPlan's. This method is Acegi-filtered.

Returns:

plans

getPlans

@NotNull
<T extends ImmutablePlan> List<T> getPlans(Class<T> planType)

Returns all Plan's filtered by Class. Does not include plans marked for deletion. This method is Acegi-filtered.

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlans

@NotNull
 @Deprecated
<T extends ImmutablePlan> List<T> getPlans(Class<T> planType,
                                                                 @NotNull
                                                                 com.google.common.base.Predicate<? super T> filter)

Deprecated. since 5.11 this method warms the whole cache. Use it very carefully. Avoid it in core Bamboo.

Returns all Plan's filtered by Class. Does not include plans marked for deletion. This method is Acegi-filtered.

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlansByProject

@NotNull
List<ImmutableTopLevelPlan> getPlansByProject(Project project)

Returns all ImmutableTopLevelPlan's filtered by Project. This method is Acegi-filtered.

Parameters:

project - - that the plans will belong to

Returns:

ImmutableTopLevelPlan plans contained within the given project

getPlansByProject

@NotNull
<T extends ImmutablePlan> List<T> getPlansByProject(Project project,
                                                             Class<T> planType)

Returns all Plan's filtered by Project and Class. This method is Acegi-filtered.

Parameters:

project - - that the plans will belong to

planType - - the type of the plan to retrieve

Returns:

plans contained within the given project and of the given type

getPlansByProject

<T extends ImmutablePlan> List<T> getPlansByProject(@NotNull
                                                    Project project,
                                                    @NotNull
                                                    Class<T> planType,
                                                    @NotNull
                                                    com.google.common.base.Predicate<? super T> filter)

getFilteredPlansWithRepository

Stream<ImmutableChain> getFilteredPlansWithRepository(@NotNull
                                                      PlanRepositoryIndex.Query query)

Returns chains that use repositories with given params

getPlansForClone

@NotNull
List<ImmutableChain> getPlansForClone()

Returns all Chain's. Return list filtered to show only plans the current user is allowed to clone.

Returns:

plans

getRunnablePlans

@NotNull
<T extends ImmutablePlan> List<T> getRunnablePlans(@NotNull
                                                            Project project,
                                                            @NotNull
                                                            Class<T> planType)

Returns all Plan's filtered by Project and Class. Only plans runnable by user will be returned.

Parameters:

project - - that the plans will belong to

planType - - the type of the plan to retrieve

Returns:

plans contained within the given project and of the given type