com.atlassian.bamboo.plan.cache

Class CachedPlanManagerImpl

java.lang.Object

com.atlassian.bamboo.plan.cache.CachedPlanManagerImpl

All Implemented Interfaces:

CachedPlanManager, FilteringPlanManager

public class CachedPlanManagerImpl
extends Object
implements CachedPlanManager, FilteringPlanManager

Constructor Summary

Constructors

Constructor and Description
CachedPlanManagerImpl()

Method Summary

Modifier and Type	Method and Description
boolean	assertPlanPermission(PlanIdentifier plan) Used to validate user permission for plan.
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.
List<ImmutableChainBranch>	getBranchesForChain(PlanIdentifier chain) Get all feature branches associated with the given chain, sorted
Stream<ImmutableChainBranch>	getBranchesOfChain(PlanKey chainKey) Get all feature branches associated with the given chain, unsorted
Set<PlanBranchGist>	getBranchGistsOfChain(PlanKey chainKey) Returns basic data of all branches for the supplied chain.
Set<PlanKey>	getBranchKeysOfChain(PlanKey chainKey) Returns keys of all branches for the supplied chain.
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
ImmutableJob	getMasterOfJob(PlanKey masterChainKey, PlanKey jobKey)
ImmutableChain	getMasterPlan(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.
ImmutablePlan	getPlanByKey(PlanKey planKey) Returns a ImmutablePlan by its planKey
<T extends ImmutablePlan> T	getPlanByKey(PlanKey planKey, Class<T> planType) Returns a ImmutablePlan by its planKey and Class
<T extends ImmutablePlan> T	getPlanByKeyIfOfType(PlanKey planKey, Class<T> planType) Returns a Plan by its planKey and if it's of the type Class.
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) Returns all Plan's filtered by Class.
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.
List<ImmutableTopLevelPlan>	getPlansUnrestricted() Returns all ImmutableTopLevelPlan's ignoring permissions.
Iterable<ImmutableChain>	getPlansWithRepository(PlanRepositoryIndex.Query query) Returns chains that use repositories with given params
<T extends ImmutablePlan> List<T>	getRunnablePlans(Project project, Class<T> planType) Returns all Plan's filtered by Project and Class.
boolean	isBranchOf(PlanKey chainKey, PlanKey branchKey) Test if plan identified by branchKey is a branch of plan identified by chainKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedPlanManagerImpl

public CachedPlanManagerImpl()

Method Detail

getPlanByKey

@Nullable
public ImmutablePlan getPlanByKey(@NotNull
                                            PlanKey planKey)

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey

Specified by:

getPlanByKey in interface CachedPlanManager

Parameters:

planKey - to search for

Returns:

plan with the given plan key or null if not found

getPlanByKey

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

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey and Class

Specified by:

getPlanByKey in interface CachedPlanManager

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
public <T extends ImmutablePlan> T getPlanByKeyIfOfType(@NotNull
                                                                  PlanKey planKey,
                                                                  @NotNull
                                                                  Class<T> planType)

Description copied from interface: CachedPlanManager

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.

Specified by:

getPlanByKeyIfOfType in interface CachedPlanManager

Returns:

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

getPlans

@NotNull
public List<ImmutableTopLevelPlan> getPlans()

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlans in interface FilteringPlanManager

Returns:

plans

getPlansUnrestricted

@NotNull
public List<ImmutableTopLevelPlan> getPlansUnrestricted()

Description copied from interface: CachedPlanManager

Returns all ImmutableTopLevelPlan's ignoring permissions.

Specified by:

getPlansUnrestricted in interface CachedPlanManager

Returns:

getPlans

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

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlans in interface FilteringPlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlans

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

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlans in interface FilteringPlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlansByProject

@NotNull
public List<ImmutableTopLevelPlan> getPlansByProject(Project project)

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlansByProject in interface FilteringPlanManager

Parameters:

project - - that the plans will belong to

Returns:

ImmutableTopLevelPlan plans contained within the given project

getEditablePlansByProject

@NotNull
public Iterable<ImmutableTopLevelPlan> getEditablePlansByProject(Project project)

Description copied from interface: FilteringPlanManager

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

Specified by:

getEditablePlansByProject in interface FilteringPlanManager

Parameters:

project - - that the plans will belong to

Returns:

editable plans for project

getPlansByProject

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

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlansByProject in interface FilteringPlanManager

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

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

Specified by:

getPlansByProject in interface FilteringPlanManager

getBranchesForChain

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, sorted

Specified by:

getBranchesForChain in interface FilteringPlanManager

Parameters:

chain - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchesOfChain

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, unsorted

Specified by:

getBranchesOfChain in interface FilteringPlanManager

Parameters:

chainKey - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchKeysOfChain

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

Description copied from interface: CachedPlanManager

Returns keys of all branches for the supplied chain.

Specified by:

getBranchKeysOfChain in interface CachedPlanManager

getBranchGistsOfChain

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

Description copied from interface: CachedPlanManager

Returns basic data of all branches for the supplied chain.

Specified by:

getBranchGistsOfChain in interface CachedPlanManager

getMasterPlan

@Nullable
public ImmutableChain getMasterPlan(@NotNull
                                              PlanKey branchKey)

Description copied from interface: CachedPlanManager

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.

Specified by:

getMasterPlan in interface CachedPlanManager

Parameters:

branchKey - key of a branch

Returns:

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

isBranchOf

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

Description copied from interface: CachedPlanManager

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

Specified by:

isBranchOf in interface CachedPlanManager

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

assertPlanPermission

public boolean assertPlanPermission(@NotNull
                                    PlanIdentifier plan)

Description copied from interface: FilteringPlanManager

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

Specified by:

assertPlanPermission in interface FilteringPlanManager

Parameters:

plan - to check the permissions of

Returns:

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

getPlansForClone

@NotNull
public List<ImmutableChain> getPlansForClone()

Description copied from interface: FilteringPlanManager

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

Specified by:

getPlansForClone in interface FilteringPlanManager

Returns:

plans

getRunnablePlans

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

Description copied from interface: FilteringPlanManager

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

Specified by:

getRunnablePlans in interface FilteringPlanManager

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

getMasterOfJob

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

Specified by:

getMasterOfJob in interface CachedPlanManager

getPlansWithRepository

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

Description copied from interface: CachedPlanManager

Returns chains that use repositories with given params

Specified by:

getPlansWithRepository in interface CachedPlanManager

getFilteredPlansWithRepository

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

Description copied from interface: FilteringPlanManager

Returns chains that use repositories with given params

Specified by:

getFilteredPlansWithRepository in interface FilteringPlanManager

getAnyPlan

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

Description copied from interface: CachedPlanManager

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

Specified by:

getAnyPlan in interface CachedPlanManager

Specified by:

getAnyPlan in interface FilteringPlanManager

getAnyPlanUnrestricted

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

Description copied from interface: CachedPlanManager

Returns a plan matching the supplied predicate.

Specified by:

getAnyPlanUnrestricted in interface CachedPlanManager

getPlanById

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

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its database id and Class

Specified by:

getPlanById in interface CachedPlanManager

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.

getPlanByIdNotThrowing

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

Description copied from interface: CachedPlanManager

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

Specified by:

getPlanByIdNotThrowing in interface CachedPlanManager

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

getAllProjectsWithPlan

public Set<Project> getAllProjectsWithPlan()

Description copied from interface: CachedPlanManager

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

Specified by:

getAllProjectsWithPlan in interface CachedPlanManager

Returns: