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.List<Build> getAllBuilds()
          Deprecated. 
 java.util.List<Chain> getAllChains()
          Returns all chains in the system
 java.util.List<TopLevelPlan> getAllTopLevelPlans()
          Returns all top level plans (plans and chains) in the system
 java.util.Collection<TopLevelPlan> getAllTopLevelPlansUpdatedSince(long systemTime)
          Returns all builds since a given time
 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
 TopLevelPlan 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

@Deprecated
@NotNull
java.util.List<Build> getAllBuilds()
Deprecated. 

Returns all builds in the system

Returns:
all builds in the system, empty collection if none found

getAllTopLevelPlans

@NotNull
java.util.List<TopLevelPlan> getAllTopLevelPlans()
Returns all top level plans (plans and chains) in the system

Returns:
all all top level plans in the system, empty collection if none found

resetCache

void resetCache()
Clears the cache


getAllTopLevelPlansUpdatedSince

java.util.Collection<TopLevelPlan> getAllTopLevelPlansUpdatedSince(long systemTime)
Returns all builds since a given time

Parameters:
systemTime -
Returns:

getPlan

TopLevelPlan 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.List<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


Copyright © 2010 Atlassian. All Rights Reserved.