org.restonfire.responses

Class FirebaseSecurityRules

java.lang.Object

org.restonfire.responses.FirebaseSecurityRules

public class FirebaseSecurityRules
extends java.lang.Object

POJO representing the Firebase rules model consisting of a single property named "rules", which contains a map of nested key-value pairs. Keys are always strings, while objects can either be boolean, an expression string, or a map of key-value pairs for the node's children.

This class does also contain constants for common key names such as ".read".

See Also:

Firebase Security Rules

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEX_KEY The key to be used when setting an index.
static java.lang.String	READ_KEY The key to be used for setting read access.
static java.lang.String	VALIDATE_KEY The key to be used for validating new inputs.
static java.lang.String	WRITE_KEY The key to be used for setting write access.

Constructor Summary

Constructors

Constructor and Description
FirebaseSecurityRules()
FirebaseSecurityRules(java.util.Map<java.lang.String,java.lang.Object> rules)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getRules() Returns the representation of the Firebase in form of a map.

Methods inherited from class java.lang.Object

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

Field Detail

WRITE_KEY

public static final java.lang.String WRITE_KEY

The key to be used for setting write access.

See Also:

Constant Field Values

READ_KEY

public static final java.lang.String READ_KEY

The key to be used for setting read access.

See Also:

Constant Field Values

VALIDATE_KEY

public static final java.lang.String VALIDATE_KEY

The key to be used for validating new inputs.

See Also:

Constant Field Values

INDEX_KEY

public static final java.lang.String INDEX_KEY

The key to be used when setting an index.

See Also:

Constant Field Values

Constructor Detail

FirebaseSecurityRules

public FirebaseSecurityRules()

FirebaseSecurityRules

public FirebaseSecurityRules(java.util.Map<java.lang.String,java.lang.Object> rules)

Method Detail

getRules

public java.util.Map<java.lang.String,java.lang.Object> getRules()

Returns the representation of the Firebase in form of a map. Each key is either the name of the permission (.read, .write), the validation rule (.validate), or the name of the property or variables. The value can either consist of a Boolean value, a String of this key's rule definition, or another map representing the rules of the children of the current node.

Returns:

A deep map of the firebase rules.

See Also:

Firebase Database Security Rules for more information