org.apereo.cas.monitor

Class EhCacheStatistics

java.lang.Object

org.apereo.cas.monitor.EhCacheStatistics

All Implemented Interfaces:

CacheStatistics

public class EhCacheStatistics
extends java.lang.Object
implements CacheStatistics

Ehcache statistics wrapper.

Since:

3.5.1

Constructor Summary

Constructors

Constructor and Description
EhCacheStatistics(net.sf.ehcache.Cache cache) Creates a new instance that delegates statistics inquiries to the given Cache instance.

Method Summary

Modifier and Type	Method and Description
long	getCapacity() Gets the heap memory capacity of the cache.
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.
long	getPercentFree() Gets the percent free capacity remaining in the cache.
long	getSize() Gets the size of heap consumed by items stored in the cache.
java.lang.String	toString(java.lang.StringBuilder builder) Writes a string representation of cache statistics to the given string builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EhCacheStatistics

public EhCacheStatistics(net.sf.ehcache.Cache cache)

Creates a new instance that delegates statistics inquiries to the given Cache instance.

Parameters:

cache - Cache instance for which to gather statistics.

Method Detail

getSize

public long getSize()

Gets the size of heap consumed by items stored in the cache.

Specified by:

getSize in interface CacheStatistics

Returns:

Memory size.

getCapacity

public long getCapacity()

Gets the heap memory capacity of the cache.

Specified by:

getCapacity in interface CacheStatistics

Returns:

Heap memory capacity.

getEvictions

public long getEvictions()

Description copied from interface: CacheStatistics

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

Specified by:

getEvictions in interface CacheStatistics

Returns:

Eviction count.

getPercentFree

public long getPercentFree()

Description copied from interface: CacheStatistics

Gets the percent free capacity remaining in the cache.

Specified by:

getPercentFree in interface CacheStatistics

Returns:

Percent of space/capacity free.

getName

public java.lang.String getName()

Description copied from interface: CacheStatistics

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

Specified by:

getName in interface CacheStatistics

Returns:

Name of cache instance/host to which statistics apply.

toString

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

Description copied from interface: CacheStatistics

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

Specified by:

toString in interface CacheStatistics

Parameters:

builder - String builder to which string representation is appended.

Returns:

the string