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<Chain> getAllChains()
          Deprecated. since 3.0, use getAllTopLevelPlans()
 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
 Chain getChain(java.lang.String chainKey)
          Deprecated. since 3.0, use $getPlan(PlanKey)
 TopLevelPlan getPlan(PlanKey planKey)
          Returns the cached plan for a given planKey
 TopLevelPlan getPlan(java.lang.String planKey)
          Deprecated. since 3.0, use $getPlan(PlanKey)
 void removePlanFromCache(PlanKey planKey)
          Removes the plan from the cache
 void removePlanFromCache(java.lang.String planKey)
          Deprecated. since 3.0 us $removePlanFromCache(PlanKey)
 void resetCache()
          Clears the cache
 void updatePlanCache(java.util.Collection<PlanKey> planKeys)
          Refetches the passed plan keys from the database
 void updatePlanCache(PlanKey planKey)
          Refetches the passed plan key from the database
 void updatePlanCache(java.lang.String planKey)
          Deprecated. since 3.0 us $updatePlanCache(PlanKey)
 

Method Detail

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

getPlan

@Nullable
TopLevelPlan getPlan(@NotNull
                              PlanKey planKey)
Returns the cached plan for a given planKey

Parameters:
planKey -
Returns:

getAllTopLevelPlansUpdatedSince

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

Parameters:
systemTime -
Returns:

getPlan

@Nullable
@Deprecated
TopLevelPlan getPlan(@NotNull
                                         java.lang.String planKey)
Deprecated. since 3.0, use $getPlan(PlanKey)

Returns the cached plan for a given planKey

Parameters:
planKey -
Returns:

getChain

@Nullable
@Deprecated
Chain getChain(@NotNull
                                   java.lang.String chainKey)
Deprecated. since 3.0, use $getPlan(PlanKey)

Returns the cached chain for a given chainKey

Parameters:
chainKey -
Returns:

getAllChains

@NotNull
@Deprecated
java.util.List<Chain> getAllChains()
Deprecated. since 3.0, use getAllTopLevelPlans()

Returns all chains in the system

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

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
                     java.util.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

updatePlanCache

@Deprecated
void updatePlanCache(@NotNull
                                java.lang.String planKey)
Deprecated. since 3.0 us $updatePlanCache(PlanKey)

Refetches the passed plan key from the database

Parameters:
planKey - Key of the plan to be updated

removePlanFromCache

@Deprecated
void removePlanFromCache(@NotNull
                                    java.lang.String planKey)
Deprecated. since 3.0 us $removePlanFromCache(PlanKey)

Removes the plan from the cache

Parameters:
planKey - Key of the plan to be removed from cache


Copyright © 2011 Atlassian. All Rights Reserved.