Package io.fluxcapacitor.javaclient.persisting.keyvalue.client

Class WebsocketKeyValueClient

java.lang.Object

io.fluxcapacitor.javaclient.common.websocket.AbstractWebsocketClient

io.fluxcapacitor.javaclient.persisting.keyvalue.client.WebsocketKeyValueClient

All Implemented Interfaces:

KeyValueClient, AutoCloseable

public class WebsocketKeyValueClient
extends AbstractWebsocketClient
implements KeyValueClient

Nested Class Summary

Nested classes/interfaces inherited from class io.fluxcapacitor.javaclient.common.websocket.AbstractWebsocketClient

AbstractWebsocketClient.WebSocketRequest

Field Summary

Fields inherited from class io.fluxcapacitor.javaclient.common.websocket.AbstractWebsocketClient

defaultObjectMapper, defaultWebSocketContainer

Constructor Summary

Constructors

Constructor	Description
WebsocketKeyValueClient(String endPointUrl, WebSocketClient.ClientConfig clientConfig)
WebsocketKeyValueClient(URI endpointUri, WebSocketClient.ClientConfig clientConfig)

Method Summary

Modifier and Type	Method	Description
Awaitable	deleteValue(String key)	Deletes the value associated with the given key.
Data<byte[]>	getValue(String key)	Returns the Data object associated with the given key.
Awaitable	putValue(String key, Data<byte[]> value, Guarantee guarantee)	Adds or replaces the given value in the key value store.
CompletableFuture<Boolean>	putValueIfAbsent(String key, Data<byte[]> value)	Adds the given value in the key value store if the key is not already mapped to a value.
protected Awaitable	storeValues(List<KeyValuePair> keyValuePairs)

Methods inherited from class io.fluxcapacitor.javaclient.common.websocket.AbstractWebsocketClient

close, close, handleResult, onClose, onError, onMessage, retryOutstandingRequests, send, send, sendAndForget, sendAndWait, sendBatch, tryPublishMetrics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.fluxcapacitor.javaclient.persisting.keyvalue.client.KeyValueClient

close

Constructor Details

WebsocketKeyValueClient

public WebsocketKeyValueClient(String endPointUrl,
 WebSocketClient.ClientConfig clientConfig)

WebsocketKeyValueClient

public WebsocketKeyValueClient(URI endpointUri,
 WebSocketClient.ClientConfig clientConfig)

Method Details

storeValues

protected Awaitable storeValues(List<KeyValuePair> keyValuePairs)

putValue

public Awaitable putValue(String key,
 Data<byte[]> value,
 Guarantee guarantee)

Description copied from interface: KeyValueClient

Adds or replaces the given value in the key value store.

Specified by:

putValue in interface KeyValueClient

Parameters:

key - The key associated with this value

value - The value to store

guarantee - The guarantee for storing

Returns:

a handle that enables clients to wait until the value was sent or stored depending on the guarantee

putValueIfAbsent

public CompletableFuture<Boolean> putValueIfAbsent(String key,
 Data<byte[]> value)

Description copied from interface: KeyValueClient

Adds the given value in the key value store if the key is not already mapped to a value.

Specified by:

putValueIfAbsent in interface KeyValueClient

Parameters:

key - The key associated with this value

value - The value to store

Returns:

a handle that enables clients to wait until the value was sent or stored depending on the guarantee

getValue

public Data<byte[]> getValue(String key)

Description copied from interface: KeyValueClient

Returns the Data object associated with the given key. Returns null if there is no associated value.

Specified by:

getValue in interface KeyValueClient

Parameters:

key - The key associated with the value

Returns:

the value for the given key or null

deleteValue

public Awaitable deleteValue(String key)

Description copied from interface: KeyValueClient

Deletes the value associated with the given key.

Specified by:

deleteValue in interface KeyValueClient

Parameters:

key - The key associated with this value

Returns:

a handle that enables clients to wait until the command was safely sent to the store