ImmutablePlanCacheService (Atlassian Bamboo 6.9.1 API)

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

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`ImmutablePlanCacheService.CacheInvalidator`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cascadeInvalidate(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> List<T>`	`filterOutDeletedIfNeeded(List<T> stages)` Returns a list with deleted stages removed.
`<T extends PlanIdentifier> Set<T>`	`filterOutDeletedIfNeeded(Set<T> jobs)` Returns a set with deleted jobs removed.
`Optional<ImmutableChain>`	`getAnyPlan(Predicate<? super ImmutableChain> predicate)` Returns a plan matching the supplied predicate
`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.
`ImmutableChain`	`getImmutableChainByKeyIfInCache(PlanKey planKey)`
`ImmutableChain`	`getImmutablePlanByKey(PlanKey planKey)` Returns a plan if one exists with the key.
`PlanCacheIndices`	`getIndices()` Returns the indices created for plan cache content.
`<T extends ImmutablePlan> Stream<T>`	`getPlans(Class<T> planType, 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(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(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)` Resets the latest build summary of a plan.
`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(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
ImmutableChain getImmutablePlanByKey(@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> Stream<T> getPlans(Class<T> planType,
                                                      @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
ImmutableChain getImmutableChainByKeyIfInCache(@NotNull
                                                         PlanKey planKey)
```
  - invalidate
```
void invalidate(@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
                       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
            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.
  - 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
PlanCacheIndices getIndices()
```
    Returns the indices created for plan cache content.
  - getBuildNumbersRange
```
@Deprecated
 @Internal
 @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)
```
    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.
  - indexPlan
```
@Internal
void indexPlan(@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 PlanIdentifier> Set<T> filterOutDeletedIfNeeded(@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> List<T> filterOutDeletedIfNeeded(@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)
```

Interface ImmutablePlanCacheService

Nested Class Summary

Method Summary

Method Detail

getImmutablePlanByKey

getPlans

withHiddenPlans

getImmutableChainByKeyIfInCache

invalidate

cascadeInvalidate

remove

initialiseCache

disableCache

enableCache

getCacheStats

getChainsToInvalidateAndReindex

getIndices

getBuildNumbersRange

invalidateBuildNumbersRange

getPlans

getAnyPlan

invalidateLatestResultSummary

invalidateAllLatestResultSummaries

indexPlan

hideDeletedPlan

hideDeletedStage

isPlanBeingDeleted

enterDeletionCodeSection

leaveDeletionCodeSection

filterOutDeletedIfNeeded

filterOutDeletedIfNeeded

onStageDeleted