Package org.opencastproject.userdirectory.api

Interface GroupRoleProvider

All Superinterfaces:

GroupProvider, RoleProvider

All Known Implementing Classes:

JpaGroupRoleProvider

public interface GroupRoleProvider
extends GroupProvider, RoleProvider

Method Summary

Modifier and Type	Method	Description
void	addGroup(JpaGroup group)	Adds or updates a group to the persistence.
Iterator<Group>	getGroups()	Getting all groups
String	getOrganization()	Returns the identifier for the organization that is defining this set of roles.
List<Role>	getRolesForGroup(String groupName)	Returns the roles for this group or an empty array if no roles are applicable.
List<Role>	getRolesForUser(String userName)	Returns the roles for this user or an empty array if no roles are applicable.
void	updateGroup(String groupId, String name, String description, String roles, String users)	Update a group
void	updateGroupMembershipFromRoles(String userName, String orgId, List<String> roleList)	Updates a user's group membership

Methods inherited from interface org.opencastproject.security.api.RoleProvider

findRoles

Method Details

getRolesForUser

List<Role> getRolesForUser(String userName)

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

Specified by:

getRolesForUser in interface RoleProvider

Parameters:

userName - the user id

Returns:

the set of roles

See Also:

• RoleProvider.getRolesForUser(String)

getRolesForGroup

List<Role> getRolesForGroup(String groupName)

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

Specified by:

getRolesForGroup in interface GroupProvider

Parameters:

groupName - the group id

Returns:

the set of roles

See Also:

• RoleProvider.getRolesForUser(String)

getOrganization

String getOrganization()

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

Specified by:

getOrganization in interface RoleProvider

Returns:

the defining organization

See Also:

• RoleProvider.getOrganization()

updateGroupMembershipFromRoles

void updateGroupMembershipFromRoles(String userName,
 String orgId,
 List<String> roleList)

Updates a user's group membership

Parameters:

userName - the username

orgId - the user's organization

roleList - the list of group role names

addGroup

void addGroup(JpaGroup group)
       throws UnauthorizedException

Adds or updates a group to the persistence.

Parameters:

group - the group to add

Throws:

UnauthorizedException

getGroups

Iterator<Group> getGroups()

Getting all groups

Returns:

Iterator<Group> persisted groups

updateGroup

void updateGroup(String groupId,
 String name,
 String description,
 String roles,
 String users)
          throws NotFoundException,
UnauthorizedException

Update a group

Parameters:

groupId - the id of the group to update

name - the name to update

description - the description to update

roles - the roles to update

users - the users to update

Throws:

NotFoundException - if the group is not found

UnauthorizedException - if the user does not have rights to update the group