com.sap.cloud.sdk.cloudplatform.cache

Class CacheManager

java.lang.Object

com.sap.cloud.sdk.cloudplatform.cache.CacheManager

public final class CacheManager
extends Object

Grants bulk processing for all (statically) registered caches.

Constructor Summary

Constructors

Constructor and Description
CacheManager()

Method Summary

Modifier and Type	Method and Description
static void	cleanUp() Cleans up all cache entries that have been invalidated.
static com.google.common.collect.ImmutableList<com.google.common.cache.Cache<CacheKey,?>>	getCacheList() Getter for a list of all caches registered in the CacheManager.
static long	invalidateAll() Invalidates all entries in all caches.
static long	invalidateTenantCaches() Invalidates all caches of the current tenant.
static long	invalidateTenantCaches(String tenantId) Invalidates all caches of the given tenant.
static long	invalidateUserCaches() Invalidates all caches of the current user.
static long	invalidateUserCaches(String tenantId, String userName) Invalidates all caches of the given user.
static long	invalidateUserEntries(com.google.common.cache.Cache<CacheKey,?> cache) Invalidates all cache entries of the current tenant-specific user.
static long	invalidateUserEntries(String tenantId, String userName, com.google.common.cache.Cache<CacheKey,?> cache) Invalidates all cache entries of the given tenant-specific user.
static <T> com.google.common.cache.Cache<CacheKey,T>	register(com.google.common.cache.Cache<CacheKey,T> cache) Registers a cache at in the CacheManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheManager

public CacheManager()

Method Detail

getCacheList

@Nonnull
public static com.google.common.collect.ImmutableList<com.google.common.cache.Cache<CacheKey,?>> getCacheList()

Getter for a list of all caches registered in the CacheManager.

Returns:

The list of all caches.

register

@Nonnull
public static <T> com.google.common.cache.Cache<CacheKey,T> register(@Nonnull
                                                                              com.google.common.cache.Cache<CacheKey,T> cache)

Registers a cache at in the CacheManager.

Type Parameters:

T - The type of the values in the cache.

Parameters:

cache - The cache to be registered.

Returns:

The given cache.

cleanUp

public static void cleanUp()

Cleans up all cache entries that have been invalidated.

invalidateAll

public static long invalidateAll()

Invalidates all entries in all caches.

Returns:

The number of invalidated cache entries.

invalidateTenantCaches

public static long invalidateTenantCaches()
                                   throws TenantNotAvailableException,
                                          TenantAccessException

Invalidates all caches of the current tenant.

Returns:

The number of invalidated cache entries.

Throws:

TenantNotAvailableException - If the current tenant is not available.

TenantAccessException - If there is an issue while accessing the current tenant.

invalidateTenantCaches

public static 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

public static long invalidateUserCaches()
                                 throws TenantNotAvailableException,
                                        TenantAccessException,
                                        UserNotAuthenticatedException,
                                        UserAccessException

Invalidates all caches of the current user.

Returns:

The number of invalidated cache entries.

Throws:

TenantNotAvailableException - If the current tenant is not available.

TenantAccessException - If there is an issue while accessing the current tenant.

UserNotAuthenticatedException - If the current user is not authenticated.

UserAccessException - If there is an issue while accessing the current user.

invalidateUserCaches

public static 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.

invalidateUserEntries

public static long invalidateUserEntries(com.google.common.cache.Cache<CacheKey,?> cache)
                                  throws TenantNotAvailableException,
                                         TenantAccessException,
                                         UserNotAuthenticatedException,
                                         UserAccessException

Invalidates all cache entries of the current tenant-specific user.

Parameters:

cache - The cache in which all caches of the current user should be invalidated.

Returns:

The number of invalidated cache entries.

Throws:

TenantNotAvailableException - If the current tenant is not available.

TenantAccessException - If there is an issue while accessing the current tenant.

UserNotAuthenticatedException - If the current user is not authenticated.

UserAccessException - If there is an issue while accessing the current user.

invalidateUserEntries

public static long invalidateUserEntries(String tenantId,
                                         String userName,
                                         com.google.common.cache.Cache<CacheKey,?> cache)

Invalidates all cache entries of the given tenant-specific user.

Parameters:

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

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

cache - The cache in which the entries of the user should be invalidated.

Returns:

The number of invalidated cache entries.