Package com.scaleoutsoftware.digitaltwin.abstractions

Interface SharedData

public interface SharedData

SharedData is used to access a model's, or globally, shared cache.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CacheResult>	clear()	Clear the shared data cache.
CompletableFuture<CacheResult>	get(String key)	Retrieves an existing object from the cache.
CompletableFuture<CacheResult>	put(String key, byte[] value)	Put a new key/value mapping into the cache.
CompletableFuture<CacheResult>	remove(String key)	Remove a key/value mapping from the cache.

Method Details

get

CompletableFuture<CacheResult> get(String key)

Retrieves an existing object from the cache.

Parameters:

key - the key mapping to a value.

Returns:

A cache result.

put

CompletableFuture<CacheResult> put(String key,
 byte[] value)

Put a new key/value mapping into the cache.

Parameters:

key - the key mapping to a value.

value - the value.

Returns:

a cache result.

remove

CompletableFuture<CacheResult> remove(String key)

Remove a key/value mapping from the cache.

Parameters:

key - the key mapping to a value.

Returns:

a cache result.

clear

CompletableFuture<CacheResult> clear()

Clear the shared data cache.

Returns:

a cache result.