com.atlassian.bamboo.caching
Interface DashboardCachingManager

All Known Implementing Classes:

DashboardCachingManagerImpl

public interface DashboardCachingManager

Interface for viewing the dashboard. Should never be used for updates

Method Summary

List<ImmutableChain>	getAllChains() Returns all chains (including chain branches) in the system
List<ImmutableTopLevelPlan>	getAllTopLevelPlans() Returns all top level plans (i.e.
com.google.common.collect.ImmutableCollection<ImmutableChain>	getAllTopLevelPlansUnsorted()
List<ImmutableTopLevelPlan>	getAllTopLevelPlansUpdatedSince(long systemTime) Returns all builds since a given time
ImmutableChain	getPlan(PlanKey planKey) Returns the cached plan for a given planKey
void	initCaches() Initialises the caches
void	removePlanFromCache(PlanKey planKey) Removes the plan from the cache
void	removePlansFromCache(Iterable<PlanKey> planKeys)
void	resetCache() Clears the cache
void	updatePlanCache(Collection<PlanKey> planKeys) Refetches the passed plan keys from the database
void	updatePlanCache(PlanKey planKey) Refetches the passed plan key from the database

Method Detail

getAllTopLevelPlans

@NotNull
List<ImmutableTopLevelPlan> getAllTopLevelPlans()

Returns all top level plans (i.e. top level chains) in the system

Returns:

sorted copy of list of all top level plans in the system, empty collection if none found

getAllTopLevelPlansUnsorted

com.google.common.collect.ImmutableCollection<ImmutableChain> getAllTopLevelPlansUnsorted()

getAllChains

@NotNull
List<ImmutableChain> getAllChains()

Returns all chains (including chain branches) in the system

Returns:

sorted copy of list of all chains in the system, empty if none found

getPlan

@Nullable
ImmutableChain getPlan(@NotNull
                                PlanKey planKey)

Returns the cached plan for a given planKey

Parameters:

planKey -

Returns:

getAllTopLevelPlansUpdatedSince

List<ImmutableTopLevelPlan> getAllTopLevelPlansUpdatedSince(long systemTime)

Returns all builds since a given time

Parameters:

systemTime -

Returns:

initCaches

void initCaches()

Initialises the caches

resetCache

void resetCache()

Clears the cache

updatePlanCache

void updatePlanCache(@NotNull
                     PlanKey planKey)

Refetches the passed plan key from the database

Parameters:

planKey - Key of the plan to be updated

updatePlanCache

void updatePlanCache(@NotNull
                     Collection<PlanKey> planKeys)

Refetches the passed plan keys from the database

Parameters:

planKeys - Keys of the plan to be updated

removePlanFromCache

void removePlanFromCache(@NotNull
                         PlanKey planKey)

Removes the plan from the cache

Parameters:

planKey - Key of the plan to be removed from cache

removePlansFromCache

void removePlansFromCache(@NotNull
                          Iterable<PlanKey> planKeys)