@ExperimentalApi
@Internal
public interface ImmutablePlanCacheService
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()
)
CachedPlanManager
instead.
In 3.4, only used for Dashboard CacheModifier and Type | Interface and Description |
---|---|
static interface |
ImmutablePlanCacheService.CacheInvalidator |
Modifier and Type | Method and Description |
---|---|
void |
cascadeInvalidate(long planId)
Removes the cached reference for the passed plan and its children.
|
void |
cascadeInvalidate(PlanKey planKey)
Removes the cached reference for the passed plan and its children.
|
void |
disableCache()
Disable cache.
|
void |
enableCache()
Enable cache.
|
Range<Integer> |
getBuildNumbersRange(PlanKey planKey)
Deprecated.
since 5.10
|
BambooCacheStats |
getCacheStats()
Retrieve cache statistics
|
Iterable<PlanKey> |
getChainsToInvalidate(ImmutablePlanCacheService.CacheInvalidator invalidator)
Internal.
|
ImmutableChain |
getImmutablePlanByKey(PlanKey planKey)
Returns a plan if one exists with the key.
|
PlanCacheIndices |
getIndices()
Returns the indices created for plan cache content.
|
ReentrantReadWriteLock |
getLock(PlanKey planKey)
Makes plan inaccessible
|
Integer |
getNextBuildNumberOverride(PlanKey planKey)
Deprecated.
since 5.10
|
PlanIdentifier |
getPlanIdentifierForPermissionCheckingByKey(PlanKey planKey)
Deprecated.
|
<T extends ImmutablePlan> |
getPlans(Class<T> planType)
|
<T extends ImmutablePlan> |
getPlans(Class<T> planType,
com.google.common.base.Predicate<? super T> filter)
|
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 |
invalidateBuildNumbersRange(PlanKey planKey,
int buildNumber,
boolean trueForSaveFalseForDelete)
Deprecated.
since 5.10
|
void |
reset(PlanKey planKey)
Removes the cached Plan and its metadata.
|
void |
resetAll()
Nukes the cache
|
void |
setNextBuildNumberOverride(PlanKey planKey,
int nextBuildNumber)
Deprecated.
since 5.10
|
@Nullable ImmutableChain getImmutablePlanByKey(@NotNull PlanKey planKey)
planKey
- @NotNull <T extends ImmutablePlan> List<T> getPlans(Class<T> planType)
planType
- - the type of the plan to retrieveDescriptionProvider.getName()
@NotNull <T extends ImmutablePlan> List<T> getPlans(Class<T> planType, @NotNull com.google.common.base.Predicate<? super T> filter)
planType
- - the type of the plan to retrieveDescriptionProvider.getName()
@Nullable @Deprecated PlanIdentifier getPlanIdentifierForPermissionCheckingByKey(@NotNull PlanKey planKey)
CachedPlanManager.getPlanByKey(com.atlassian.bamboo.plan.PlanKey)
ReentrantReadWriteLock getLock(@NotNull PlanKey planKey)
planKey
- key of the Plan to be made inaccessiblevoid invalidate(@NotNull PlanKey planKey)
planKey
- key of the Plan to be removed from cachevoid cascadeInvalidate(@NotNull PlanKey planKey)
planKey
- key of the Plan to be removed from cachevoid cascadeInvalidate(long planId)
planId
- void reset(@NotNull PlanKey planKey)
planKey
- key of the Plan to be removed from cachevoid resetAll()
void initialiseCache()
void disableCache()
void enableCache()
initialiseCache()
instead if you expect plans to be loaded.BambooCacheStats getCacheStats()
@Deprecated @Internal void setNextBuildNumberOverride(PlanKey planKey, int nextBuildNumber)
@Deprecated @Internal @Nullable Integer getNextBuildNumberOverride(PlanKey planKey)
@Internal @NotNull Iterable<PlanKey> getChainsToInvalidate(@NotNull ImmutablePlanCacheService.CacheInvalidator invalidator)
ImmutablePlanCacheService.CacheInvalidator
invalidator
- @NotNull PlanCacheIndices getIndices()
@Deprecated @Internal @NotNull Range<Integer> getBuildNumbersRange(PlanKey planKey)
@Deprecated @Internal void invalidateBuildNumbersRange(PlanKey planKey, int buildNumber, boolean trueForSaveFalseForDelete)
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.