Record Class SessionId

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.session.SessionId
Record Components:
value - non-blank session identifier
@ExperimentalJSentinelApi public record SessionId(String value) extends Record
Strongly-typed identifier of an authenticated session.

Used as the primary key of SessionStore. The value component is intentionally a free-form String so adapters can supply whatever shape their session mechanism produces (Vaadin's session id, an opaque token, a JWT id); the record only guarantees non-blank.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SessionId(String value)
    Validates the record component.

  • 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.
    static SessionId
    of(String value)
    Factory mirror of the canonical constructor.
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

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

  • Constructor Details

    • SessionId

      public SessionId(String value)
      Validates the record component.
      Parameters:
      value - non-blank session identifier

  • Method Details

    • of

      public static SessionId of(String value)
      Factory mirror of the canonical constructor.
      Parameters:
      value - non-blank session identifier
      Returns:
      new SessionId

    • 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.

    • value

      public String value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component