Package org.forgerock.openig.tools.session

Class CrestSessionService.Builder

java.lang.Object

org.forgerock.openig.tools.session.CrestSessionService.Builder

Enclosing class:

CrestSessionService

public static final class CrestSessionService.Builder
extends Object

Builder of the CrestSessionService.

Method Summary

Modifier and Type	Method	Description
SessionService	build(AmVersion amVersion)	Returns a SessionService implementation based on the AmVersion.
CrestSessionService.Builder	sessionCaching(boolean sessionCaching)	Setting this to true indicates that session caching is enabled.
CrestSessionService.Builder	sessionIdleRefreshEnabled(boolean sessionIdleRefreshEnabled)	Setting this to true indicates that session idle refresh is enabled.
CrestSessionService.Builder	sessionIdleRefreshInterval(Duration interval)	Set the session idle refresh interval.
CrestSessionService.Builder	sessionProperties(Set<String> sessionProperties)	Set the session properties on this Builder.

Methods inherited from class java.lang.Object

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

Method Detail

sessionProperties

public CrestSessionService.Builder sessionProperties(Set<String> sessionProperties)

Set the session properties on this Builder. These will be transformed in to properties before being used in the sessionInfo request.

Parameters:

sessionProperties - The session properties to request from the session info endpoint.

Returns:

this Builder

sessionCaching

public CrestSessionService.Builder sessionCaching(boolean sessionCaching)

Setting this to true indicates that session caching is enabled.

Parameters:

sessionCaching - Set to true to indicate that session caching is enabled.

Returns:

this Builder

sessionIdleRefreshEnabled

public CrestSessionService.Builder sessionIdleRefreshEnabled(boolean sessionIdleRefreshEnabled)

Setting this to true indicates that session idle refresh is enabled.

Parameters:

sessionIdleRefreshEnabled - Set to true to indicate that session idle refresh is enabled.

Returns:

this Builder

sessionIdleRefreshInterval

public CrestSessionService.Builder sessionIdleRefreshInterval(Duration interval)

Set the session idle refresh interval. Wait at least this long between sessionInfo requests before triggering a session idle refresh.

Parameters:

interval - Set the session idle refresh interval.

Returns:

this Builder.

build

public SessionService build(AmVersion amVersion)

Returns a SessionService implementation based on the AmVersion.

Parameters:

amVersion - The AmVersion that should be taken into account when creating the CREST implementation of the SessionService.

Returns:

a SessionService instance.