com.atlassian.bamboo.plan.cache

Interface ImmutablePlanCacheService

All Known Implementing Classes:

ImmutablePlanCacheServiceImpl

@Internal
public interface ImmutablePlanCacheService

An experimental API for getting immutable, weakly held, cached ImmutableChain. This Service does not check for permissions currently. Only works for Chain. Cache is disabled by default and should be explicitly enabled by application (preferably by calling initialiseCache())
Concepts:

cache invalidation

Temporary removal of plan from cache (ie as an effect of changed plan configuration). Cache invalidation will remove Plan from cache but will not remove metadata information (ie planKey->id mapping)

cache reset

Permament removal of plan from cache (ie as an effect of plan deletion or move to another project). Cache reset will remove Plan and all related data from the cache.

This class is for internal use only, you should probably be using CachedPlanManager instead.

Since:

v3.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ImmutablePlanCacheService.CacheInvalidator

Method Summary

Modifier and Type	Method and Description
void	cascadeInvalidate(@NotNull PlanKey planKey) Removes the cached reference for the passed plan and its children.
void	disableCache() Disable cache.
void	enableCache() Enable cache.
void	enterDeletionCodeSection() Marks the current thread as being able to see deleted plans.
<T extends ImmutableChainStage> @NotNull List<T>	filterOutDeletedIfNeeded(@NotNull List<T> stages) Returns a list with deleted stages removed.
<T extends ImmutableJob> @NotNull Set<T>	filterOutDeletedIfNeeded(@NotNull Set<T> jobs) Returns a set with deleted jobs removed.
Optional<ImmutableChain>	getAnyPlan(Predicate<? super ImmutableChain> predicate) Returns a plan matching the supplied predicate
@NotNull Range<Integer>	getBuildNumbersRange(PlanKey planKey) Deprecated. since 5.10
BambooCacheStats	getCacheStats() Retrieve cache statistics
void	getChainsToInvalidateAndReindex(ImmutablePlanCacheService.CacheInvalidator invalidator, Set<PlanKey> chainsToInvalidate, Set<PlanKey> chainsToReindex) Internal.
@Nullable ImmutableChain	getImmutableChainByKeyIfInCache(@NotNull PlanKey planKey)
@Nullable ImmutableChain	getImmutablePlanByKey(@NotNull PlanKey planKey) Returns a plan if one exists with the key.
@NotNull PlanCacheIndices	getIndices() Returns the indices created for plan cache content.
<T extends ImmutablePlan> @NotNull Stream<T>	getPlans(Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter) Returns all Plan's filtered by Class.
Stream<ImmutablePlan>	getPlans(Predicate<ImmutablePlan> predicate) Returns a stream of plans (chains+jobs) matching the supplied predicate.
void	hideDeletedPlan(PlanKey planKey) Hides the plan.
void	hideDeletedStage(Long stageId) Hides the stage.
void	indexPlan(@NotNull ImmutableChain plan) Updates plan indexes in cache
void	initialiseCache() Clear the cache and attempt to read all Chains from DB in order to cache them.
void	invalidate(@NotNull PlanKey planKey) Removes the cached Plan.
void	invalidateAllLatestResultSummaries() Invalidates all latest result summaries currently cached.
void	invalidateBuildNumbersRange(PlanKey planKey, int buildNumber, boolean trueForSaveFalseForDelete) Deprecated. since 5.10
void	invalidateLatestResultSummary(PlanResultKey key, boolean resetAverageBuildDuration) Resets the latest build summary of a plan.
void	invalidateSpecsStateForPlan(@NotNull PlanKey planKey, @Nullable ImmutableVcsBambooSpecsSource immutableVcsBambooSpecsSource) Invalidate specs state.
boolean	isCacheEnabled()
boolean	isPlanBeingDeleted(PlanKey planKey)
void	leaveDeletionCodeSection() Marks the current thread as no longer being able to see deleted plans.
void	onStageDeleted(long stageId)
void	remove(@NotNull PlanKey planKey) Removes the cached Plan and its metadata.
<V> V	withHiddenPlans(Collection<PlanKey> planKeys, Supplier<V> supplier) Invokes supplier while marking the specified plan keys as unavailable.

Method Detail

getImmutablePlanByKey

@Nullable
@Nullable ImmutableChain getImmutablePlanByKey(@NotNull
                                                         @NotNull PlanKey planKey)

Returns a plan if one exists with the key. Returns null if the plan doesn't exist or if the cache entry is currently inaccessible because it is locked by another caller.

See Also:

withHiddenPlans(Collection, Supplier)

getPlans

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

Returns all Plan's filtered by Class. Does not include plans marked for deletion.

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

withHiddenPlans

<V> V withHiddenPlans(Collection<PlanKey> planKeys,
                      Supplier<V> supplier)

Invokes supplier while marking the specified plan keys as unavailable. Other callers will not be able to access the cache entries for the specified plans while the supplier is executing. The write locks will be obtained in a deterministic order to avoid deadlocks.

Returns:

the value produced by supplier.

getImmutableChainByKeyIfInCache

@Nullable
@Nullable ImmutableChain getImmutableChainByKeyIfInCache(@NotNull
                                                                   @NotNull PlanKey planKey)

invalidate

void invalidate(@NotNull
                @NotNull PlanKey planKey)

Removes the cached Plan. Retains Plan metadata.

Parameters:

planKey - key of the Plan to be removed from cache

cascadeInvalidate

void cascadeInvalidate(@NotNull
                       @NotNull PlanKey planKey)

Removes the cached reference for the passed plan and its children. Currently only propagates invalidation from Chain to ChainBranch

Parameters:

planKey - key of the Plan to be removed from cache

remove

void remove(@NotNull
            @NotNull PlanKey planKey)

Removes the cached Plan and its metadata.

Parameters:

planKey - key of the Plan to be removed from cache

initialiseCache

void initialiseCache()

Clear the cache and attempt to read all Chains from DB in order to cache them. If cache was disabled it will be enabled by this method.

disableCache

void disableCache()

Disable cache. When cache is disabled all cache requests will be logged with severity WARN until cache will be enabled again. This method will clear cache.

enableCache

void enableCache()

Enable cache. This method will not load anything when it is enabled, you should consider calling initialiseCache() instead if you expect plans to be loaded.

isCacheEnabled

boolean isCacheEnabled()

Returns:

true if cache is enabled

Since:

8.0

getCacheStats

BambooCacheStats getCacheStats()

Retrieve cache statistics

Returns:

Cache statistics

getChainsToInvalidateAndReindex

@Internal
void getChainsToInvalidateAndReindex(ImmutablePlanCacheService.CacheInvalidator invalidator,
                                               Set<PlanKey> chainsToInvalidate,
                                               Set<PlanKey> chainsToReindex)

Internal.

getIndices

@NotNull
@NotNull PlanCacheIndices getIndices()

Returns the indices created for plan cache content.

getBuildNumbersRange

@Deprecated
 @Internal
 @NotNull
@NotNull Range<Integer> getBuildNumbersRange(PlanKey planKey)

Deprecated. since 5.10

internal use only.

invalidateBuildNumbersRange

@Deprecated
 @Internal
void invalidateBuildNumbersRange(PlanKey planKey,
                                                        int buildNumber,
                                                        boolean trueForSaveFalseForDelete)

Deprecated. since 5.10

internal use only.

getPlans

Stream<ImmutablePlan> getPlans(Predicate<ImmutablePlan> predicate)

Returns a stream of plans (chains+jobs) matching the supplied predicate.

getAnyPlan

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

Returns a plan matching the supplied predicate

Parameters:

predicate -

invalidateLatestResultSummary

void invalidateLatestResultSummary(PlanResultKey key,
                                   boolean resetAverageBuildDuration)

Resets the latest build summary of a plan. No op if we already cache a later plan result or we don't have plan or result cached.

invalidateAllLatestResultSummaries

void invalidateAllLatestResultSummaries()

Invalidates all latest result summaries currently cached.

invalidateSpecsStateForPlan

void invalidateSpecsStateForPlan(@NotNull
                                 @NotNull PlanKey planKey,
                                 @Nullable
                                 @Nullable ImmutableVcsBambooSpecsSource immutableVcsBambooSpecsSource)

Invalidate specs state.

Parameters:

planKey - plan key

immutableVcsBambooSpecsSource - new state

indexPlan

@Internal
void indexPlan(@NotNull
                         @NotNull ImmutableChain plan)

Updates plan indexes in cache

hideDeletedPlan

void hideDeletedPlan(PlanKey planKey)

Hides the plan. Only the deletion thread will see it.

hideDeletedStage

void hideDeletedStage(Long stageId)

Hides the stage. Only the deletion thread will see it.

isPlanBeingDeleted

boolean isPlanBeingDeleted(PlanKey planKey)

enterDeletionCodeSection

void enterDeletionCodeSection()

Marks the current thread as being able to see deleted plans.

leaveDeletionCodeSection

void leaveDeletionCodeSection()

Marks the current thread as no longer being able to see deleted plans.

filterOutDeletedIfNeeded

@NotNull
<T extends ImmutableJob> @NotNull Set<T> filterOutDeletedIfNeeded(@NotNull
                                                                           @NotNull Set<T> jobs)

Returns a set with deleted jobs removed. When running under deletion code, returns the same set.

filterOutDeletedIfNeeded

@NotNull
<T extends ImmutableChainStage> @NotNull List<T> filterOutDeletedIfNeeded(@NotNull
                                                                                   @NotNull List<T> stages)

Returns a list with deleted stages removed. When running under deletion code, returns the same list.

onStageDeleted

void onStageDeleted(long stageId)