Record Class Actor

java.lang.Object
java.lang.Record
com.iantapply.orchestra.security.Actor
Record Components:
id - stable principal identifier
role - authorization role
public record Actor(String id, Role role) extends Record
Authenticated principal and its assigned role.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Actor(String id, Role role)
    Validates that the actor has a usable identifier.

  • 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.
    void
    require(Permission permission)
    Requires this actor to hold a permission.
    Role
    role()
    Returns the value of the role record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Actor

      public Actor(String id, Role role)
      Validates that the actor has a usable identifier.

  • Method Details

    • require

      public void require(Permission permission)
      Requires this actor to hold a permission.
      Parameters:
      permission - required permission
      Throws:
      SecurityException - when the role does not allow it

    • 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

    • role

      public Role role()
      Returns the value of the role record component.
      Returns:
      the value of the role record component