com.sap.cloud.sdk.cloudplatform.cache

Class CacheMonitor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.monitoring.JmxMonitor

com.sap.cloud.sdk.cloudplatform.cache.CacheMonitor

All Implemented Interfaces:

CacheMonitorMXBean, EventListener, javax.servlet.ServletContextListener

@WebListener
public class CacheMonitor
extends JmxMonitor
implements CacheMonitorMXBean

Gives access to aggregated performance statistics for all caches statically managed by the CacheManager.

Constructor Summary

Constructors

Constructor and Description
CacheMonitor()

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent servletContextEvent)
void	contextInitialized(javax.servlet.ServletContextEvent servletContextEvent)
long	getCacheSize() Returns the number of entries in all monitored caches.
List<CacheStats>	getCacheStatsList() Returns a list containing a CacheStats instance for each monitored cache.
long	getEvictionCount() Returns the number of times an entry has been automatically evicted.
long	getHitCount() Returns the number times cache lookup methods have returned a cached value.
static CacheMonitor	getInstance()
long	getLoadExceptionCount() Returns the number of times cache lookup methods threw an exception while loading a new value.
long	getLoadSuccessCount() Returns the number of times cache lookup methods have successfully loaded a new value.
long	getMissCount() Returns the number of times cache lookup methods have returned an uncached value, or null.
long	getTotalLoadTime() Returns the total number of nanoseconds the cache has spent loading new values.
long	invalidateCaches() Invalidates all entries in all caches.
long	invalidateTenantCaches(String tenantId) Invalidates all caches of the given tenant.
long	invalidateUserCaches(String tenantId, String userName) Invalidates all caches of the given user.

Methods inherited from class com.sap.cloud.sdk.cloudplatform.monitoring.JmxMonitor

registerJmxBean, unregisterJmxBean

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheMonitor

public CacheMonitor()

Method Detail

invalidateCaches

public long invalidateCaches()

Description copied from interface: CacheMonitorMXBean

Invalidates all entries in all caches.

Specified by:

invalidateCaches in interface CacheMonitorMXBean

Returns:

The number of invalidated cache entries.

invalidateTenantCaches

public long invalidateTenantCaches(String tenantId)

Description copied from interface: CacheMonitorMXBean

Invalidates all caches of the given tenant.

Specified by:

invalidateTenantCaches in interface CacheMonitorMXBean

Parameters:

tenantId - The tenant to invalidate all caches for.

Returns:

The number of invalidated cache entries.

invalidateUserCaches

public long invalidateUserCaches(String tenantId,
                                 String userName)

Description copied from interface: CacheMonitorMXBean

Invalidates all caches of the given user.

Specified by:

invalidateUserCaches in interface CacheMonitorMXBean

Parameters:

tenantId - The Id of the tenant for which all user caches should be invalidated.

userName - The name of the user for which all caches should be invalidated.

Returns:

The number of invalidated cache entries.

getCacheSize

public long getCacheSize()

Description copied from interface: CacheMonitorMXBean

Returns the number of entries in all monitored caches.

Specified by:

getCacheSize in interface CacheMonitorMXBean

Returns:

The number of all entries.

getHitCount

public long getHitCount()

Description copied from interface: CacheMonitorMXBean

Returns the number times cache lookup methods have returned a cached value.

Specified by:

getHitCount in interface CacheMonitorMXBean

Returns:

The number of successful cache lookups.

getMissCount

public long getMissCount()

Description copied from interface: CacheMonitorMXBean

Returns the number of times cache lookup methods have returned an uncached value, or null.

Specified by:

getMissCount in interface CacheMonitorMXBean

Returns:

The number of cache lookup misses.

getLoadSuccessCount

public long getLoadSuccessCount()

Description copied from interface: CacheMonitorMXBean

Returns the number of times cache lookup methods have successfully loaded a new value.

Specified by:

getLoadSuccessCount in interface CacheMonitorMXBean

Returns:

The number of successful loads of new cache entries.

getLoadExceptionCount

public long getLoadExceptionCount()

Description copied from interface: CacheMonitorMXBean

Returns the number of times cache lookup methods threw an exception while loading a new value.

Specified by:

getLoadExceptionCount in interface CacheMonitorMXBean

Returns:

The number of exceptions thrown while loading new values.

getTotalLoadTime

public long getTotalLoadTime()

Description copied from interface: CacheMonitorMXBean

Returns the total number of nanoseconds the cache has spent loading new values.

Specified by:

getTotalLoadTime in interface CacheMonitorMXBean

Returns:

The total time spent loading new values, in nanoseconds.

getEvictionCount

public long getEvictionCount()

Description copied from interface: CacheMonitorMXBean

Returns the number of times an entry has been automatically evicted.

Specified by:

getEvictionCount in interface CacheMonitorMXBean

Returns:

The number of automatic eviction of entries.

getCacheStatsList

public List<CacheStats> getCacheStatsList()

Description copied from interface: CacheMonitorMXBean

Returns a list containing a CacheStats instance for each monitored cache.

Specified by:

getCacheStatsList in interface CacheMonitorMXBean

Returns:

A list of one stats object pre cache.

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent servletContextEvent)

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent servletContextEvent)

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener

getInstance

public static CacheMonitor getInstance()