Package dev.dokimos.server.dto.v1

Record Class CreatedApiKeyView

java.lang.Object
java.lang.Record
dev.dokimos.server.dto.v1.CreatedApiKeyView
Record Components:
key - the raw API key, shown only here and never again
apiKey - metadata about the stored key
public record CreatedApiKeyView(String key, ApiKeyView apiKey) extends Record
Response returned exactly once when a key is minted. It carries the raw key so the caller can record it; the server stores only the key's hash and can never reproduce this value. Every later read uses ApiKeyView, which omits the key entirely.

  • Constructor Details

    • CreatedApiKeyView

      public CreatedApiKeyView(String key, ApiKeyView apiKey)
      Creates an instance of a CreatedApiKeyView record class.
      Parameters:
      key - the value for the key record component
      apiKey - the value for the apiKey record component

  • Method Details

    • of

      public static CreatedApiKeyView of(String rawKey, ApiKey entity)

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

    • key

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

    • apiKey

      public ApiKeyView apiKey()
      Returns the value of the apiKey record component.
      Returns:
      the value of the apiKey record component