com.sap.cloud.sdk.cloudplatform.cache

Interface CacheMonitorMXBean

All Known Implementing Classes:

CacheMonitor

public interface CacheMonitorMXBean

JMX interface monitoring and invalidating caches as needed.

Method Summary

Modifier and Type	Method and Description
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.
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.

Method Detail

invalidateCaches

long invalidateCaches()

Invalidates all entries in all caches.

Returns:

The number of invalidated cache entries.

invalidateTenantCaches

long invalidateTenantCaches(String tenantId)

Invalidates all caches of the given tenant.

Parameters:

tenantId - The tenant to invalidate all caches for.

Returns:

The number of invalidated cache entries.

invalidateUserCaches

long invalidateUserCaches(String tenantId,
                          String userName)

Invalidates all caches of the given user.

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

long getCacheSize()

Returns the number of entries in all monitored caches.

Returns:

The number of all entries.

getHitCount

long getHitCount()

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

Returns:

The number of successful cache lookups.

getMissCount

long getMissCount()

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

Returns:

The number of cache lookup misses.

getLoadSuccessCount

long getLoadSuccessCount()

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

Returns:

The number of successful loads of new cache entries.

getLoadExceptionCount

long getLoadExceptionCount()

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

Returns:

The number of exceptions thrown while loading new values.

getTotalLoadTime

long getTotalLoadTime()

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

Returns:

The total time spent loading new values, in nanoseconds.

getEvictionCount

long getEvictionCount()

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

Returns:

The number of automatic eviction of entries.

getCacheStatsList

@Nonnull
List<CacheStats> getCacheStatsList()

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

Returns:

A list of one stats object pre cache.