com.atlassian.bamboo.plan.cache

Class ImmutablePlanCacheServiceImpl

java.lang.Object

com.atlassian.bamboo.plan.cache.ImmutablePlanCacheServiceImpl

All Implemented Interfaces:

ImmutablePlanCacheService

public class ImmutablePlanCacheServiceImpl
extends Object
implements ImmutablePlanCacheService

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlanCacheService

ImmutablePlanCacheService.CacheInvalidator

Constructor Summary

Constructors

Constructor and Description
ImmutablePlanCacheServiceImpl(ImmutablePlanManager immutablePlanManager, PlanDao planDao, com.atlassian.config.db.HibernateConfig hibernateConfig, CustomVariableContext customVariableContext, BuildResultsSummaryDao buildResultsSummaryDao, VcsRepositoryManager vcsRepositoryManager)

Method Summary

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.
Optional<ImmutableChain>	getAnyPlan(Predicate<? super ImmutableChain> predicate) Returns a plan matching the supplied predicate
Range<Integer>	getBuildNumbersRange(PlanKey planKey) internal use only.
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.
<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	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) internal use only.
void	remove(PlanKey planKey) Removes the cached Plan and its metadata.
void	resetLatestResultSummary(PlanResultKey planResultKey) Resets the latest build summary of a plan.
<T> T	withHiddenPlans(Collection<PlanKey> planKeys, Supplier<T> supplier) Invokes supplier while marking the specified plan keys as unavailable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutablePlanCacheServiceImpl

public ImmutablePlanCacheServiceImpl(@NotNull
                                     ImmutablePlanManager immutablePlanManager,
                                     @NotNull
                                     PlanDao planDao,
                                     @NotNull
                                     com.atlassian.config.db.HibernateConfig hibernateConfig,
                                     @NotNull
                                     CustomVariableContext customVariableContext,
                                     @NotNull
                                     BuildResultsSummaryDao buildResultsSummaryDao,
                                     @NotNull
                                     VcsRepositoryManager vcsRepositoryManager)

Method Detail

getImmutablePlanByKey

@Nullable
public ImmutableChain getImmutablePlanByKey(@NotNull
                                                      PlanKey planKey)

Description copied from interface: ImmutablePlanCacheService

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.

Specified by:

getImmutablePlanByKey in interface ImmutablePlanCacheService

See Also:

ImmutablePlanCacheService.withHiddenPlans(Collection, Supplier)

invalidate

public void invalidate(@NotNull
                       PlanKey planKey)

Description copied from interface: ImmutablePlanCacheService

Removes the cached Plan. Retains Plan metadata.

Specified by:

invalidate in interface ImmutablePlanCacheService

Parameters:

planKey - key of the Plan to be removed from cache

cascadeInvalidate

public void cascadeInvalidate(@NotNull
                              PlanKey planKey)

Description copied from interface: ImmutablePlanCacheService

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

Specified by:

cascadeInvalidate in interface ImmutablePlanCacheService

Parameters:

planKey - key of the Plan to be removed from cache

getChainsToInvalidate

@NotNull
public Iterable<PlanKey> getChainsToInvalidate(@NotNull
                                                        ImmutablePlanCacheService.CacheInvalidator invalidator)

Description copied from interface: ImmutablePlanCacheService

Internal. Calls apply on the supplied ImmutablePlanCacheService.CacheInvalidator

Specified by:

getChainsToInvalidate in interface ImmutablePlanCacheService

remove

public void remove(@NotNull
                   PlanKey planKey)

Description copied from interface: ImmutablePlanCacheService

Removes the cached Plan and its metadata.

Specified by:

remove in interface ImmutablePlanCacheService

Parameters:

planKey - key of the Plan to be removed from cache

initialiseCache

public void initialiseCache()

Description copied from interface: ImmutablePlanCacheService

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.

Specified by:

initialiseCache in interface ImmutablePlanCacheService

disableCache

public void disableCache()

Description copied from interface: ImmutablePlanCacheService

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.

Specified by:

disableCache in interface ImmutablePlanCacheService

enableCache

public void enableCache()

Description copied from interface: ImmutablePlanCacheService

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

Specified by:

enableCache in interface ImmutablePlanCacheService

getCacheStats

public BambooCacheStats getCacheStats()

Description copied from interface: ImmutablePlanCacheService

Retrieve cache statistics

Specified by:

getCacheStats in interface ImmutablePlanCacheService

Returns:

Cache statistics

getIndices

@NotNull
public PlanCacheIndices getIndices()

Description copied from interface: ImmutablePlanCacheService

Returns the indices created for plan cache content.

Specified by:

getIndices in interface ImmutablePlanCacheService

getPlans

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

Description copied from interface: ImmutablePlanCacheService

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

Specified by:

getPlans in interface ImmutablePlanCacheService

Parameters:

planType - - the type of the plan to retrieve

Returns:

plans sorted by DescriptionProvider.getName()

withHiddenPlans

public <T> T withHiddenPlans(Collection<PlanKey> planKeys,
                             Supplier<T> supplier)

Description copied from interface: ImmutablePlanCacheService

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.

Specified by:

withHiddenPlans in interface ImmutablePlanCacheService

Returns:

the value produced by supplier.

getBuildNumbersRange

@NotNull
public Range<Integer> getBuildNumbersRange(PlanKey planKey)

Description copied from interface: ImmutablePlanCacheService

internal use only.

Specified by:

getBuildNumbersRange in interface ImmutablePlanCacheService

invalidateBuildNumbersRange

public void invalidateBuildNumbersRange(PlanKey planKey,
                                        int buildNumber,
                                        boolean trueForSaveFalseForDelete)

Description copied from interface: ImmutablePlanCacheService

internal use only.

Specified by:

invalidateBuildNumbersRange in interface ImmutablePlanCacheService

getPlans

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

Description copied from interface: ImmutablePlanCacheService

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

Specified by:

getPlans in interface ImmutablePlanCacheService

getAnyPlan

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

Description copied from interface: ImmutablePlanCacheService

Returns a plan matching the supplied predicate

Specified by:

getAnyPlan in interface ImmutablePlanCacheService

resetLatestResultSummary

public void resetLatestResultSummary(PlanResultKey planResultKey)

Description copied from interface: ImmutablePlanCacheService

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.

Specified by:

resetLatestResultSummary in interface ImmutablePlanCacheService