com.firebase.client

Interface CredentialStore

public interface CredentialStore

A CredentialStore securely persists authentication credentials. WARNING: An implementation should make sure credentials are never available to untrusted parties.

Since:

1.1

Method Summary

Modifier and Type	Method and Description
boolean	clearCredential(String firebaseId, String sessionId) Clears and deletes a credential.
String	loadCredential(String firebaseId, String sessionId) Loads a credential from the store.
boolean	storeCredential(String firebaseId, String sessionId, String credential) Stores a credential for a given Firebase ID.

Method Detail

loadCredential

String loadCredential(String firebaseId,
                      String sessionId)

Loads a credential from the store. Returns null if no credential is found

Parameters:

firebaseId - An ID for the Firebase this credential is used for.

sessionId - A session identifier that is used to identify multiple sessions per Firebase.

Returns:

The credentials or null if no credentials are stored.

storeCredential

boolean storeCredential(String firebaseId,
                        String sessionId,
                        String credential)

Stores a credential for a given Firebase ID.

Parameters:

firebaseId - An ID for the Firebase this credential is used for.

sessionId - A session identifier that is used to identify multiple sessions per Firebase.

credential - The credential to store

Returns:

True if the credential was stored successfully, false if there was an error storing the credential.

clearCredential

boolean clearCredential(String firebaseId,
                        String sessionId)

Clears and deletes a credential.

Parameters:

firebaseId - An ID for the Firebase this credential is used for.

sessionId - A session identifier that is used to identify multiple sessions per Firebase.

Returns:

True if the credential was successfully cleared, false if there was an error removing the credential.