Package org.opencastproject.security.api

Interface RoleDirectoryService

public interface RoleDirectoryService
A marker interface for the federation of all RoleProviders.

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<Role>
    findRoles(String query, Role.Target target, int offset, int limit)
    Return the found roles as a list.
    List<Role>
    findRoles(String query, Role.Target target, int offset, int limit, Boolean hasUser)
    Return the found roles as a list, optionally filtered by whether or not each role corresponds to an actual user account.

  • Method Details

    • findRoles

      default List<Role> findRoles(String query, Role.Target target, int offset, int limit)
      Return the found roles as a list.
      Parameters:
      query - the query. Use the wildcards "_" to match any single character and "%" to match an arbitrary number of characters (including zero characters).
      offset - the offset.
      limit - the limit. 0 means no limit
      Returns:
      a list of roles
      Throws:
      IllegalArgumentException - if the query is null

    • findRoles

      List<Role> findRoles(String query, Role.Target target, int offset, int limit, Boolean hasUser)
      Return the found roles as a list, optionally filtered by whether or not each role corresponds to an actual user account.
      Parameters:
      query - the query. Use the wildcards "_" to match any single character and "%" to match an arbitrary number of characters (including zero characters).
      offset - the offset.
      limit - the limit. 0 means no limit
      hasUser - if null, roles are not filtered by this criterion. If true, only roles that resolve to an actual user account are returned. If false, only roles that do not resolve to a user account are returned. The filter, if any, is applied before the offset/limit are applied.
      Returns:
      a list of roles
      Throws:
      IllegalArgumentException - if the query is null