org.apache.jetspeed.cache
Interface JetspeedCacheMonitor

public interface JetspeedCacheMonitor

Monitor active Jetspeed Caches by retrieving snapshots of cache statistics, recalculating cache statistics, and resetting the cache statistics Warning, the methods calculateStatistics can be computationally expensive

Version:

$Id: JetspeedCacheMonitor.java 773303 2009-05-10 03:34:13Z taylor $

Author:

David Sean Taylor

Method Summary

java.util.List<CacheMonitorState>	calculateStatistics() Recalculate the statistics for all caches, including cache size calculations.
CacheMonitorState	calculateStatistics(java.lang.String cacheName) Recalculate the statistics for the given cache, including cache size calculations.
void	resetStatistics() Reset the statistics for all caches
void	resetStatistics(java.lang.String cacheName) Reset the statistics for the given cache
java.util.List<CacheMonitorState>	snapshotStatistics() Retrieve a snapshot of all cache states and statistics
CacheMonitorState	snapshotStatistics(java.lang.String cacheName) Retrieve a snapshot of a single cache states and statistics without performing expensive object count calculations

Method Detail

snapshotStatistics

java.util.List<CacheMonitorState> snapshotStatistics()

Retrieve a snapshot of all cache states and statistics

Returns:

a list of cache states

snapshotStatistics

CacheMonitorState snapshotStatistics(java.lang.String cacheName)

Retrieve a snapshot of a single cache states and statistics without performing expensive object count calculations

Parameters:

cacheName - the name of the cache

Returns:

a single cache statistics snapshot

resetStatistics

void resetStatistics()

Reset the statistics for all caches

resetStatistics

void resetStatistics(java.lang.String cacheName)

Reset the statistics for the given cache

Parameters:

cacheName - the name of the cache

calculateStatistics

java.util.List<CacheMonitorState> calculateStatistics()

Recalculate the statistics for all caches, including cache size calculations. This may take considerable amount of time depending on the size of the caches.

Returns:

new statistics list freshly calculated

calculateStatistics

CacheMonitorState calculateStatistics(java.lang.String cacheName)

Recalculate the statistics for the given cache, including cache size calculations. This may take considerable amount of time depending on the size of the caches.

Parameters:

cacheName - the name of the cache

Returns:

new statistics freshly calculated