io.spine.web.firebase

Interface FirebaseClient

All Known Implementing Classes:

AsyncClient, RemoteDatabaseClient

public interface FirebaseClient

A client which operates on values in the Firebase database.

The implementations are meant to work in "one client per database" format.

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.

Method Detail

fetchNode

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

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().

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

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

Subscribes to the child events of the given node.

Parameters:

nodePath - the path to the node to subscribe to

listener - the callbacks invoked on child events

create

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

Writes the specified value to the Firebase database node.

If the node exists, the value is overridden.

Parameters:

nodePath - the path to the node in the Firebase database

value - the value to write

update

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

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.

Parameters:

nodePath - the path to the node in the Firebase database

value - the value to merge

delete

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

Deletes the node under the given path.

Does nothing if the node does not exist.

Parameters:

nodePath - the path to the node to delete