Record Class ApiKeyUsed

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.audit.ApiKeyUsed
Record Components:
timestamp - UTC use time; non-null
subjectId - subject the key authenticates; non-blank
keyName - human-readable label of the key; non-blank
keyHash - hash of the used key; non-blank
All Implemented Interfaces:
AuditEvent
public record ApiKeyUsed(Instant timestamp, String subjectId, String keyName, String keyHash) extends Record implements AuditEvent
Emitted when an API-key was successfully used to authenticate a request — i.e. ApiKeyAuthenticationService.authenticate returned an active record.

  • Constructor Details

    • ApiKeyUsed

      public ApiKeyUsed(Instant timestamp, String subjectId, String keyName, String keyHash)
      Validates the record components.

  • 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

    • keyName

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

    • keyHash

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