Record Class SubjectId

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.logout.SubjectId
Record Components:
value - the subject identifier as exposed by the application's JSentinelSubject. Non-null, non-blank.
public record SubjectId(String value) extends Record
Strongly-typed wrapper around the application's stable subject identifier.

Used at API boundaries where the alternative — a raw String — would be ambiguous (a logout(String) call could plausibly mean a username, a token, a session id, an opaque audit id; a logout(SubjectId) call cannot).

  • Constructor Summary

    Constructors
    Constructor
    Description
    SubjectId(String value)
    Creates an instance of a SubjectId 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.
    static SubjectId
    of(String value)
    Convenience factory.
    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

    • SubjectId

      public SubjectId(String value)
      Creates an instance of a SubjectId record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • of

      public static SubjectId of(String value)
      Convenience factory.

    • 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