Record Class ApiKeyDenied

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.audit.ApiKeyDenied
Record Components:
timestamp - UTC denial time; non-null
subjectId - subject the key would have authenticated, or empty when the key was unknown; may be empty
keyHash - hash of the rejected key; non-blank
reason - short denial reason ("Unknown", "Expired", "Revoked", "ForeignTenant"); non-blank
All Implemented Interfaces:
AuditEvent
public record ApiKeyDenied(Instant timestamp, String subjectId, String keyHash, String reason) extends Record implements AuditEvent
Emitted when an API-key authentication was refused — unknown key, expired, revoked, or in a foreign tenant.

subjectId can be empty when the key was unknown: there is no subject to attribute the rejection to. Audit consumers should pivot on reason() rather than subjectId.

  • Constructor Details

    • ApiKeyDenied

      public ApiKeyDenied(Instant timestamp, String subjectId, String keyHash, String reason)
      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

    • keyHash

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

    • reason

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