io.spine.web.firebase

Class AsyncClient

java.lang.Object

io.spine.web.firebase.AsyncClient

All Implemented Interfaces:

FirebaseClient

public final class AsyncClient
extends java.lang.Object
implements FirebaseClient

A FirebaseClient which executes write operations asynchronously.

Read operations are considered less frequent and less costly, thus are executed synchronously.

Constructor Summary

Constructors

Constructor and Description
AsyncClient(FirebaseClient delegate) Creates a new async client with the given delegate.
AsyncClient(FirebaseClient delegate, java.util.concurrent.Executor executor) Creates a new async client with the given delegate and the given executor.

Method Summary

Modifier and Type	Method and Description
void	create(io.spine.web.firebase.NodePath nodePath, NodeValue value) Writes the specified value to the Firebase database node.
void	delete(io.spine.web.firebase.NodePath nodePath) Deletes the node under the given path.
java.util.Optional<NodeValue>	fetchNode(io.spine.web.firebase.NodePath nodePath) Retrieves the value of the specified Firebase database node.
void	subscribeTo(io.spine.web.firebase.NodePath nodePath, com.google.firebase.database.ChildEventListener listener) Subscribes to the child events of the given node.
void	update(io.spine.web.firebase.NodePath nodePath, NodeValue value) Merges the specified value to the Firebase database node.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncClient

public AsyncClient(FirebaseClient delegate,
                   java.util.concurrent.Executor executor)

Creates a new async client with the given delegate and the given executor.

It is a responsibility of the user to shut down the executor gracefully.

Parameters:

delegate - the firebase client which performs the requests

executor - the Executor which executes the write requests

AsyncClient

public AsyncClient(FirebaseClient delegate)

Creates a new async client with the given delegate.

The resulting client uses the ForkJoinPool.commonPool() to execute the write operations. Note that this is the same Executor which is used by default in the Java concurrency API, such as CompletableFuture and the conventional implementations of Stream.

Parameters:

delegate - the firebase client which performs the requests

See Also:

AsyncClient.AsyncClient(FirebaseClient, Executor)

Method Detail

fetchNode

public java.util.Optional<NodeValue> fetchNode(io.spine.web.firebase.NodePath nodePath)

Description copied from interface: FirebaseClient

Retrieves the value of the specified Firebase database node.

The null value (i.e. the node is not present in the database) is returned as Optional.empty().

Specified by:

fetchNode in interface FirebaseClient

Parameters:

nodePath - the path to the requested node in the database

Returns:

the node value or empty Optional if the node is not present in the database

subscribeTo

public void subscribeTo(io.spine.web.firebase.NodePath nodePath,
                        com.google.firebase.database.ChildEventListener listener)

Description copied from interface: FirebaseClient

Subscribes to the child events of the given node.

Specified by:

subscribeTo in interface FirebaseClient

Parameters:

nodePath - the path to the node to subscribe to

listener - the callbacks invoked on child events

create

public void create(io.spine.web.firebase.NodePath nodePath,
                   NodeValue value)

Description copied from interface: FirebaseClient

Writes the specified value to the Firebase database node.

If the node exists, the value is overridden.

Specified by:

create in interface FirebaseClient

Parameters:

nodePath - the path to the node in the Firebase database

value - the value to write

update

public void update(io.spine.web.firebase.NodePath nodePath,
                   NodeValue value)

Description copied from interface: FirebaseClient

Merges the specified value to the Firebase database node.

If the node doesn't exist, it is created with the given value.

If the node exists, the value entries are added to the node children overwriting common ones if present.

Specified by:

update in interface FirebaseClient

Parameters:

nodePath - the path to the node in the Firebase database

value - the value to merge

delete

public void delete(io.spine.web.firebase.NodePath nodePath)

Description copied from interface: FirebaseClient

Deletes the node under the given path.

Does nothing if the node does not exist.

Specified by:

delete in interface FirebaseClient

Parameters:

nodePath - the path to the node to delete