Record Class SecuredVisibility.Requirement

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.components.SecuredVisibility.Requirement
Record Components:
requiredRoles - roles that must all be present; empty means "no role constraint"
requiredPermissions - permissions that must all be present; empty means "no permission constraint"
Enclosing class:
SecuredVisibility
public static record SecuredVisibility.Requirement(Set<com.svenruppert.jsentinel.authorization.api.roles.RoleName> requiredRoles, Set<com.svenruppert.jsentinel.authorization.api.permissions.PermissionName> requiredPermissions) extends Record
What a secured component requires to be enabled / visible.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Requirement(Set<com.svenruppert.jsentinel.authorization.api.roles.RoleName> requiredRoles, Set<com.svenruppert.jsentinel.authorization.api.permissions.PermissionName> requiredPermissions)
    Validates the components — null becomes empty, sets are defensively copied.

  • 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.
    boolean
    isEmpty()
     
    static SecuredVisibility.Requirement
    permission(com.svenruppert.jsentinel.authorization.api.permissions.PermissionName permission)
    Single-permission convenience.
    Set<com.svenruppert.jsentinel.authorization.api.permissions.PermissionName>
    requiredPermissions()
    Returns the value of the requiredPermissions record component.
    Set<com.svenruppert.jsentinel.authorization.api.roles.RoleName>
    requiredRoles()
    Returns the value of the requiredRoles record component.
    static SecuredVisibility.Requirement
    role(com.svenruppert.jsentinel.authorization.api.roles.RoleName role)
    Single-role convenience.
    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

    • Requirement

      public Requirement(Set<com.svenruppert.jsentinel.authorization.api.roles.RoleName> requiredRoles, Set<com.svenruppert.jsentinel.authorization.api.permissions.PermissionName> requiredPermissions)
      Validates the components — null becomes empty, sets are defensively copied.

  • Method Details

    • role

      public static SecuredVisibility.Requirement role(com.svenruppert.jsentinel.authorization.api.roles.RoleName role)
      Single-role convenience.

    • permission

      public static SecuredVisibility.Requirement permission(com.svenruppert.jsentinel.authorization.api.permissions.PermissionName permission)
      Single-permission convenience.

    • isEmpty

      public boolean isEmpty()
      Returns:
      true when the requirement carries no constraints

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

    • requiredRoles

      public Set<com.svenruppert.jsentinel.authorization.api.roles.RoleName> requiredRoles()
      Returns the value of the requiredRoles record component.
      Returns:
      the value of the requiredRoles record component

    • requiredPermissions

      public Set<com.svenruppert.jsentinel.authorization.api.permissions.PermissionName> requiredPermissions()
      Returns the value of the requiredPermissions record component.
      Returns:
      the value of the requiredPermissions record component