io.realm

Interface UserStore

All Known Implementing Classes:

RealmFileUserStore

public interface UserStore

Interface for classes responsible for saving and retrieving Object Server users again.

Any implementation of a User Store is expected to not perform lengthy blocking operations as it might be called on the Main Thread. All implementations of this interface should be thread safe.

See Also:

SyncManager.setUserStore(UserStore), 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 authenticationUrl) 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 authenticationUrl) Removes the user from the store.

Method Detail

put

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.

Parameters:

user - SyncUser object to store.

getCurrent

SyncUser getCurrent()

Retrieves the current SyncUser.

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

Returns:

SyncUser object or null if not found.

get

SyncUser get(String identity,
             String authenticationUrl)

Retrieves specified SyncUser.

Parameters:

identity - identity of the user.

authenticationUrl - the URL of the authentication.

Returns:

SyncUser object or null if not found.

remove

void remove(String identity,
            String authenticationUrl)

Removes the user from the store.

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

Parameters:

identity - identity of the user.

authenticationUrl - the URL of the authentication.

allUsers

Collection<SyncUser> allUsers()

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

Returns:

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

isActive

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.

Parameters:

identity - identity of the user.

authenticationUrl - the URL of the authentication.

Returns:

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