org.forgerock.android.auth

Class FRSession

java.lang.Object

org.forgerock.android.auth.FRSession

public class FRSession
extends java.lang.Object

Object which represent the User Session

Method Summary

Modifier and Type	Method and Description
void	authenticate(android.content.Context context, PolicyAdvice advice, NodeListener<FRSession> listener) Trigger the Authentication Tree flow process with the PolicyAdvice
static void	authenticate(android.content.Context context, java.lang.String serviceName, NodeListener<FRSession> listener) Trigger the Authentication Tree flow process with the provided tree name
static void	authenticate(android.content.Context context, android.net.Uri resumeURI, NodeListener<FRSession> listener) Trigger the Authentication Tree flow process with the provided resume URI
static FRSession	getCurrentSession() Retrieve the existing FRSession instance,
java.util.Collection<java.lang.String>	getSessionCookies()
SSOToken	getSessionToken() Retrieve the stored Session Token.
void	logout() Logout the user

Methods inherited from class java.lang.Object

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

Method Detail

logout

public void logout()

Logout the user

getCurrentSession

public static FRSession getCurrentSession()

Retrieve the existing FRSession instance,

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

Returns:

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

getSessionToken

public SSOToken getSessionToken()

Retrieve the stored Session Token.

Returns:

The Session Token

getSessionCookies

public java.util.Collection<java.lang.String> getSessionCookies()

authenticate

public void authenticate(android.content.Context context,
                         PolicyAdvice advice,
                         NodeListener<FRSession> listener)

Trigger the Authentication Tree flow process with the PolicyAdvice

Parameters:

context - The Application Context

advice - Policy Advice for Step up authentication.

listener - Listener to listen login event.

authenticate

public static void authenticate(android.content.Context context,
                                java.lang.String serviceName,
                                NodeListener<FRSession> listener)

Trigger the Authentication Tree flow process with the provided tree name

Parameters:

context - The Application Context

serviceName - Authentication Tree name

listener - Listener to listen login event.

authenticate

public static void authenticate(android.content.Context context,
                                android.net.Uri resumeURI,
                                NodeListener<FRSession> listener)

Trigger the Authentication Tree flow process with the provided resume URI

Parameters:

context - The Application Context

resumeURI - Resume URI

listener - Listener to listen login event.