com.sap.cloud.sdk.cloudplatform.cache

Class SerializableCacheKey

java.lang.Object

com.sap.cloud.sdk.cloudplatform.cache.SerializableCacheKey

All Implemented Interfaces:

GenericCacheKey<SerializableCacheKey,Serializable>, Serializable

public final class SerializableCacheKey
extends Object
implements GenericCacheKey<SerializableCacheKey,Serializable>, Serializable

SerializableCacheKey with either global visibility, tenant isolation, or tenant and principal isolation. The cache key components are guaranteed to be serializable.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
SerializableCacheKey	append(Iterable<Serializable> objects) Appends the given Objects to this instance.
boolean	equals(Object o)
List<Serializable>	getComponents() Getter for the list of additional cache key components.
io.vavr.control.Option<String>	getPrincipalId() Getter for the name of the principal for which the key is used.
io.vavr.control.Option<String>	getTenantId() Getter for the Id of the tenant for which the key is used.
int	hashCode()
static SerializableCacheKey	of(String tenantId, String principalId) Constructs a SerializableCacheKey for the given tenant and principal identifier, independent of whether they are null or not.
static SerializableCacheKey	of(Tenant tenant, Principal principal) Constructs a CacheKey for the given tenant and principal identifier, independent of whether they are null or not.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTenantId

@Nonnull
public io.vavr.control.Option<String> getTenantId()

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

Specified by:

getTenantId in interface GenericCacheKey<SerializableCacheKey,Serializable>

Returns:

The tenant identifier.

getPrincipalId

@Nonnull
public io.vavr.control.Option<String> getPrincipalId()

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

Specified by:

getPrincipalId in interface GenericCacheKey<SerializableCacheKey,Serializable>

Returns:

The principal identifier.

append

@Nonnull
public SerializableCacheKey append(@Nonnull
                                             Iterable<Serializable> 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.

Specified by:

append in interface GenericCacheKey<SerializableCacheKey,Serializable>

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 SerializableCacheKey of(@Nullable
                                                String tenantId,
                                                @Nullable
                                                String principalId)

Constructs a SerializableCacheKey for the given tenant and principal identifier, 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.

principalId - The identifier of the principal. If null, there is no principal isolation.

Returns:

A new CacheKey constructed from the given tenant and principal identifier.

of

@Nonnull
public static SerializableCacheKey of(@Nullable
                                                Tenant tenant,
                                                @Nullable
                                                Principal principal)

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

Parameters:

tenant - The tenant. If null, there is not tenant isolation.

principal - The principal. If null, there is no principal isolation.

Returns:

A new CacheKey constructed from the given tenant and principal identifier.

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 List<Serializable> getComponents()

Description copied from interface: GenericCacheKey

Getter for the list of additional cache key components.

Specified by:

getComponents in interface GenericCacheKey<SerializableCacheKey,Serializable>

Returns:

The list of additional cache key components.