org.apereo.cas.monitor

Class MongoDbCacheStatistics

java.lang.Object

org.apereo.cas.monitor.MongoDbCacheStatistics

All Implemented Interfaces:

CacheStatistics

public class MongoDbCacheStatistics
extends java.lang.Object
implements CacheStatistics

This is MongoDbCacheStatistics.

Since:

5.2.0

Constructor Summary

Constructors

Constructor and Description
MongoDbCacheStatistics(com.mongodb.DBCollection collection)

Method Summary

Modifier and Type	Method and Description
long	getCapacity() Gets the current capacity of the cache in a unit specific to the cache being monitored (e.g.
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 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.monitor.CacheStatistics

getEvictions

Constructor Detail

MongoDbCacheStatistics

public MongoDbCacheStatistics(com.mongodb.DBCollection collection)

Method Detail

getSize

public long getSize()

Description copied from interface: CacheStatistics

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

Specified by:

getSize in interface CacheStatistics

Returns:

Current cache size.

getCapacity

public long getCapacity()

Description copied from interface: CacheStatistics

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

Specified by:

getCapacity in interface CacheStatistics

Returns:

Current cache capacity.

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