org.mule.tooling.client.api.cache

Interface CacheStorage

All Known Subinterfaces:

MetadataCacheStorage

public interface CacheStorage

Defines the storage mechanism used to build a Cache. The cache will be used to store resolved values from a request to a service. (e.g: Metadata, ValueProvider, etc) and avoid computing it multiple times.

In case an specific implementation needs to serialize the data prior to storage, they should keep a reference of the CacheStorageSerializers available in the CacheStorageFactory when executing CacheStorageFactory#createStorage(CacheStorageFactoryContext); In case serializers are used, implementations should follow this rule: If a value was serialized to be stored put(String, Object), it should be deserialized when returned get(String) That means that, weather or not the value was serialized, the following should always be true: storage.put("KEY", object); Object retrievedObject = storage.get("KEY").get(); assert object.getClass().isAssignableFrom(retrievedObject.class) == true

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
<V> Optional<V>	get(String key) Get the value from the cache associated with the key
Set<String>	getAllKeys() Deprecated. #removeIf(Predicate) should be implemented in order to prevent OOM issues. This method won't be called by MTS since version 4.4.0 but won't be removed in order to avoid breaking backwards compatibility.
<V> V	put(String key, V value) Add the value related with this key to the cache
void	remove(String... keys) Remove the values associated with the keys provided from the cache
default void	removeIf(Predicate<? super String> filter) Remove the values associated with the key filter provided from the cache

Method Detail

get

<V> Optional<V> get(String key)

Get the value from the cache associated with the key

Parameters:

key - the key used to identify the value in the storage

Returns:

the an Optional with the value stored or Optional.empty() if none found.

put

<V> V put(String key,
          V value)

Add the value related with this key to the cache

Parameters:

key - the key to use to locate the value

value - the value to be stored

Returns:

the value stored

remove

void remove(String... keys)

Remove the values associated with the keys provided from the cache

Parameters:

keys - the keys to locate the values to remove

removeIf

default void removeIf(Predicate<? super String> filter)

Remove the values associated with the key filter provided from the cache

Parameters:

filter - a predicate to define keys for values to be removed

getAllKeys

@Deprecated
Set<String> getAllKeys()

Deprecated. #removeIf(Predicate) should be implemented in order to prevent OOM issues. This method won't be called by MTS since version 4.4.0 but won't be removed in order to avoid breaking backwards compatibility.

Returns:

a with all the keys being used in the storage. As the amount of keys to be stored in cache could be bigger, implementations should provide a Set with streaming support in order to prevent an out of memory.