Package org.forgerock.openig.session.cookie

Class InMemorySessionManagerHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.session.cookie.InMemorySessionManagerHeaplet

All Implemented Interfaces:

Heaplet

public class InMemorySessionManagerHeaplet
extends GenericHeaplet

Supports configuring the session cookie/timeout using the following optional JSON structure, can be provided if overriding the defaults is required.

 
 {
     "timeout"            : duration            [OPTIONAL - session timeout as a duration, default is "30 min".]
     "cookie": {
         "name"           : String              [OPTIONAL - cookie name, default is "IG_SESSIONID".]
         "secure"         : boolean             [OPTIONAL - cookie secure flag, default is false.]
         "sameSite"       : CookieSameSite      [OPTIONAL - cookie sameSite value, default is LAX.]
         "httpOnly"       : boolean             [OPTIONAL - cookie httpOnly flag, default is true.]
         "path"           : String              [OPTIONAL - cookie path value, default is "/".]
     },
 }
 
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Public name used by resolver.

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
InMemorySessionManagerHeaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.
static JsonValue	defaultConfig(String name)	Creates a basic Json configuration for this heaplet.
void	destroy()	Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.

Methods inherited from class org.forgerock.openig.heap.GenericHeaplet

create, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getType, initialBindings, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Public name used by resolver.

See Also:

• Constant Field Values

Constructor Details

InMemorySessionManagerHeaplet

public InMemorySessionManagerHeaplet()

Method Details

create

public Object create()
              throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.create(Name, JsonValue, Heap) after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.

defaultConfig

public static JsonValue defaultConfig(String name)

Creates a basic Json configuration for this heaplet.

Parameters:

name - the name of the session cookie

Returns:

the configuration JsonValue

destroy

public void destroy()

Description copied from class: GenericHeaplet

Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.

Subclasses that override this method must call super.destroy() last, after releasing their own domain resources. This ensures that monitoring remains active for the full lifetime of those resources and that any metrics emitted during shutdown are not lost.

Specified by:

destroy in interface Heaplet

Overrides:

destroy in class GenericHeaplet