com.ibm.wsspi.cache
Interface CacheStatistics


public interface CacheStatistics

This interface is used to monitor the cache. It is utilized by the WebSphere Cache Monitor application, which is shipped as a part of the WebSphere Application Server to administer and monitor the contents of the CoreCache

Since:
WAS 6.1.0.27

Method Summary
 long getCacheHitsCount()
          Statistics name: CacheHits
 long getCacheLruRemovesCount()
          Statistics name: CacheLruRemoves
 long getCacheMissesCount()
          Statistics name: CacheMisses
 long getCacheRemovesCount()
          Statistics name: CacheRemoves
 long getExplicitInvalidationsFromMemoryCount()
          Statistics name: ExplicitInvalidationsFromMemory
 java.util.Map<java.lang.String,java.lang.Number> getExtendedStats()
          Extended cache statistics specific to the cache provider
 long getMemoryCacheEntriesCount()
          Statistics name: MemoryCacheEntries
 float getMemoryCacheSizeInMBCount()
          Statistics name: MemoryCacheSizeInMB
 long getTimeoutInvalidationsFromMemoryCount()
          Statistics name: TimeoutInvalidationsFromMemory
 void reset()
          This is used to reset all statistics counters in the cache proivder excluding: MemoryCacheEntries MemoryCacheSizeInMB
 

Method Detail

getCacheHitsCount

long getCacheHitsCount()
Statistics name: CacheHits

Description: The total number of cache hits.

Returns:
The total number of cache hits.

getCacheLruRemovesCount

long getCacheLruRemovesCount()
Statistics name: CacheLruRemoves

Description: The number of memory-based least recently used (LRU) evictions. These correspond to the number of objects that are evicted from the memory cache, based on the LRU policy.

Returns:
The number of objects that are removed by LRU evictions

getCacheMissesCount

long getCacheMissesCount()
Statistics name: CacheMisses

Description: The total number of cache misses.

Returns:
The total number of cache misses.

getCacheRemovesCount

long getCacheRemovesCount()
Statistics name: CacheRemoves

Description: The total number of cache removes.

Returns:
The total number of cache removes.

getExplicitInvalidationsFromMemoryCount

long getExplicitInvalidationsFromMemoryCount()
Statistics name: ExplicitInvalidationsFromMemory

Description: Metric that captures the number of explicit invalidations that result in an entry being removed from memory.

Returns:
The total number of explicitly triggered invalidations from memory.

getExtendedStats

java.util.Map<java.lang.String,java.lang.Number> getExtendedStats()
Extended cache statistics specific to the cache provider

Returns:
Map of {cache statistic name --> Cache statistic value}

getMemoryCacheEntriesCount

long getMemoryCacheEntriesCount()
Statistics name: MemoryCacheEntries

Description: The number of cache entries in memory.

Returns:
The number of cache entries in memory.

getMemoryCacheSizeInMBCount

float getMemoryCacheSizeInMBCount()
Statistics name: MemoryCacheSizeInMB

Description: The size of the cache in terms of memory occupied on the JVM heap.

Returns:
The amount of JVM heap in MB occupied by the cache

getTimeoutInvalidationsFromMemoryCount

long getTimeoutInvalidationsFromMemoryCount()
Statistics name: TimeoutInvalidationsFromMemory

Description: Metric that captures the number of timeout invalidations that result in an entry being removed from memory.

Returns:
The total number of timeout invalidations from memory.

reset

void reset()
This is used to reset all statistics counters in the cache proivder excluding:
  1. MemoryCacheEntries
  2. MemoryCacheSizeInMB