org.apereo.cas.monitor

Interface CacheStatistics

All Known Implementing Classes:

EhCacheStatistics, HazelcastHealthIndicator.HazelcastStatistics, MongoDbCacheStatistics, SimpleCacheStatistics

public interface CacheStatistics

Describes the simplest set of cache statistics that are meaningful for health monitoring.

Since:

3.5.1

Method Summary

Modifier and Type	Method and Description
default long	getCapacity() Gets the current capacity of the cache in a unit specific to the cache being monitored (e.g.
default long	getEvictions() Gets the number of items evicted from the cache in order to make space for new items.
java.lang.String	getName() Gets a descriptive name of the cache instance for which statistics apply.
default long	getPercentFree() Gets the percent free capacity remaining in the cache.
default long	getSize() Gets the current size of the cache in a unit specific to the cache being monitored (e.g.
java.lang.String	toString(java.lang.StringBuilder builder) Writes a string representation of cache statistics to the given string builder.

Method Detail

getSize

default long getSize()

Gets the current size of the cache in a unit specific to the cache being monitored (e.g. bytes, items, etc).

Returns:

Current cache size.

getCapacity

default long getCapacity()

Gets the current capacity of the cache in a unit specific to the cache being monitored (e.g. bytes, items, etc).

Returns:

Current cache capacity.

getEvictions

default long getEvictions()

Gets the number of items evicted from the cache in order to make space for new items.

Returns:

Eviction count.

getPercentFree

default long getPercentFree()

Gets the percent free capacity remaining in the cache.

Returns:

Percent of space/capacity free.

getName

java.lang.String getName()

Gets a descriptive name of the cache instance for which statistics apply.

Returns:

Name of cache instance/host to which statistics apply.

toString

java.lang.String toString(java.lang.StringBuilder builder)

Writes a string representation of cache statistics to the given string builder.

Parameters:

builder - String builder to which string representation is appended.

Returns:

the string