io.spine.web.firebase

Class FirebaseCredentials

java.lang.Object

io.spine.web.firebase.FirebaseCredentials

All Implemented Interfaces:

com.google.api.client.http.HttpRequestInitializer

public final class FirebaseCredentials
extends java.lang.Object
implements com.google.api.client.http.HttpRequestInitializer

A Firebase Database credentials.

This type can be used as an authentication facility for the requests to Firebase REST API.

See Firebase REST docs.

Method Summary

Modifier and Type	Method and Description
static FirebaseCredentials	empty() Creates an empty instance of FirebaseCredentials.
static FirebaseCredentials	fromGoogleCredentials(com.google.api.client.googleapis.auth.oauth2.GoogleCredential credentials) Deprecated. please use FirebaseCredentials.fromGoogleCredentials(GoogleCredentials) or any other alternative instead
static FirebaseCredentials	fromGoogleCredentials(com.google.auth.oauth2.GoogleCredentials credentials) Creates a new FirebaseCredentials from the given GoogleCredentials.
static FirebaseCredentials	fromStream(java.io.InputStream credentialStream) Creates a new instance of the FirebaseCredentials from the given credential stream.
boolean	isEmpty() Checks if the instance of the FirebaseCredentials is empty.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.api.client.http.HttpRequestInitializer

initialize

Method Detail

empty

public static FirebaseCredentials empty()

Creates an empty instance of FirebaseCredentials.

Returns:

an empty FirebaseCredentials

fromGoogleCredentials

public static FirebaseCredentials fromGoogleCredentials(com.google.auth.oauth2.GoogleCredentials credentials)

Creates a new FirebaseCredentials from the given GoogleCredentials.

This method sets scopes required to use the Firebase database.

This method is useful to create credentials from the application default credentials.

Parameters:

credentials - the credentials to create from

Returns:

a new instance of FirebaseCredentials

fromGoogleCredentials

@Deprecated
public static FirebaseCredentials fromGoogleCredentials(com.google.api.client.googleapis.auth.oauth2.GoogleCredential credentials)

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

Creates a new FirebaseCredentials from the given GoogleCredentials.

This method sets scopes required to use the Firebase database.

fromStream

public static FirebaseCredentials fromStream(java.io.InputStream credentialStream)

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

Typically the stream will contain a service account JSON file data.

See docs for details on how to obtain the file.

Parameters:

credentialStream - the stream containing credentials data

Returns:

a new instance of FirebaseCredentials

Throws:

java.lang.IllegalArgumentException - in case there are problems with parsing the given stream into GoogleCredentials

isEmpty

public boolean isEmpty()

Checks if the instance of the FirebaseCredentials is empty.

Returns:

true if FirebaseCredentials are empty and false otherwise