org.forgerock.android.auth

Class FRUser

java.lang.Object

org.forgerock.android.auth.FRUser

public class FRUser
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FRUser.Browser

Method Summary

Modifier and Type	Method and Description
static FRUser.Browser	browser()
AccessToken	getAccessToken()
void	getAccessToken(FRListener<AccessToken> listener) Retrieve the AccessToken asynchronously,
static FRUser	getCurrentUser() Retrieve the existing FRUser instance,
void	getUserInfo(FRListener<UserInfo> listener) Handles REST requests to the OpenId Connect userinfo endpoint for retrieving information about the user who granted the authorization for the token.
static void	login(android.content.Context context, NodeListener<FRUser> listener) Trigger the user login process, the login service name is defined under string.xml file with forgerock_auth_service
void	logout() Logout the user
static void	register(android.content.Context context, NodeListener<FRUser> listener) Trigger the user registration process, the registration service name is defined under string.xml file with forgerock_registration_service
void	revokeAccessToken(FRListener<java.lang.Void> listener) Revoke the AccessToken asynchronously,

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentUser

public static FRUser getCurrentUser()

Retrieve the existing FRUser instance,

If user session does not exist return null, otherwise return the existing FRUser with the associated user session, this cannot guarantee the existing user session is valid.

Returns:

The existing FRUser instance, or null if there is no user session.

logout

public void logout()

Logout the user

revokeAccessToken

public void revokeAccessToken(FRListener<java.lang.Void> listener)

Revoke the AccessToken asynchronously,

Parameters:

listener - Listener to listen for token revocation event.

getAccessToken

public void getAccessToken(FRListener<AccessToken> listener)

Retrieve the AccessToken asynchronously,

If the stored AccessToken is expired, auto refresh the token.

Parameters:

listener - Listener to listen get Access Token event.

getAccessToken

public AccessToken getAccessToken()
                           throws AuthenticationRequiredException

Throws:

AuthenticationRequiredException

getUserInfo

public void getUserInfo(FRListener<UserInfo> listener)

Handles REST requests to the OpenId Connect userinfo endpoint for retrieving information about the user who granted the authorization for the token.

Parameters:

listener - Listener to listen get UserInfo event.

login

public static void login(android.content.Context context,
                         NodeListener<FRUser> listener)

Trigger the user login process, the login service name is defined under string.xml file with forgerock_auth_service

Parameters:

context - The Application Context

listener - Listener to listen login event. Throw AlreadyAuthenticatedException user session already exists.

register

public static void register(android.content.Context context,
                            NodeListener<FRUser> listener)

Trigger the user registration process, the registration service name is defined under string.xml file with forgerock_registration_service

Parameters:

context - The Application Context

listener - Listener to listen register event. Throw AlreadyAuthenticatedException user session already exists.

browser

public static FRUser.Browser browser()