org.restonfire

Interface FirebaseRestDatabase

public interface FirebaseRestDatabase

A FirebaseRestDatabase is a base representation of a Firebase database. It manages all resources for the FirebaseRestReference implementations as well as handles authentication for that database.

Method Summary

Methods

Modifier and Type	Method and Description
FirebaseRestEventStream	getEventStream(java.lang.String path) Returns a FirebaseRestEventStream object representing the provided location of the namespace.
FirebaseRestReference	getReference(java.lang.String path) Returns a FirebaseRestReference object representing the provided location of the database.
FirebaseSecurityRulesReference	getSecurityRules() Returns a FirebaseSecurityRulesReference object for this namespaces.

Method Detail

getReference

FirebaseRestReference getReference(java.lang.String path)

Returns a FirebaseRestReference object representing the provided location of the database. With this reference object, the consumer can read or modify the data at this location, or travers further down or up the tree.

Parameters:

path - The location within database to create a reference for.

Returns:

The FirebaseRestReference for the given path.

getEventStream

FirebaseRestEventStream getEventStream(java.lang.String path)

Returns a FirebaseRestEventStream object representing the provided location of the namespace. With this reference object, the consumer can listen to changes for the data at this location, or travers further down or up the tree.

Parameters:

path - The location within database to create a event stream for.

Returns:

The FirebaseRestEventStream for the given path.

getSecurityRules

FirebaseSecurityRulesReference getSecurityRules()

Returns a FirebaseSecurityRulesReference object for this namespaces. The object can be used to retrieve or modify the access rules, add validation or indexes.

Returns:

The FirebaseSecurityRulesReference for this namespace.