org.opencastproject.security.api

Interface RoleProvider

public interface RoleProvider

Mix-in interface for directories that can list roles.

Method Summary

Modifier and Type	Method and Description
Iterator<Role>	findRoles(String query, Role.Target target, int offset, int limit) Return the found roles as an iterator.
String	getOrganization() Returns the identifier for the organization that is defining this set of roles.
List<Role>	getRolesForUser(String userName) Returns the roles for this user or an empty array if no roles are applicable.

Method Detail

getRolesForUser

List<Role> getRolesForUser(String userName)

Returns the roles for this user or an empty array if no roles are applicable.

Parameters:

userName - the user id

Returns:

the set of roles

getOrganization

String getOrganization()

Returns the identifier for the organization that is defining this set of roles.

Returns:

the defining organization

findRoles

Iterator<Role> findRoles(String query,
                         Role.Target target,
                         int offset,
                         int limit)

Return the found roles as an iterator.

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:

an iterator of role's

Throws:

IllegalArgumentException - if the query is null