org.apereo.cas

Interface DistributedCacheManager<K extends java.io.Serializable,V extends DistributedCacheObject>

Type Parameters:

K - the type parameter

V - the type parameter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BaseDistributedCacheManager, NoOpDistributedCacheManager, RegisteredServiceHazelcastDistributedCacheManager

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DistributedCacheManager<K extends java.io.Serializable,V extends DistributedCacheObject>
extends java.io.Closeable

This is DistributedCacheManager that acts as a facade for a cache implementation. It's designed via generics to accept a key, a value associated with that key and an output object. While mostly value and output are one of the same, these are made separate intentionally to avoid serialization issues and provide flexibility to provide transformations on the final result.

Since:

5.2.0

Method Summary

Modifier and Type	Method and Description
default boolean	contains(K key) Contains key in the cache?
default java.util.Optional<V>	find(java.util.function.Predicate<V> filter) Find values matching this predicate.
default java.util.Collection<V>	findAll(java.util.function.Predicate<V> filter) Find values matching this predicate.
default V	get(K key) Get item.
default java.util.Collection<V>	getAll() Gets all items in the cache.
default java.lang.String	getName() Gets the cache impl name.
default void	remove(K key, V item) Remove key/item from the cache.
default void	set(K key, V item) Set item in the cache.
default void	update(K key, V item) update key/item from the cache and overwrite.

Methods inherited from interface java.io.Closeable

close

Method Detail

get

default V get(K key)

Get item.

Parameters:

key - the key

Returns:

the item or null if not found.

getAll

default java.util.Collection<V> getAll()

Gets all items in the cache.

Returns:

the all

set

default void set(K key,
                 V item)

Set item in the cache.

Parameters:

key - the key

item - the item to store in the cache

contains

default boolean contains(K key)

Contains key in the cache?

Parameters:

key - the key

Returns:

true /false

update

default void update(K key,
                    V item)

update key/item from the cache and overwrite.

Parameters:

key - the key

item - the item

remove

default void remove(K key,
                    V item)

Remove key/item from the cache.

Parameters:

key - the key

item - the item

getName

default java.lang.String getName()

Gets the cache impl name.

Returns:

the name

findAll

default java.util.Collection<V> findAll(java.util.function.Predicate<V> filter)

Find values matching this predicate.

Parameters:

filter - the filter

Returns:

the collection

find

default java.util.Optional<V> find(java.util.function.Predicate<V> filter)

Find values matching this predicate.

Parameters:

filter - the filter

Returns:

the collection