Record Class LogoutPerformed

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.audit.LogoutPerformed

Record Components:

timestamp - UTC creation time, never null

subjectId - subject identifier, never null

sessionId - session that was terminated, or null if not tracked (e.g. LogoutScope.CurrentSession without a known session id)

scope - scope of the logout, never null

All Implemented Interfaces:

AuditEvent

public record LogoutPerformed(Instant timestamp, String subjectId, String sessionId, LogoutScope scope)
extends Record
implements AuditEvent

A subject's session was terminated by an explicit logout.

Constructor Summary

Constructors

Constructor	Description
LogoutPerformed(Instant timestamp, String subjectId, String sessionId, LogoutScope scope)	Creates an instance of a LogoutPerformed record class.

Method Summary

Modifier and Type	Method	Description
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.
LogoutScope	scope()	Returns the value of the scope record component.
String	sessionId()	Returns the value of the sessionId record component.
String	subjectId()	Returns the value of the subjectId record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

LogoutPerformed

public LogoutPerformed(Instant timestamp,
 String subjectId,
 String sessionId,
 LogoutScope scope)

Creates an instance of a LogoutPerformed record class.

Parameters:

timestamp - the value for the timestamp record component

subjectId - the value for the subjectId record component

sessionId - the value for the sessionId record component

scope - the value for the scope record component

Method Details

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.

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface AuditEvent

Returns:

the value of the timestamp record component

subjectId

public String subjectId()

Returns the value of the subjectId record component.

Returns:

the value of the subjectId record component

sessionId

public String sessionId()

Returns the value of the sessionId record component.

Returns:

the value of the sessionId record component

scope

public LogoutScope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component