Interface PermissionProvider

All Known Implementing Classes:
HytalePermissionsProvider
public interface PermissionProvider
An interface for anything that can provide permissions.

  • Method Details

    • getName

      @Nonnull String getName()
      Returns:
      the name of the permission provider.

    • addUserPermissions

      void addUserPermissions(@Nonnull UUID uuid, @Nonnull Set<String> permissions)
      Called to add a set of permissions to a user.
      Parameters:
      uuid - The UUID of the user.
      permissions - The set of permissions to add.

    • removeUserPermissions

      void removeUserPermissions(@Nonnull UUID uuid, @Nonnull Set<String> permissions)
      Called to remove a set of permissions from a user.
      Parameters:
      uuid - The UUID of the user.
      permissions - The set of permissions to remove.

    • getUserPermissions

      Set<String> getUserPermissions(@Nonnull UUID uuid)
      Called to get the set of permissions for a user.
      Parameters:
      uuid - The UUID of the user.
      Returns:
      the set of permissions for the user.

    • addGroupPermissions

      void addGroupPermissions(@Nonnull String group, @Nonnull Set<String> permissions)
      Called to add a set of permissions to a group.
      Parameters:
      group - The name of the group.
      permissions - The set of permissions to add.

    • removeGroupPermissions

      void removeGroupPermissions(@Nonnull String group, @Nonnull Set<String> permissions)
      Called to remove a set of permissions from a group.
      Parameters:
      group - The name of the group.
      permissions - The set of permissions to remove.

    • getGroupPermissions

      Set<String> getGroupPermissions(@Nonnull String group)
      Called to get the direct (non-inherited) set of permissions for a group.
      Parameters:
      group - The name of the group.
      Returns:
      the set of permissions for the group.

    • addUserToGroup

      void addUserToGroup(@Nonnull UUID uuid, @Nonnull String group)
      Called to add a user to a group.
      Parameters:
      uuid - The UUID of the user.
      group - The name of the group.

    • removeUserFromGroup

      void removeUserFromGroup(@Nonnull UUID uuid, @Nonnull String group)
      Called to remove a user from a group.
      Parameters:
      uuid - The UUID of the user.
      group - The name of the group.

    • getGroupsForUser

      Set<String> getGroupsForUser(@Nonnull UUID uuid)
      Called to get the set of groups a user is in.
      Parameters:
      uuid - The UUID of the user.
      Returns:
      the set of groups the user is in.

    • setUserGroup

      void setUserGroup(@Nonnull UUID uuid, @Nonnull String group)
      Atomically replaces all groups for a user with the given single group.
      Parameters:
      uuid - The UUID of the user.
      group - The group to set as the user's sole group.

    • getGroupParent

      @Nullable String getGroupParent(@Nonnull String group)
      Parameters:
      group - The name of the group.
      Returns:
      the parent group name, or null if this group has no parent.

    • getAllRegisteredGroups

      @Nonnull Set<String> getAllRegisteredGroups()
      Returns:
      all group names known to this provider.

    • getEffectiveGroupPermissions

      @Nonnull Set<String> getEffectiveGroupPermissions(@Nonnull String group)
      Resolves the full set of permissions for a group, including inherited permissions from the parent chain. Implementations must protect against cycles.
      Parameters:
      group - The name of the group.
      Returns:
      the effective permission set (direct + inherited).

    • getUsersWithPermission

      @Nonnull Set<UUID> getUsersWithPermission(@Nonnull String permission)
      Finds the users that hold the permission as a grant of their own. A user who holds it through a group is not one of them, and neither is a user who holds it through a wildcard.

      This carries no default, because a provider that answers "nobody" when it means "I cannot tell" makes removeUserPermissionFromAll(String) report that it revoked a permission that the user still holds.

      Parameters:
      permission - The permission node.
      Returns:
      the users that were granted the permission.

    • addUserPermissions

      @Nonnull default Set<UUID> addUserPermissions(@Nonnull Collection<UUID> uuids, @Nonnull Set<String> permissions)
      Adds the permissions to every user named. Override this to store the change once rather than once for each user. The default adds them one user at a time, so a failure part way through leaves the users before it changed and reports none of them.
      Parameters:
      uuids - The UUID of each user.
      permissions - The set of permissions to add.
      Returns:
      the users the permissions were added to, which leaves out the users that held them.

    • removeUserPermissionFromAll

      @Nonnull default Set<UUID> removeUserPermissionFromAll(@Nonnull String permission)
      Takes the permission back from every user that holds it as a grant of their own, as one change. A user who holds it through a group keeps it.
      Parameters:
      permission - The permission node.
      Returns:
      the users the permission was taken from.