Package 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	Description
CachedPlanManagerImpl()

Method Summary

Modifier and Type	Method	Description
boolean	assertPlanPermission(@NotNull 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.
@NotNull List<ImmutableChainBranch>	getBranchesForChain(@NotNull PlanIdentifier chain)	Get all feature branches associated with the given chain, sorted.
@NotNull List<ImmutableChainBranch>	getBranchesForChainWithConsistencyGuarantee(@NotNull PlanIdentifier chain)	Get all feature branches associated with the given chain, sorted.
@NotNull Stream<ImmutableChainBranch>	getBranchesOfChain(@NotNull PlanKey chainKey)	Get all feature branches associated with the given chain, unsorted.
@NotNull Stream<ImmutableChainBranch>	getBranchesOfChainWithConsistencyGuarantee(@NotNull PlanKey chainKey)	Get all feature branches associated with the given chain, unsorted.
@NotNull Set<PlanBranchGist>	getBranchGistsOfChain(@NotNull PlanKey chainKey)	Returns basic data of all branches for the supplied chain.
@NotNull Set<PlanBranchGist>	getBranchGistsOfChainWithConsistencyGuarantee(@NotNull PlanKey chainKey)	Returns basic data of all branches for the supplied chain with guarantee that eventual new plan branches not present in the cache will be taken in consideration.
@NotNull Set<PlanKey>	getBranchKeysOfChain(@NotNull PlanKey chainKey)	Returns keys of all branches for the supplied chain.
@NotNull 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
@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.
<T extends ImmutablePlan> T	getPlanByIdNotThrowingWithConsistencyGuarantee(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.
<T extends ImmutablePlan> T	getPlanByKeyIfOfTypeWithConsistencyGuarantee(@NotNull PlanKey planKey, @NotNull Class<T> planType)	Returns a Plan by its planKey and if it's of the type Class.
@Nullable ImmutablePlan	getPlanByKeyWithConsistencyGuarantee(@NotNull PlanKey planKey)	Returns a ImmutablePlan by its planKey.
<T extends ImmutablePlan> T	getPlanByKeyWithConsistencyGuarantee(@NotNull PlanKey planKey, Class<T> planType)	Returns a ImmutablePlan by its planKey and Class.
@NotNull List<ImmutableTopLevelPlan>	getPlans()	Returns all TopLevelPlan's.
<T extends ImmutablePlan> @NotNull List<T>	getPlans(Class<T> planType)	Returns all Plan's filtered by Class.
<T extends ImmutablePlan> @NotNull List<T>	getPlans(Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)	Returns all Plan's filtered by Class.
<T extends ImmutablePlan> List<T>	getPlansByProject(@NotNull Project project, @NotNull Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)
@NotNull List<ImmutableTopLevelPlan>	getPlansByProject(Project project)	Returns all ImmutableTopLevelPlan's filtered by Project.
<T extends ImmutablePlan> @NotNull List<T>	getPlansByProject(Project project, Class<T> planType)	Returns all Plan's filtered by Project and Class.
@NotNull List<ImmutableChain>	getPlansByProjectUnrestricted(Project project)	Returns all ImmutableChain's filtered by Project ignoring permissions.
@NotNull List<ImmutableChain>	getPlansByProjectUnrestrictedWithConsistencyGuarantee(Project project)	Returns all ImmutableChain's filtered by Project ignoring permissions.
@NotNull List<ImmutableTopLevelPlan>	getPlansByProjectWithConsistencyGuarantee(Project project)	Returns all ImmutableTopLevelPlan's filtered by Project.
<T extends ImmutablePlan> @NotNull List<T>	getPlansByProjectWithConsistencyGuarantee(Project project, Class<T> planType)	Returns all Plan's filtered by Project and Class.
@NotNull List<ImmutableChain>	getPlansForClone()	Returns all Chain's.
@NotNull List<ImmutableTopLevelPlan>	getPlansUnrestricted()	Returns all ImmutableTopLevelPlan's ignoring permissions.
@NotNull List<ImmutableTopLevelPlan>	getPlansUnrestrictedWithConsistencyGuarantee()	Returns all ImmutableTopLevelPlan's ignoring permissions.
<T extends ImmutablePlan> @NotNull List<T>	getPlansWithConsistencyGuarantee(Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)	Returns all Plan's filtered by Class.
Iterable<ImmutableChain>	getPlansWithRepository(PlanRepositoryIndex.Query query)	Returns chains that use repositories with given params.
Iterable<ImmutableChain>	getPlansWithRepositoryWithConsistencyGuarantee(@NotNull PlanRepositoryIndex.Query query)	Returns chains that use repositories with given params.
<T extends ImmutablePlan> @NotNull List<T>	getRunnablePlans(@NotNull Project project, @NotNull Class<T> planType)	Returns all Plan's filtered by Project and Class.
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 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 @Nullable ImmutablePlan getPlanByKey(@NotNull
                                            @NotNull PlanKey planKey)

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlanByKey in interface CachedPlanManager

Parameters:

planKey - to search for

Returns:

plan with the given plan key or null if not found

getPlanByKeyWithConsistencyGuarantee

@Nullable
public @Nullable ImmutablePlan getPlanByKeyWithConsistencyGuarantee(@NotNull
                                                                    @NotNull PlanKey planKey)

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey. There is a guarantee that the data will be up-to-date.

Specified by:

getPlanByKeyWithConsistencyGuarantee 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
                                                @NotNull PlanKey planKey,
                                                Class<T> planType)
                                         throws IncorrectPlanTypeException

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey and Class. In clustered mode, there is NO consistency guarantee.

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

getPlanByKeyWithConsistencyGuarantee

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

Description copied from interface: CachedPlanManager

Returns a ImmutablePlan by its planKey and Class. There is a guarantee that the data will be up-to-date.

Specified by:

getPlanByKeyWithConsistencyGuarantee 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
                                                        @NotNull PlanKey planKey,
                                                        @NotNull
                                                        @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. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlanByKeyIfOfType in interface CachedPlanManager

Returns:

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

getPlanByKeyIfOfTypeWithConsistencyGuarantee

@Nullable
public <T extends ImmutablePlan> T getPlanByKeyIfOfTypeWithConsistencyGuarantee(@NotNull
                                                                                @NotNull PlanKey planKey,
                                                                                @NotNull
                                                                                @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. There is a guarantee that the data will be up-to-date.

Specified by:

getPlanByKeyIfOfTypeWithConsistencyGuarantee in interface CachedPlanManager

Returns:

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

getPlans

@NotNull
public @NotNull 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 @NotNull List<ImmutableTopLevelPlan> getPlansUnrestricted()

Description copied from interface: CachedPlanManager

Returns all ImmutableTopLevelPlan's ignoring permissions. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlansUnrestricted in interface CachedPlanManager

getPlansUnrestrictedWithConsistencyGuarantee

@NotNull
public @NotNull List<ImmutableTopLevelPlan> getPlansUnrestrictedWithConsistencyGuarantee()

Description copied from interface: CachedPlanManager

Returns all ImmutableTopLevelPlan's ignoring permissions. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansUnrestrictedWithConsistencyGuarantee in interface CachedPlanManager

getPlansByProjectUnrestricted

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

Description copied from interface: CachedPlanManager

Returns all ImmutableChain's filtered by Project ignoring permissions. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlansByProjectUnrestricted in interface CachedPlanManager

Parameters:

project - - that the plans will belong to

Returns:

ImmutableChain plans contained within the given project

getPlansByProjectUnrestrictedWithConsistencyGuarantee

@NotNull
public @NotNull List<ImmutableChain> getPlansByProjectUnrestrictedWithConsistencyGuarantee(Project project)

Description copied from interface: CachedPlanManager

Returns all ImmutableChain's filtered by Project ignoring permissions. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansByProjectUnrestrictedWithConsistencyGuarantee in interface CachedPlanManager

Parameters:

project - - that the plans will belong to

Returns:

ImmutableChain plans contained within the given project

getPlans

@NotNull
public <T extends ImmutablePlan> @NotNull 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> @NotNull List<T> getPlans(Class<T> planType,
                                                           @NotNull
                                                           @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. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlans in interface FilteringPlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlansWithConsistencyGuarantee

@NotNull
public <T extends ImmutablePlan> @NotNull List<T> getPlansWithConsistencyGuarantee(Class<T> planType,
                                                                                   @NotNull
                                                                                   @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. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansWithConsistencyGuarantee in interface FilteringPlanManager

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

getPlansByProject

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

Description copied from interface: FilteringPlanManager

Returns all ImmutableTopLevelPlan's filtered by Project. This method is Acegi-filtered. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlansByProject in interface FilteringPlanManager

Parameters:

project - - that the plans will belong to

Returns:

ImmutableTopLevelPlan plans contained within the given project

getPlansByProjectWithConsistencyGuarantee

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

Description copied from interface: FilteringPlanManager

Returns all ImmutableTopLevelPlan's filtered by Project. This method is Acegi-filtered. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansByProjectWithConsistencyGuarantee in interface FilteringPlanManager

Parameters:

project - - that the plans will belong to

Returns:

ImmutableTopLevelPlan plans contained within the given project

getEditablePlansByProject

@NotNull
public @NotNull 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> @NotNull 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. In clustered mode, there is NO consistency guarantee.

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

getPlansByProjectWithConsistencyGuarantee

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

Description copied from interface: FilteringPlanManager

Returns all Plan's filtered by Project and Class. This method is Acegi-filtered. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansByProjectWithConsistencyGuarantee 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
                                                           @NotNull Project project,
                                                           @NotNull
                                                           @NotNull Class<T> planType,
                                                           @NotNull
                                                           @NotNull com.google.common.base.Predicate<? super T> filter)

Specified by:

getPlansByProject in interface FilteringPlanManager

getBranchesForChain

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, sorted. In clustered mode, there is NO consistency guarantee.

Specified by:

getBranchesForChain in interface FilteringPlanManager

Parameters:

chain - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchesForChainWithConsistencyGuarantee

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, sorted. There is a guarantee that the data will be up-to-date.

Specified by:

getBranchesForChainWithConsistencyGuarantee in interface FilteringPlanManager

Parameters:

chain - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchesOfChain

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, unsorted. In clustered mode, there is NO consistency guarantee.

Specified by:

getBranchesOfChain in interface FilteringPlanManager

Parameters:

chainKey - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchesOfChainWithConsistencyGuarantee

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

Description copied from interface: FilteringPlanManager

Get all feature branches associated with the given chain, unsorted. There is a guarantee that the data will be up-to-date.

Specified by:

getBranchesOfChainWithConsistencyGuarantee in interface FilteringPlanManager

Parameters:

chainKey - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchKeysOfChain

@NotNull
public @NotNull Set<PlanKey> getBranchKeysOfChain(@NotNull
                                                  @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 @NotNull Set<PlanBranchGist> getBranchGistsOfChain(@NotNull
                                                          @NotNull PlanKey chainKey)

Description copied from interface: CachedPlanManager

Returns basic data of all branches for the supplied chain.

Specified by:

getBranchGistsOfChain in interface CachedPlanManager

getBranchGistsOfChainWithConsistencyGuarantee

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

Description copied from interface: CachedPlanManager

Returns basic data of all branches for the supplied chain with guarantee that eventual new plan branches not present in the cache will be taken in consideration.

Specified by:

getBranchGistsOfChainWithConsistencyGuarantee in interface CachedPlanManager

Parameters:

chainKey - the key of the chain

Returns:

highly-consistent list of branches' gists associated with a master plan identified by the given key, including eventual new branches not present in the database

getMasterPlan

@Nullable
public @Nullable ImmutableChain getMasterPlan(@NotNull
                                              @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
                          @NotNull PlanKey chainKey,
                          @NotNull
                          @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
                                    @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 @NotNull 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> @NotNull List<T> getRunnablePlans(@NotNull
                                                                   @NotNull Project project,
                                                                   @NotNull
                                                                   @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 @Nullable ImmutableJob getMasterOfJob(@NotNull
                                             @NotNull PlanKey masterChainKey,
                                             @NotNull
                                             @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. In clustered mode, there is NO consistency guarantee.

Specified by:

getPlansWithRepository in interface CachedPlanManager

getPlansWithRepositoryWithConsistencyGuarantee

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

Description copied from interface: CachedPlanManager

Returns chains that use repositories with given params. There is a guarantee that the data will be up-to-date.

Specified by:

getPlansWithRepositoryWithConsistencyGuarantee 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. In clustered mode, there is NO consistency guarantee.

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

getPlanByIdNotThrowingWithConsistencyGuarantee

@Nullable
public <T extends ImmutablePlan> T getPlanByIdNotThrowingWithConsistencyGuarantee(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. There is a guarantee that the data will be up-to-date.

Specified by:

getPlanByIdNotThrowingWithConsistencyGuarantee 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: