Record Class CourseApiKeyView

java.lang.Object
java.lang.Record
edu.ucsb.cs156.frontiers.models.CourseApiKeyView
Record Components:
id - the key's id, used to revoke it
label - the name the instructor gave the key, or null
keySuffix - the last six characters of the key
createdByEmail - the email of the user who created the key
createdAt - when the key was created
expiresAt - when the key stops working
lastUsedAt - when the key was last used, or null if never
usageCount - how many requests have been made with the key
revoked - whether the key has been revoked
status - ACTIVE, EXPIRED or REVOKED, as of the time the view was built

public record CourseApiKeyView(Long id, String label, String keySuffix, String createdByEmail, ZonedDateTime createdAt, ZonedDateTime expiresAt, ZonedDateTime lastUsedAt, Long usageCount, boolean revoked, CourseApiKeyView.Status status) extends Record
What an instructor may see about one of their course's API keys: everything except the key itself, which is never stored and so can never be shown again. The last six characters of the key (keySuffix) are enough to tell keys apart without compromising them.
  • Constructor Details

    • CourseApiKeyView

      public CourseApiKeyView(Long id, String label, String keySuffix, String createdByEmail, ZonedDateTime createdAt, ZonedDateTime expiresAt, ZonedDateTime lastUsedAt, Long usageCount, boolean revoked, CourseApiKeyView.Status status)
      Creates an instance of a CourseApiKeyView record class.
      Parameters:
      id - the value for the id record component
      label - the value for the label record component
      keySuffix - the value for the keySuffix record component
      createdByEmail - the value for the createdByEmail record component
      createdAt - the value for the createdAt record component
      expiresAt - the value for the expiresAt record component
      lastUsedAt - the value for the lastUsedAt record component
      usageCount - the value for the usageCount record component
      revoked - the value for the revoked record component
      status - the value for the status record component
  • Method Details

    • from

      public static CourseApiKeyView from(CourseApiKey key, ZonedDateTime now)
      Builds the view of a key as of the given moment.
      Parameters:
      key - the key
      now - the current time, used to decide whether the key has expired
      Returns:
      the view
    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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 Long id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component
    • keySuffix

      public String keySuffix()
      Returns the value of the keySuffix record component.
      Returns:
      the value of the keySuffix record component
    • createdByEmail

      public String createdByEmail()
      Returns the value of the createdByEmail record component.
      Returns:
      the value of the createdByEmail record component
    • createdAt

      public ZonedDateTime createdAt()
      Returns the value of the createdAt record component.
      Returns:
      the value of the createdAt record component
    • expiresAt

      public ZonedDateTime expiresAt()
      Returns the value of the expiresAt record component.
      Returns:
      the value of the expiresAt record component
    • lastUsedAt

      public ZonedDateTime lastUsedAt()
      Returns the value of the lastUsedAt record component.
      Returns:
      the value of the lastUsedAt record component
    • usageCount

      public Long usageCount()
      Returns the value of the usageCount record component.
      Returns:
      the value of the usageCount record component
    • revoked

      public boolean revoked()
      Returns the value of the revoked record component.
      Returns:
      the value of the revoked record component
    • status

      public CourseApiKeyView.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component