com.sap.cloud.sdk.cloudplatform.cache

Class CacheKey

java.lang.Object

com.sap.cloud.sdk.cloudplatform.cache.CacheKey

public class CacheKey
extends Object

CacheKey with either global visibility, tenant isolation, or tenant & user isolation.

Method Summary

Modifier and Type	Method and Description
CacheKey	append(CacheKey other, Object... objects) Appends the given CacheKey to this instance.
CacheKey	append(Object object, Object... objects) Appends the given Objects to this instance.
boolean	equals(Object o)
ArrayList<Object>	getComponents()
com.google.common.base.Optional<String>	getTenantId() Getter for the Id of the tenant for which the key is used.
com.google.common.base.Optional<String>	getUserName() Getter for the name of the user for which the key is used.
int	hashCode()
static CacheKey	newBestEffortIsolatedKey() Returns a cache key with the highest possible (best effort) level of user and tenant isolation.
static CacheKey	newBestEffortIsolatedKey(CacheKey cacheKey) Returns a cache key with the highest possible (best effort) level of user and tenant isolation.
static CacheKey	newEquallyIsolatedKey(CacheKey cacheKey) Returns a cache key with the same tenant and user isolation level as the given key.
static CacheKey	newGlobalKey()
static CacheKey	newGlobalKey(CacheKey cacheKey) Converts the given CacheKey to a globally visible CacheKey.
static CacheKey	newTenantIsolatedKey()
static CacheKey	newTenantIsolatedKey(CacheKey cacheKey)
static CacheKey	newTenantIsolatedKey(CacheKey cacheKey, String tenantId) Converts the given CacheKey to a tenant-isolated CacheKey.
static CacheKey	newTenantIsolatedKey(String tenantId)
static CacheKey	newTenantIsolatedOrGlobalKey() Returns a tenant-isolated cache key.
static CacheKey	newTenantIsolatedOrGlobalKey(CacheKey cacheKey) Returns a tenant-isolated cache key.
static CacheKey	newUserIsolatedKey()
static CacheKey	newUserIsolatedKey(CacheKey cacheKey)
static CacheKey	newUserIsolatedKey(CacheKey cacheKey, String userName)
static CacheKey	newUserIsolatedKey(CacheKey cacheKey, String tenantId, String userName) Converts the given CacheKey to a tenant-isolated CacheKey.
static CacheKey	newUserIsolatedKey(String userName)
static CacheKey	newUserIsolatedKey(String tenantId, String userName)
static CacheKey	newUserOrTenantIsolatedKey() Returns a tenant- and user-isolated cache key.
static CacheKey	newUserOrTenantIsolatedKey(CacheKey cacheKey) Returns a tenant- and user-isolated cache key.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTenantId

public com.google.common.base.Optional<String> getTenantId()

Getter for the Id of the tenant for which the key is used.

Returns:

The tenant Id.

getUserName

public com.google.common.base.Optional<String> getUserName()

Getter for the name of the user for which the key is used.

Returns:

The user name.

append

public CacheKey append(CacheKey other,
                       Object... objects)
                throws UnmergeableCacheKeyException

Appends the given CacheKey to this instance.

Parameters:

other - The CacheKey to append to this.

objects - Additional objects that should be used to identify a cache key.

Returns:

This instance with the other key appended and the objects added.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

append

public CacheKey append(@Nullable
                       Object object,
                       Object... objects)

Appends the given Objects to this instance. In order to compare cache keys, Object.equals(Object) and Object.hashCode() are used.

Parameters:

object - Additional object that should be used to identify a cache key.

objects - Additional objects that should be used to identify a cache key.

Returns:

This instance with the objects added.

newEquallyIsolatedKey

public static CacheKey newEquallyIsolatedKey(CacheKey cacheKey)
                                      throws IllegalArgumentException,
                                             UnmergeableCacheKeyException

Returns a cache key with the same tenant and user isolation level as the given key.

Parameters:

cacheKey - The cache key to adopt the isolation level from.

Returns:

A new CacheKey with the same isolation level as the given key.

Throws:

IllegalArgumentException

UnmergeableCacheKeyException

newGlobalKey

public static CacheKey newGlobalKey(CacheKey cacheKey)
                             throws IllegalArgumentException,
                                    UnmergeableCacheKeyException

Converts the given CacheKey to a globally visible CacheKey.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey for based on the given CacheKey.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

newGlobalKey

public static CacheKey newGlobalKey()

Returns:

A new CacheKey for a globally visible cache entry.

newTenantIsolatedKey

public static CacheKey newTenantIsolatedKey(String tenantId)
                                     throws IllegalArgumentException

Parameters:

tenantId - The tenant for which the CacheKey should be isolated.

Returns:

A new CacheKey for a tenant-isolated cache entry.

Throws:

IllegalArgumentException - If the given tenant is null.

newTenantIsolatedKey

public static CacheKey newTenantIsolatedKey()
                                     throws TenantNotAvailableException,
                                            TenantAccessException

Returns:

A new CacheKey based on the current tenant.

Throws:

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

See Also:

newTenantIsolatedKey(String)

newTenantIsolatedKey

public static CacheKey newTenantIsolatedKey(CacheKey cacheKey,
                                            String tenantId)
                                     throws IllegalArgumentException,
                                            UnmergeableCacheKeyException

Converts the given CacheKey to a tenant-isolated CacheKey.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

tenantId - The tenant for which the CacheKey should be isolated.

Returns:

A new CacheKey for based on the given CacheKey.

Throws:

IllegalArgumentException - If the given CacheKey or tenant is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

newTenantIsolatedKey

public static CacheKey newTenantIsolatedKey(CacheKey cacheKey)
                                     throws IllegalArgumentException,
                                            UnmergeableCacheKeyException

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey based on the current tenant and the given key appended.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

See Also:

newTenantIsolatedKey(CacheKey, String)

newUserIsolatedKey

public static CacheKey newUserIsolatedKey(String tenantId,
                                          String userName)
                                   throws IllegalArgumentException

Parameters:

tenantId - The tenant for which the CacheKey should be isolated.

userName - The name of the user for which the CacheKey should be isolated.

Returns:

A new CacheKey for a user- and tenant-isolated cache entry.

Throws:

IllegalArgumentException - If the given tenant or user is null.

newUserIsolatedKey

public static CacheKey newUserIsolatedKey(String userName)
                                   throws IllegalArgumentException,
                                          TenantNotAvailableException,
                                          TenantAccessException

Parameters:

userName - The name of the user for which the CacheKey should be isolated.

Returns:

A new CacheKey based on the given user name.

Throws:

IllegalArgumentException - If the given user is null.

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

See Also:

newUserIsolatedKey(String, String)

newUserIsolatedKey

public static CacheKey newUserIsolatedKey()
                                   throws TenantNotAvailableException,
                                          TenantAccessException,
                                          UserNotAuthenticatedException,
                                          UserAccessException

Returns:

A new CacheKey based on the current tenant and user.

Throws:

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

UserNotAuthenticatedException - If the user is not authenticated.

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

See Also:

newUserIsolatedKey(String, String)

newUserIsolatedKey

public static CacheKey newUserIsolatedKey(CacheKey cacheKey,
                                          String tenantId,
                                          String userName)
                                   throws IllegalArgumentException,
                                          UnmergeableCacheKeyException

Converts the given CacheKey to a tenant-isolated CacheKey.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

tenantId - The tenant for which the CacheKey should be isolated.

userName - The name of the user for which the CacheKey should be isolated.

Returns:

A new CacheKey based on the given tenant, and user and the given CacheKey appended.

Throws:

IllegalArgumentException - If the given CacheKey, tenant, or user is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

newUserIsolatedKey

public static CacheKey newUserIsolatedKey(CacheKey cacheKey,
                                          String userName)
                                   throws IllegalArgumentException,
                                          UnmergeableCacheKeyException,
                                          TenantNotAvailableException,
                                          TenantAccessException

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

userName - The name of the user for which the CacheKey should be isolated.

Returns:

A new CacheKey based on the given user and the given CacheKey appended.

Throws:

IllegalArgumentException - If the given CacheKey or user is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

See Also:

newUserIsolatedKey(CacheKey, String, String)

newUserIsolatedKey

public static CacheKey newUserIsolatedKey(CacheKey cacheKey)
                                   throws IllegalArgumentException,
                                          UnmergeableCacheKeyException,
                                          TenantNotAvailableException,
                                          TenantAccessException,
                                          UserNotAuthenticatedException,
                                          UserAccessException

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey based on the current user and the given CacheKey appended.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

UserNotAuthenticatedException - If the user is not authenticated.

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

See Also:

newUserIsolatedKey(CacheKey, String, String)

newUserOrTenantIsolatedKey

public static CacheKey newUserOrTenantIsolatedKey()
                                           throws TenantNotAvailableException,
                                                  TenantAccessException

Returns a tenant- and user-isolated cache key. If the user is not authenticated, only a tenant-isolated cache key is returned.

Returns:

A new CacheKey based only on the current user, if available, otherwise based only on the current tenant.

Throws:

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

newUserOrTenantIsolatedKey

public static CacheKey newUserOrTenantIsolatedKey(CacheKey cacheKey)
                                           throws IllegalArgumentException,
                                                  UnmergeableCacheKeyException,
                                                  TenantNotAvailableException,
                                                  TenantAccessException

Returns a tenant- and user-isolated cache key. If the user is not authenticated, only a tenant-isolated cache key is returned.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey based only on the current user, if available, otherwise based only on the current tenant. The given CacheKey is appended to the new key.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

TenantNotAvailableException - If the tenant is not known. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

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

See Also:

newUserOrTenantIsolatedKey()

newTenantIsolatedOrGlobalKey

public static CacheKey newTenantIsolatedOrGlobalKey()

Returns a tenant-isolated cache key. If no tenant is available, a global cache key is returned.

Returns:

A new CacheKey based only on the current tenant, if available, otherwise as a global key.

newTenantIsolatedOrGlobalKey

public static CacheKey newTenantIsolatedOrGlobalKey(CacheKey cacheKey)
                                             throws IllegalArgumentException,
                                                    UnmergeableCacheKeyException

Returns a tenant-isolated cache key. If no tenant is available, a global cache key is returned.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey based only on the current tenant, if available, otherwise as a global key. The given CacheKey is appended to the new key.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

newBestEffortIsolatedKey

public static CacheKey newBestEffortIsolatedKey()

Returns a cache key with the highest possible (best effort) level of user and tenant isolation. If the user is not authenticated, a tenant-isolated cache key is returned. If no tenant is available, a global cache key is returned.

Returns:

A new CacheKey based on the current tenant and user.

newBestEffortIsolatedKey

public static CacheKey newBestEffortIsolatedKey(CacheKey cacheKey)
                                         throws IllegalArgumentException,
                                                UnmergeableCacheKeyException

Returns a cache key with the highest possible (best effort) level of user and tenant isolation. If the user is not authenticated, a tenant-isolated cache key is returned. If no tenant is available, a global cache key is returned.

Parameters:

cacheKey - Cache key that is appended to the newly constructed key.

Returns:

A new CacheKey based on the current tenant and user. The given CacheKey is appended to the new key.

Throws:

IllegalArgumentException - If the given CacheKey is null.

UnmergeableCacheKeyException - If the tenant or user in the isolation level of the given CacheKey is different from the respective tenant or user in this CacheKey.

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

getComponents

@Generated(value="lombok")
public ArrayList<Object> getComponents()