io.realm

Class RealmFileUserStore

java.lang.Object

io.realm.RealmFileUserStore

All Implemented Interfaces:

UserStore

public class RealmFileUserStore
extends Object
implements UserStore

A User Store backed by a Realm file to store users.

Constructor Summary

Constructors

Constructor and Description
RealmFileUserStore()

Method Summary

Modifier and Type	Method and Description
Collection<SyncUser>	allUsers() Returns a collection of all users saved in the User store.
SyncUser	get(String identity, String authUrl) Retrieves specified SyncUser.
SyncUser	getCurrent() Retrieves the current SyncUser.
boolean	isActive(String identity, String authenticationUrl) Returns the state of the specified user: true if active (not logged out), false otherwise.
void	put(SyncUser user) Saves a SyncUser object.
void	remove(String identity, String authUrl) Removes the user from the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmFileUserStore

public RealmFileUserStore()

Method Detail

put

public void put(SyncUser user)

Saves a SyncUser object. If another user already exists, it will be replaced. SyncUser.getIdentity() is used as a unique identifier of a given SyncUser.

Specified by:

put in interface UserStore

Parameters:

user - SyncUser object to store.

getCurrent

public SyncUser getCurrent()

Retrieves the current SyncUser.

This method will throw an exception if more than one valid, logged in users exist.

Specified by:

getCurrent in interface UserStore

Returns:

SyncUser object or null if not found.

get

public SyncUser get(String identity,
                    String authUrl)

Retrieves specified SyncUser.

Specified by:

get in interface UserStore

Parameters:

identity - identity of the user.

authUrl - the URL of the authentication.

Returns:

SyncUser object or null if not found.

remove

public void remove(String identity,
                   String authUrl)

Removes the user from the store.

If the user is not found, this method does nothing.

Specified by:

remove in interface UserStore

Parameters:

identity - identity of the user.

authUrl - the URL of the authentication.

allUsers

public Collection<SyncUser> allUsers()

Returns a collection of all users saved in the User store.

Specified by:

allUsers in interface UserStore

Returns:

Collection of all users. If no users exist, an empty collection is returned.

isActive

public boolean isActive(String identity,
                        String authenticationUrl)

Returns the state of the specified user: true if active (not logged out), false otherwise. This method checks if the user was marked as logged out. If the user has expired but not actively logged out this method will return true.

Specified by:

isActive in interface UserStore

Parameters:

identity - identity of the user.

authenticationUrl - the URL of the authentication.

Returns:

true if the user is not logged out, false otherwise.