com.atlassian.bamboo.plan.cache

Interface CachedPlanManager

All Superinterfaces:

FilteringPlanManager

All Known Implementing Classes:

CachedPlanManagerImpl

public interface CachedPlanManager
extends FilteringPlanManager

Provides access to immutable, centrally cached plans.

Method Summary

Modifier and Type	Method and Description
Set<Project>	getAllProjectsWithPlan() Returns all projects which have at least one plan (plan is in the cache)
Optional<ImmutableChain>	getAnyPlan(Predicate<? super ImmutableChain> predicate) Returns a plan matching the supplied predicate, permission filtering is applied.
Optional<ImmutableChain>	getAnyPlanUnrestricted(Predicate<? super ImmutableChain> predicate) Returns a plan matching the supplied predicate.
@NotNull Set<PlanBranchGist>	getBranchGistsOfChain(@NotNull PlanKey chainKey) Returns basic data of all branches for the supplied chain.
@NotNull Set<PlanKey>	getBranchKeysOfChain(@NotNull PlanKey chainKey) Returns keys of all branches for the supplied chain.
@Nullable ImmutableJob	getMasterOfJob(@NotNull PlanKey masterChainKey, @NotNull PlanKey jobKey)
@Nullable ImmutableChain	getMasterPlan(@NotNull PlanKey branchKey) Returns master branch for a given branchKey.
<T extends ImmutablePlan> T	getPlanById(long id, Class<T> planType) Returns a ImmutablePlan by its database id and Class
<T extends ImmutablePlan> T	getPlanByIdNotThrowing(long id, Class<T> planType) Returns a ImmutablePlan by its database id and Class.
@Nullable ImmutablePlan	getPlanByKey(@NotNull PlanKey planKey) Returns a ImmutablePlan by its planKey
<T extends ImmutablePlan> T	getPlanByKey(@NotNull PlanKey planKey, Class<T> planType) Returns a ImmutablePlan by its planKey and Class
<T extends ImmutablePlan> T	getPlanByKeyIfOfType(@NotNull PlanKey planKey, @NotNull Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
@NotNull List<ImmutableChain>	getPlansByProjectUnrestricted(Project project) Returns all ImmutableChain's filtered by Project ignoring permissions
@NotNull List<ImmutableTopLevelPlan>	getPlansUnrestricted() Returns all ImmutableTopLevelPlan's ignoring permissions.
Iterable<ImmutableChain>	getPlansWithRepository(PlanRepositoryIndex.Query query) Returns chains that use repositories with given params
boolean	isBranchOf(@NotNull PlanKey chainKey, @NotNull PlanKey branchKey) Test if plan identified by branchKey is a branch of plan identified by chainKey.

Methods inherited from interface com.atlassian.bamboo.plan.FilteringPlanManager

assertPlanPermission, getBranchesForChain, getBranchesOfChain, getEditablePlansByProject, getFilteredPlansWithRepository, getPlans, getPlans, getPlans, getPlansByProject, getPlansByProject, getPlansByProject, getPlansForClone, getRunnablePlans

Method Detail

getPlanByKey

@Nullable
@Nullable ImmutablePlan getPlanByKey(@NotNull
                                               @NotNull PlanKey planKey)

Returns a ImmutablePlan by its planKey

Parameters:

planKey - to search for

Returns:

plan with the given plan key or null if not found

getPlanByKey

@Nullable
<T extends ImmutablePlan> T getPlanByKey(@NotNull
                                                   @NotNull PlanKey planKey,
                                                   Class<T> planType)
                                            throws IncorrectPlanTypeException

Returns a ImmutablePlan by its planKey and Class

Parameters:

planKey - to search for

planType - - the type of the plan to retrieve

Returns:

plan with the given plan key, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

getPlanByKeyIfOfType

@Nullable
<T extends ImmutablePlan> T getPlanByKeyIfOfType(@NotNull
                                                           @NotNull PlanKey planKey,
                                                           @NotNull
                                                           @NotNull Class<T> planType)

Returns a Plan by its planKey and if it's of the type Class. Does not throw IncorrectPlanTypeException. Should only be used when the type of the plan can not be known.

Type Parameters:

T -

Parameters:

planKey -

planType -

Returns:

null if the plan doesn't exist, or it's not of the found type

getAnyPlan

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

Returns a plan matching the supplied predicate, permission filtering is applied.

Specified by:

getAnyPlan in interface FilteringPlanManager

getAnyPlanUnrestricted

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

Returns a plan matching the supplied predicate.

getPlanById

@Nullable
<T extends ImmutablePlan> T getPlanById(long id,
                                                  Class<T> planType)
                                           throws IncorrectPlanTypeException,
                                                  NoSuchElementException

Returns a ImmutablePlan by its database id and Class

Parameters:

id - to search for

planType - - the type of the plan to retrieve

Returns:

plan with the given database id, if found AND is of the correct type.

Throws:

IncorrectPlanTypeException - if plan cannot be found with the correct type

NoSuchElementException

getPlanByIdNotThrowing

@Nullable
<T extends ImmutablePlan> T getPlanByIdNotThrowing(long id,
                                                             Class<T> planType)

Returns a ImmutablePlan by its database id and Class. This method does not throw exception if plan is not found.

Parameters:

id - to search for

planType - - the type of the plan to retrieve

Returns:

plan with the given database id, if found AND is of the correct type, null otherwise

Since:

6.8

getPlansUnrestricted

@NotNull
@NotNull List<ImmutableTopLevelPlan> getPlansUnrestricted()

Returns all ImmutableTopLevelPlan's ignoring permissions.

Returns:

getPlansByProjectUnrestricted

@NotNull
@NotNull List<ImmutableChain> getPlansByProjectUnrestricted(Project project)

Returns all ImmutableChain's filtered by Project ignoring permissions

Parameters:

project - - that the plans will belong to

Returns:

ImmutableChain plans contained within the given project

getBranchKeysOfChain

@NotNull
@NotNull Set<PlanKey> getBranchKeysOfChain(@NotNull
                                                    @NotNull PlanKey chainKey)

Returns keys of all branches for the supplied chain.

getBranchGistsOfChain

@NotNull
@NotNull Set<PlanBranchGist> getBranchGistsOfChain(@NotNull
                                                            @NotNull PlanKey chainKey)

Returns basic data of all branches for the supplied chain.

Since:

6.5

getMasterPlan

@Nullable
@Nullable ImmutableChain getMasterPlan(@NotNull
                                                 @NotNull PlanKey branchKey)

Returns master branch for a given branchKey. If branchKey identifies plan which has no master (is a master itself) then this plan is returned, otherwise a master of a plan is returned.

Parameters:

branchKey - key of a branch

Returns:

master branch for a given branchKey or null if branchKey doesn't identify a plan

isBranchOf

boolean isBranchOf(@NotNull
                   @NotNull PlanKey chainKey,
                   @NotNull
                   @NotNull PlanKey branchKey)

Test if plan identified by branchKey is a branch of plan identified by chainKey. If branchKey identifies master plan method also returns true.

Parameters:

chainKey - key of master branch

branchKey - key of alleged branch

Returns:

true if plan identified by branchKey is a branch of plan identified by chainKey, false otherwise

getMasterOfJob

@Nullable
@Nullable ImmutableJob getMasterOfJob(@NotNull
                                                @NotNull PlanKey masterChainKey,
                                                @NotNull
                                                @NotNull PlanKey jobKey)

getPlansWithRepository

Iterable<ImmutableChain> getPlansWithRepository(@NotNull
                                                PlanRepositoryIndex.Query query)

Returns chains that use repositories with given params

getAllProjectsWithPlan

Set<Project> getAllProjectsWithPlan()

Returns all projects which have at least one plan (plan is in the cache)

Returns: