A B C D E F I K N O R S T U W

A

addChild(StoredJson) - Method in class io.spine.web.firebase.NodeValue

Adds a child to the value.

addChild(String, StoredJson) - Method in class io.spine.web.firebase.NodeValue

Adds a child to the value under a specified key.

addNullChild(String) - Method in class io.spine.web.firebase.NodeValue

Adds a `null` child to the value under a specified key.

asNodeValue() - Method in class io.spine.web.firebase.StoredJson

Obtains this JSON as a database node value.

AsyncClient - Class in io.spine.web.firebase

A FirebaseClient which executes write operations asynchronously.

AsyncClient(FirebaseClient, Executor) - Constructor for class io.spine.web.firebase.AsyncClient

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

AsyncClient(FirebaseClient) - Constructor for class io.spine.web.firebase.AsyncClient

Creates a new async client with the given delegate.

B

build() - Method in class io.spine.web.firebase.query.FirebaseQueryBridge.Builder

Creates a new instance of FirebaseQueryBridge.

build() - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient.Builder

Creates a new instance of RemoteDatabaseClient.

build() - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge.Builder

Creates a new instance of FirebaseQueryBridge.

C

cancel(Subscription) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge

create(NodePath, NodeValue) - Method in class io.spine.web.firebase.AsyncClient

create(NodePath, NodeValue) - Method in interface io.spine.web.firebase.FirebaseClient

Writes the specified value to the Firebase database node.

create(NodePath, NodeValue) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient

D

DatabaseUrls - Class in io.spine.web.firebase

Utilities and static factories dealing with DatabaseUrl.

delete(NodePath) - Method in class io.spine.web.firebase.AsyncClient

delete(NodePath) - Method in interface io.spine.web.firebase.FirebaseClient

Deletes the node under the given path.

delete(NodePath) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient

E

empty() - Static method in class io.spine.web.firebase.FirebaseCredentials

Creates an empty instance of FirebaseCredentials.

empty() - Static method in class io.spine.web.firebase.NodeValue

Creates an empty NodeValue.

encode(Message) - Static method in class io.spine.web.firebase.StoredJson

Encodes the given message into a StoredJson.

F

fetchNode(NodePath) - Method in class io.spine.web.firebase.AsyncClient

fetchNode(NodePath) - Method in interface io.spine.web.firebase.FirebaseClient

Retrieves the value of the specified Firebase database node.

fetchNode(NodePath) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient

FirebaseClient - Interface in io.spine.web.firebase

A client which operates on values in the Firebase database.

FirebaseClientFactory - Class in io.spine.web.firebase

A tool for FirebaseClient instances creation.

FirebaseCredentials - Class in io.spine.web.firebase

A Firebase Database credentials.

FirebaseQueryBridge - Class in io.spine.web.firebase.query

An implementation of QueryBridge based on the Firebase Realtime Database.

FirebaseQueryBridge.Builder - Class in io.spine.web.firebase.query

A builder for the FirebaseQueryBridge instances.

FirebaseSubscriptionBridge - Class in io.spine.web.firebase.subscription

An implementation of SubscriptionBridge based on the Firebase Realtime Database.

FirebaseSubscriptionBridge.Builder - Class in io.spine.web.firebase.subscription

A builder for the FirebaseQueryBridge instances.

from(String) - Static method in class io.spine.web.firebase.DatabaseUrls

Creates a DatabaseUrl instance from the given string.

from(String) - Static method in class io.spine.web.firebase.StoredJson

Creates a StoredJson from the given JSON string.

fromGoogleCredentials(GoogleCredentials) - Static method in class io.spine.web.firebase.FirebaseCredentials

Creates a new FirebaseCredentials from the given GoogleCredentials.

fromGoogleCredentials(GoogleCredential) - Static method in class io.spine.web.firebase.FirebaseCredentials

Deprecated.

please use FirebaseCredentials.fromGoogleCredentials(GoogleCredentials) or any other alternative instead

fromStream(InputStream) - Static method in class io.spine.web.firebase.FirebaseCredentials

Creates a new instance of the FirebaseCredentials from the given credential stream.

I

io.spine.web.firebase - package io.spine.web.firebase

This package contains the implementation of the Spine web API using the Firebase Realtime Database to deliver data to web clients.

io.spine.web.firebase.query - package io.spine.web.firebase.query

This package contains an implementation of the Spine web query API.

io.spine.web.firebase.rest - package io.spine.web.firebase.rest

This package contains a REST implementation of a Firebase client.

io.spine.web.firebase.subscription - package io.spine.web.firebase.subscription

This package contains a Firebase implementation of the Spine web subscription API.

isEmpty() - Method in class io.spine.web.firebase.FirebaseCredentials

Checks if the instance of the FirebaseCredentials is empty.

isNull() - Method in class io.spine.web.firebase.StoredJson

Checks if this JSON is equal to the null JSON value.

K

keepUp(Subscription) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge

N

newBuilder() - Static method in class io.spine.web.firebase.query.FirebaseQueryBridge

Creates a new instance of Builder for FirebaseQueryBridge instances.

newBuilder() - Static method in class io.spine.web.firebase.rest.RemoteDatabaseClient

Creates a new instance of Builder for RemoteDatabaseClient instances.

newBuilder() - Static method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge

Creates a new instance of Builder for FirebaseQueryBridge instances.

NodePaths - Class in io.spine.web.firebase

A static factory for NodePath.

NodeValue - Class in io.spine.web.firebase

The Firebase database node value.

nullValue() - Static method in class io.spine.web.firebase.StoredJson

O

of(String...) - Static method in class io.spine.web.firebase.NodePaths

Creates a NodePath by joining the given elements.

of(String) - Static method in class io.spine.web.firebase.NodePaths

Creates a NodePath from the given string.

R

remoteClient(FirebaseDatabase) - Static method in class io.spine.web.firebase.FirebaseClientFactory

Creates a firebase client which operates via the Firebase REST API.

remoteClient(FirebaseDatabase, FirebaseCredentials) - Static method in class io.spine.web.firebase.FirebaseClientFactory

Creates a RemoteDatabaseClient which uses given credentials to authorize its requests to the Firebase database.

RemoteDatabaseClient - Class in io.spine.web.firebase.rest

A FirebaseClient which operates via the Firebase REST API and the Java Admin SDK.

RemoteDatabaseClient.Builder - Class in io.spine.web.firebase.rest

A builder for the RemoteDatabaseClient instances.

S

send(Query) - Method in class io.spine.web.firebase.query.FirebaseQueryBridge

Sends the given Query to the QueryService and stores the query response into the database.

setBackOff(Supplier<BackOff>) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient.Builder

setDatabase(FirebaseDatabase) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient.Builder

setFirebaseClient(FirebaseClient) - Method in class io.spine.web.firebase.query.FirebaseQueryBridge.Builder

setFirebaseClient(FirebaseClient) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge.Builder

setQueryService(QueryServiceGrpc.QueryServiceImplBase) - Method in class io.spine.web.firebase.query.FirebaseQueryBridge.Builder

setRequestFactory(HttpRequestFactory) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient.Builder

setSubscriptionLifeSpan(Duration) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge.Builder

setSubscriptionService(SubscriptionServiceGrpc.SubscriptionServiceImplBase) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge.Builder

StoredJson - Class in io.spine.web.firebase

A JSON representation of data stored in a node of a Firebase Realtime DB.

subscribe(Topic) - Method in class io.spine.web.firebase.subscription.FirebaseSubscriptionBridge

subscribeTo(NodePath, ChildEventListener) - Method in class io.spine.web.firebase.AsyncClient

subscribeTo(NodePath, ChildEventListener) - Method in interface io.spine.web.firebase.FirebaseClient

Subscribes to the child events of the given node.

subscribeTo(NodePath, ChildEventListener) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient

T

toByteArray() - Method in class io.spine.web.firebase.NodeValue

Converts the value to the byte array suitable for usage in the HTTP request.

toString() - Method in class io.spine.web.firebase.NodeValue

U

underlyingJson() - Method in class io.spine.web.firebase.NodeValue

update(NodePath, NodeValue) - Method in class io.spine.web.firebase.AsyncClient

update(NodePath, NodeValue) - Method in interface io.spine.web.firebase.FirebaseClient

Merges the specified value to the Firebase database node.

update(NodePath, NodeValue) - Method in class io.spine.web.firebase.rest.RemoteDatabaseClient

W

withChildren(Iterable<StoredJson>) - Static method in class io.spine.web.firebase.NodeValue

Creates a new node value with all the given JSONs as its children.

A B C D E F I K N O R S T U W