Package org.forgerock.am.trees.model

Record Class SessionProperties

java.lang.Object

java.lang.Record

org.forgerock.am.trees.model.SessionProperties

Record Components:

properties - A map of String properties for the session.

maxSessionTime - The maximum time the session can be active.

maxIdleTime - The maximum time the session can be idle.

public record SessionProperties(Map<String,String> properties, Optional<Duration> maxSessionTime, Optional<Duration> maxIdleTime)
extends Record

Represents the properties used when creating a session at the end of a journey.

Constructor Summary

Constructors

Constructor	Description
SessionProperties(Map<String,String> properties)	Constructor for SessionProperties without timeout values.
SessionProperties(Map<String,String> properties, Optional<Duration> maxSessionTime, Optional<Duration> maxIdleTime)	Constructor for SessionProperties.

Method Summary

Modifier and Type	Method	Description
static SessionProperties	empty()	Creates an empty SessionProperties object.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<Duration>	maxIdleTime()	Returns the value of the maxIdleTime record component.
Optional<Duration>	maxSessionTime()	Returns the value of the maxSessionTime record component.
Map<String,String>	properties()	Returns the value of the properties record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SessionProperties

public SessionProperties(Map<String,String> properties,
 Optional<Duration> maxSessionTime,
 Optional<Duration> maxIdleTime)

Constructor for SessionProperties.

Parameters:

properties - A map of String properties for the session.

maxSessionTime - The maximum time the session can be active.

maxIdleTime - The maximum time the session can be idle.

SessionProperties

public SessionProperties(Map<String,String> properties)

Constructor for SessionProperties without timeout values.

Parameters:

properties - A map of String properties for the session.

Method Details

empty

public static SessionProperties empty()

Creates an empty SessionProperties object.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

properties

public Map<String,String> properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component

maxSessionTime

public Optional<Duration> maxSessionTime()

Returns the value of the maxSessionTime record component.

Returns:

the value of the maxSessionTime record component

maxIdleTime

public Optional<Duration> maxIdleTime()

Returns the value of the maxIdleTime record component.

Returns:

the value of the maxIdleTime record component