com.sap.cloud.sdk.cloudplatform.cache

Class CacheKey

java.lang.Object

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

public final 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(Iterable<Object> objects) Appends the given Objects to this instance.
CacheKey	append(Object... objects) Appends the given Objects to this instance.
boolean	equals(Object o)
ArrayList<Object>	getComponents()
Optional<String>	getTenantId() Getter for the Id of the tenant for which the key is used.
Optional<String>	getUserName() Getter for the name of the user for which the key is used.
int	hashCode()
static CacheKey	of(String tenantId, String userName) Constructs a CacheKey for the given tenant identifier and user name, independent of whether they are null or not.
static CacheKey	ofNoIsolation() Constructs an instance of CacheKey without tenant or user isolation.
static CacheKey	ofTenantAndUserIsolation() Constructs a tenant- and user-isolated instance of CacheKey.
static CacheKey	ofTenantIsolation() Constructs a tenant-isolated instance of CacheKey.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTenantId

@Nonnull
public Optional<String> getTenantId()

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

Returns:

The tenant Id.

getUserName

@Nonnull
public Optional<String> getUserName()

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

Returns:

The user name.

append

@Nonnull
public CacheKey append(@Nonnull
                                Iterable<Object> objects)
                         throws IllegalArgumentException

Appends the given Objects to this instance. In order to compare cache keys, Object.equals(Object) and Object.hashCode() are used. The given objects must not be null.

Parameters:

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

Returns:

This instance with the objects added.

Throws:

IllegalArgumentException - If any of the given objects is null.

append

@Nonnull
public CacheKey append(@Nonnull
                                Object... objects)
                         throws IllegalArgumentException

Appends the given Objects to this instance. In order to compare cache keys, Object.equals(Object) and Object.hashCode() are used. The given objects must not be null.

Parameters:

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

Returns:

This instance with the objects added.

Throws:

IllegalArgumentException - If any of the given objects is null.

of

@Nonnull
public static CacheKey of(@Nullable
                                   String tenantId,
                                   @Nullable
                                   String userName)

Constructs a CacheKey for the given tenant identifier and user name, independent of whether they are null or not. This provides the highest flexibility for defining different levels of isolation.

Parameters:

tenantId - The identifier of the tenant. If null, there is not tenant isolation.

userName - The name of the user. If null, there is no user isolation.

Returns:

A new CacheKey constructed from the given tenant identifier and user name.

ofNoIsolation

@Nonnull
public static CacheKey ofNoIsolation()

Constructs an instance of CacheKey without tenant or user isolation. This can be used to share a cache globally within the application.

Returns:

A new CacheKey without isolation.

ofTenantIsolation

@Nonnull
public static CacheKey ofTenantIsolation()
                                           throws TenantNotAvailableException,
                                                  TenantAccessException

Constructs a tenant-isolated instance of CacheKey. This can be used to share a cache among the users of a tenant.

When using this method, the tenant isolation is strictly enforced. This means that if the tenant is not available, an exception is thrown.

Returns:

A new CacheKey with tenant isolation based on the current tenant.

Throws:

TenantNotAvailableException - If the tenant is not available. 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.

ofTenantAndUserIsolation

@Nonnull
public static CacheKey ofTenantAndUserIsolation()
                                                  throws TenantNotAvailableException,
                                                         TenantAccessException,
                                                         UserNotAuthenticatedException,
                                                         UserAccessException

Constructs a tenant- and user-isolated instance of CacheKey.

When using this method, the tenant and user isolation is strictly enforced. This means that if the tenant is not available or the user is not authenticated, an exception is thrown.

Returns:

A new CacheKey with tenant and user isolation based on the current tenant and user.

Throws:

TenantNotAvailableException - If the tenant is not available. 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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getComponents

public ArrayList<Object> getComponents()