io.realm

Class SyncCredentials

java.lang.Object

io.realm.SyncCredentials

public class SyncCredentials
extends Object

This software is considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care.

Credentials represent a login with a 3rd party login provider in an OAuth2 login flow, and are used by the Realm Object Server to verify the user and grant access.

Logging into the Realm Object Server consists of the following steps:

1. Log in to 3rd party provider (Facebook, Google or Twitter). The result is usually an Authorization Grant that must be saved in a SyncCredentials object of the proper type e.g., facebook(String) for a Facebook login.
2. Authenticate a SyncUser through the Object Server using these credentials. Once authenticated, an Object Server user is returned. Then this user can be attached to a SyncConfiguration, which will make it possible to synchronize data between the local and remote Realm.

   It is possible to persist the user object e.g., using the UserStore. That means, logging into an OAuth2 provider is only required the first time the app is used.

 
 // Example

 Credentials credentials = Credentials.facebook(getFacebookToken());
 User.login(credentials, "http://objectserver.realm.io/auth", new User.Callback() {
     \@Override
     public void onSuccess(User user) {
          // User is now authenticated and be be used to open Realms.
     }

     \@Override
     public void onError(ObjectServerError error) {

     }
 });
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyncCredentials.IdentityProvider Enumeration of the different types of identity providers.

Method Summary

Modifier and Type	Method and Description
static SyncCredentials	custom(String identityProvider, String userIdentifier, Map<String,Object> userInfo) Creates a custom set of credentials.
static SyncCredentials	facebook(String facebookToken) Creates credentials based on a Facebook login.
String	getIdentityProvider() Returns the provider used by the Object Server to validate these credentials.
String	getUserIdentifier() Returns a String that identifies the user.
Map<String,Object>	getUserInfo() Returns any custom user information associated with this credential.
static SyncCredentials	google(String googleToken) Creates credentials based on a Google login.
static SyncCredentials	twitter(String twitterToken) Creates credentials based on a Twitter login.
static SyncCredentials	usernamePassword(String username, String password, boolean createUser) Creates credentials based on a login with username and password.

Methods inherited from class java.lang.Object

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

Method Detail

usernamePassword

public static SyncCredentials usernamePassword(String username,
                                               String password,
                                               boolean createUser)

Creates credentials based on a login with username and password. These credentials will only be verified by the Object Server.

Parameters:

username - username of the user.

password - the users password.

createUser - true if the user should be created, false otherwise. It is not possible to create a user twice when logging in, so this flag should only be set to true the first time a users log in.

Returns:

a set of credentials that can be used to log into the Object Server using SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback).

Throws:

IllegalArgumentException - if user name is either null or empty.

facebook

public static SyncCredentials facebook(String facebookToken)

Creates credentials based on a Facebook login.

Parameters:

facebookToken - a facebook userIdentifier acquired by logging into Facebook.

Returns:

a set of credentials that can be used to log into the Object Server using SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback)

Throws:

IllegalArgumentException - if user name is either null or empty.

google

public static SyncCredentials google(String googleToken)

Creates credentials based on a Google login.

Parameters:

googleToken - a google userIdentifier acquired by logging into Google.

Returns:

a set of credentials that can be used to log into the Object Server using SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback)

Throws:

IllegalArgumentException - if user name is either null or empty.

twitter

public static SyncCredentials twitter(String twitterToken)

Creates credentials based on a Twitter login.

Parameters:

twitterToken - a google userIdentifier acquired by logging into Twitter.

Returns:

a set of credentials that can be used to log into the Object Server using SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback)

Throws:

IllegalArgumentException - if user name is either null or empty.

custom

public static SyncCredentials custom(String identityProvider,
                                     String userIdentifier,
                                     Map<String,Object> userInfo)

Creates a custom set of credentials. The behaviour will depend on the type of identityProvider and userInfo used.

Parameters:

identityProvider - provider used to verify the credentials.

userIdentifier - String identifying the user. Usually a username of userIdentifier.

userInfo - data describing the user further or null if the user does not have any extra data. The data will be serialized to JSON, so all values must be mappable to a valid JSON data type. Custom classes will be converted using toString().

Returns:

a set of credentials that can be used to log into the Object Server using SyncUser.loginAsync(SyncCredentials, String, SyncUser.Callback).

Throws:

IllegalArgumentException - if any parameter is either null or empty.

getIdentityProvider

public String getIdentityProvider()

Returns the provider used by the Object Server to validate these credentials.

Returns:

the login type.

getUserIdentifier

public String getUserIdentifier()

Returns a String that identifies the user. The value will depend on the type of SyncCredentials.IdentityProvider used.

Returns:

a String identifying the user.

getUserInfo

public Map<String,Object> getUserInfo()

Returns any custom user information associated with this credential. The type of information will depend on the type of SyncCredentials.IdentityProvider used.

Returns:

a map of additional information about the user.