Package org.forgerock.openig.session.cookie

Class IdBasedSessionManager

java.lang.Object

org.forgerock.openig.session.cookie.IdBasedSessionManager

All Implemented Interfaces:

AsyncSessionManager

public class IdBasedSessionManager
extends Object
implements AsyncSessionManager

An implementation of AsyncSessionManager storing session ID in a session cookie.

Constructor Summary

Constructors

Constructor	Description
IdBasedSessionManager(org.forgerock.openig.http.protocol.CookieBuilder cookieBuilder, org.forgerock.openig.session.cookie.InMemorySessionStore sessionStore)	Create a new IdBasedSessionManager instance.

Method Summary

Modifier and Type	Method	Description
Promise<Session,NeverThrowsException>	loadAsync(Request request)	Loads a new Session for the given Request.
Promise<Void,IOException>	saveAsync(Session session, Response response)	Saves the session into the provided response.

Methods inherited from class java.lang.Object

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

Constructor Details

IdBasedSessionManager

public IdBasedSessionManager(org.forgerock.openig.http.protocol.CookieBuilder cookieBuilder,
 org.forgerock.openig.session.cookie.InMemorySessionStore sessionStore)

Create a new IdBasedSessionManager instance.

Parameters:

cookieBuilder - the cookie builder to use to create the session cookie.

sessionStore - the session store to use to store the session content.

Method Details

loadAsync

public Promise<Session,NeverThrowsException> loadAsync(Request request)

Description copied from interface: AsyncSessionManager

Loads a new Session for the given Request. The implementations are free to keep a reference to the Request.

The session object is scoped by the Request's own lifecycle.

Specified by:

loadAsync in interface AsyncSessionManager

Parameters:

request - Request to create a session for.

Returns:

a new Session promise (never null).

saveAsync

public Promise<Void,IOException> saveAsync(Session session,
 Response response)

Description copied from interface: AsyncSessionManager

Saves the session into the provided response.

Specified by:

saveAsync in interface AsyncSessionManager

Parameters:

session - The session to save.

response - The response to save the session to.

Returns:

a promise completed with null if save operation succeeded, otherwise failed with an IOException.