org.forgerock.openig.tools.session

Interface SessionService

All Known Implementing Classes:

CacheSessionService, CrestSessionService

public interface SessionService

The SessionService is responsible to perform interactions with AM sessions endpoint, such as session info or logout, etc.

Method Summary

Modifier and Type	Method and Description
Promise<Optional<SessionInfo>,SessionException>	getSessionInfo(Context context, String ssoToken) Returns a promise that will be completed with an optional SessionInfo or with an SessionException in case of errors.
Promise<Void,SessionException>	logout(Context context, String ssoToken) Returns a promise that will be completed with a Void or with an SessionException in case of errors.

Method Detail

getSessionInfo

Promise<Optional<SessionInfo>,SessionException> getSessionInfo(Context context,
                                                               String ssoToken)

Returns a promise that will be completed with an optional SessionInfo or with an SessionException in case of errors. The optional SessionInfo will be empty only when the given ssoToken is invalid or expired.

Parameters:

context - The request context.

ssoToken - The ssoToken used to retrieve the session information about.

Returns:

a promise that will be completed with SessionInfo or with an SessionException in case of errors.

logout

Promise<Void,SessionException> logout(Context context,
                                      String ssoToken)

Returns a promise that will be completed with a Void or with an SessionException in case of errors.

Parameters:

context - The request context.

ssoToken - The ssoToken to logout.

Returns:

a promise that will be completed with a Void or with an SessionException in case of errors.