Record Class PushHttpHandler.AuthUser

java.lang.Object
java.lang.Record
com.iizix.server.push.engine.http.PushHttpHandler.AuthUser
Record Components:
uid - The database user ID, or PushHttpHandler.NO_UID for a caller with none.
userName - The user name.
privileges - The union of the caller's groups' privileges, never null.
Enclosing class:
PushHttpHandler
public static record PushHttpHandler.AuthUser(long uid, String userName, Set<PushPrivilege> privileges) extends Record
An authenticated caller.
Author:
Christopher Mindus

  • Constructor Summary

    Constructors
    Constructor
    Description
    AuthUser(long uid, String userName, Set<PushPrivilege> privileges)
    Canonical constructor: the privileges are copied and made unmodifiable, null is none.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    has(PushPrivilege privilege)
    Tells whether the caller holds a privilege.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isDatabaseUser()
    Tells whether the caller is a database user, the only kind with a uid, and so the only kind that may make a device operation (section 5.0).
    Set<PushPrivilege>
    privileges()
    Returns the value of the privileges record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    uid()
    Returns the value of the uid record component.
    String
    userName()
    Returns the value of the userName record component.

    Methods inherited from class Object

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

  • Constructor Details

    • AuthUser

      public AuthUser(long uid, String userName, Set<PushPrivilege> privileges)
      Canonical constructor: the privileges are copied and made unmodifiable, null is none.

  • Method Details

    • has

      public boolean has(PushPrivilege privilege)
      Tells whether the caller holds a privilege.
      Parameters:
      privilege - The privilege.
      Returns:
      true if one of the caller's groups grants it.

    • isDatabaseUser

      public boolean isDatabaseUser()
      Tells whether the caller is a database user, the only kind with a uid, and so the only kind that may make a device operation (section 5.0).
      Returns:
      true for a database user.

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

    • uid

      public long uid()
      Returns the value of the uid record component.
      Returns:
      the value of the uid record component

    • userName

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

    • privileges

      public Set<PushPrivilege> privileges()
      Returns the value of the privileges record component.
      Returns:
      the value of the privileges record component