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

java.util.Collection<Build>	getAllBuilds() Returns all builds in the system
java.util.Collection<Build>	getAllBuildsUpdatedSince(long systemTime) Returns all builds since a given time
java.util.Collection<Chain>	getAllChains() Returns all chains in the system
Build	getBuild(java.lang.String buildKey) Returns the cached Build for a given buildKey
Chain	getChain(java.lang.String chainKey) Returns the cached chain for a given chainKey
Plan	getPlan(java.lang.String planKey) Returns the cached plan for a given planKey
void	removePlanFromCache(java.lang.String planKey) Removes the plan from the cache
void	resetCache() Clears the cache
void	updatePlanCache(java.lang.String planKey) Refetches the passed plan key from the database

Method Detail

getAllBuilds

@NotNull
java.util.Collection<Build> getAllBuilds()

Returns all builds in the system

Returns:

all builds in the system, empty collection if none found

resetCache

void resetCache()

Clears the cache

getAllBuildsUpdatedSince

java.util.Collection<Build> getAllBuildsUpdatedSince(long systemTime)

Returns all builds since a given time

Parameters:

systemTime -

Returns:

getPlan

Plan getPlan(@NotNull
             java.lang.String planKey)

Returns the cached plan for a given planKey

Parameters:

planKey -

Returns:

getBuild

Build getBuild(@NotNull
               java.lang.String buildKey)

Returns the cached Build for a given buildKey

Parameters:

buildKey -

Returns:

getChain

Chain getChain(@NotNull
               java.lang.String chainKey)

Returns the cached chain for a given chainKey

Parameters:

chainKey -

Returns:

getAllChains

@NotNull
java.util.Collection<Chain> getAllChains()

Returns all chains in the system

Returns:

all chains in the system, empty collection if none found

updatePlanCache

void updatePlanCache(@NotNull
                     java.lang.String planKey)

Refetches the passed plan key from the database

Parameters:

planKey - Key of the plan to be updated

removePlanFromCache

void removePlanFromCache(@NotNull
                         java.lang.String planKey)

Removes the plan from the cache

Parameters:

planKey - Key of the plan to be removed from cache