Record Class SignInSucceeded

java.lang.Object
java.lang.Record
org.jwcarman.who.core.event.SignInSucceeded
Record Components:
occurredAt - when it happened
method - the sign-in mechanism
identityId - the identity that signed in
credentialId - the credential that was used
All Implemented Interfaces:
WhoEvent

public record SignInSucceeded(Instant occurredAt, SignInMethod method, UUID identityId, UUID credentialId) extends Record implements WhoEvent
A sign-in succeeded: an email link, an email code or a passkey, published once the session is saved. API keys and JWTs authenticate every request and publish no SignInSucceeded; a refused key or token publishes SignInFailed. Spring Security's AuthenticationSuccessEvent reports each authenticated API-key request.
  • Constructor Details

    • SignInSucceeded

      public SignInSucceeded(Instant occurredAt, SignInMethod method, UUID identityId, UUID credentialId)
      Validates that no component is null.
  • 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.
    • occurredAt

      public Instant occurredAt()
      Returns the value of the occurredAt record component.
      Specified by:
      occurredAt in interface WhoEvent
      Returns:
      the value of the occurredAt record component
    • method

      public SignInMethod method()
      Returns the value of the method record component.
      Returns:
      the value of the method record component
    • identityId

      public UUID identityId()
      Returns the value of the identityId record component.
      Returns:
      the value of the identityId record component
    • credentialId

      public UUID credentialId()
      Returns the value of the credentialId record component.
      Returns:
      the value of the credentialId record component