Package dev.relism.flash.ext.security.apikey

Record Class GeneratedApiKey

java.lang.Object
java.lang.Record
dev.relism.flash.ext.security.apikey.GeneratedApiKey
public record GeneratedApiKey(String id, String token, String secretHash) extends Record
A freshly generated key. token goes to the caller exactly once; the application stores id and secretHash, never the token.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeneratedApiKey(String id, String token, String secretHash)
    Creates an instance of a GeneratedApiKey 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.
    String
    id()
    Returns the value of the id record component.
    String
    secretHash()
    Returns the value of the secretHash record component.
    String
    token()
    Returns the value of the token record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GeneratedApiKey

      public GeneratedApiKey(String id, String token, String secretHash)
      Creates an instance of a GeneratedApiKey record class.
      Parameters:
      id - the value for the id record component
      token - the value for the token record component
      secretHash - the value for the secretHash record component

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

    • id

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

    • token

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

    • secretHash

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