com.mongodb.stitch.android.core.auth

Interface StitchAuth

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

StitchAuthImpl

public interface StitchAuth
extends Closeable

StitchAuth manages authentication for any Stitch based client. It provides methods for logging in with various authentication providers using StitchCredentials, retrieving the current user, and getting authentication provider clients to perform actions such as registering users and creating user API keys.

Method Summary

Modifier and Type	Method and Description
void	addAuthListener(StitchAuthListener listener) Adds a listener for any important auth event.
<ClientT> ClientT	getProviderClient(AuthProviderClientFactory<ClientT> factory) Gets a client for the given authentication provider.
<T> T	getProviderClient(NamedAuthProviderClientFactory<T> factory, String providerName) Gets a client for the given named authentication provider.
StitchUser	getUser() Returns the currently logged in user; null if not logged in.
boolean	isLoggedIn() Returns whether or not there's a currently logged in user.
Task<StitchUser>	loginWithCredential(StitchCredential credential) Logs a user in with the given credentials associated with an authentication provider created from getProviderClient(AuthProviderClientFactory) or getProviderClient(NamedAuthProviderClientFactory, String).
Task<Void>	logout() Logs out the currently logged in user.
void	removeAuthListener(StitchAuthListener listener) Removes a listener.

Methods inherited from interface java.io.Closeable

close

Method Detail

getProviderClient

<ClientT> ClientT getProviderClient(AuthProviderClientFactory<ClientT> factory)

Gets a client for the given authentication provider. Most authentication providers will allow creation of a client without a name of the provider.

Type Parameters:

ClientT - The type of client to be returned by the factory.

Parameters:

factory - The factory that will create a client for the authentication provider.

Returns:

A client to interact with the authentication provider.

getProviderClient

<T> T getProviderClient(NamedAuthProviderClientFactory<T> factory,
                        String providerName)

Gets a client for the given named authentication provider.

Type Parameters:

T - the type of client to be returned by the factory.

Parameters:

factory - the factory that will create a client for the authentication provider.

providerName - the name of the authentication provider.

Returns:

a client to interact with the authentication provider.

loginWithCredential

Task<StitchUser> loginWithCredential(StitchCredential credential)

Logs a user in with the given credentials associated with an authentication provider created from getProviderClient(AuthProviderClientFactory) or getProviderClient(NamedAuthProviderClientFactory, String).

Parameters:

credential - the credentials of the user to log in.

Returns:

a Task containing user associated with the credentials if log in is successful.

logout

Task<Void> logout()

Logs out the currently logged in user.

Returns:

a Task completing when logged out.

isLoggedIn

boolean isLoggedIn()

Returns whether or not there's a currently logged in user.

Returns:

whether or not there's a currently logged in user.

getUser

@Nullable
StitchUser getUser()

Returns the currently logged in user; null if not logged in.

Returns:

the currently logged in user; null if not logged in.

addAuthListener

void addAuthListener(StitchAuthListener listener)

Adds a listener for any important auth event.

Parameters:

listener - the listener to add.

See Also:

StitchAuthListener

removeAuthListener

void removeAuthListener(StitchAuthListener listener)

Removes a listener.

Parameters:

listener - the listener to remove.