org.aerogear.mobile.auth

Class AuthService

java.lang.Object

org.aerogear.mobile.auth.AuthService

All Implemented Interfaces:

org.aerogear.mobile.core.ServiceModule

public class AuthService
extends java.lang.Object
implements org.aerogear.mobile.core.ServiceModule

Entry point for authenticating users.

Constructor Summary

Constructors

Constructor and Description
AuthService() Instantiates a new AuthService object

Method Summary

Modifier and Type	Method and Description
void	configure(org.aerogear.mobile.core.MobileCore core, org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration)
UserPrincipal	currentUser() Return the user that is currently logged and is still valid.
void	deleteTokens() Delete the the current tokens/authentication state.
void	handleAuthResult(android.content.Intent data) This function should be called in the start activity's "onActivityResult" method to allow the SDK to process the response from the authentication server.
void	init(android.content.Context context, AuthServiceConfiguration authServiceConfiguration) Initialize the module.
void	init(android.content.Context context, AuthServiceConfiguration authServiceConfiguration, BrowserConfiguration browserConfiguration) Initialize the module.
void	login(DefaultAuthenticateOptions authOptions, org.aerogear.mobile.core.Callback<UserPrincipal> callback) Log in the user with the given authentication options.
void	logout(UserPrincipal principal, org.aerogear.mobile.core.Callback<UserPrincipal> callback) Log out the given principal.
boolean	requiresConfiguration()
java.lang.String	type()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthService

public AuthService()

Instantiates a new AuthService object

Method Detail

currentUser

public UserPrincipal currentUser()

Return the user that is currently logged and is still valid. Otherwise returns null

Returns:

the current logged in. Could be null.

login

public void login(@NonNull
                  DefaultAuthenticateOptions authOptions,
                  @NonNull
                  org.aerogear.mobile.core.Callback<UserPrincipal> callback)

Log in the user with the given authentication options. At the moment, only OIDC protocol is supported. The login will be asynchronous.

Parameters:

authOptions - the authentication options

callback - the callback function that will be invoked with the user info

deleteTokens

public void deleteTokens()

Delete the the current tokens/authentication state.

handleAuthResult

public void handleAuthResult(@NonNull
                             android.content.Intent data)

This function should be called in the start activity's "onActivityResult" method to allow the SDK to process the response from the authentication server.

Parameters:

data - The intent data that is passed to "onActivityResult"

logout

public void logout(@NonNull
                   UserPrincipal principal,
                   @NonNull
                   org.aerogear.mobile.core.Callback<UserPrincipal> callback)

Log out the given principal. The logout will be asynchronous.

Parameters:

principal - principal to be logged out

callback - the callback function to be invoked

type

public java.lang.String type()

Specified by:

type in interface org.aerogear.mobile.core.ServiceModule

configure

public void configure(org.aerogear.mobile.core.MobileCore core,
                      org.aerogear.mobile.core.configuration.ServiceConfiguration serviceConfiguration)

Specified by:

configure in interface org.aerogear.mobile.core.ServiceModule

init

public void init(android.content.Context context,
                 AuthServiceConfiguration authServiceConfiguration)

Initialize the module. This should be called before any other method when using the module.

Parameters:

context - the current application context

authServiceConfiguration - the configuration of the auth service

init

public void init(android.content.Context context,
                 AuthServiceConfiguration authServiceConfiguration,
                 BrowserConfiguration browserConfiguration)

Initialize the module. This should be called before any other method when using the module.

Parameters:

context - the current application context

authServiceConfiguration - the configuration of the auth service

browserConfiguration - the configuration for the browser used during authentication

requiresConfiguration

public boolean requiresConfiguration()

Specified by:

requiresConfiguration in interface org.aerogear.mobile.core.ServiceModule