org.sakaiproject.coursemanagement.impl.provider

Class CourseManagementGroupProvider

java.lang.Object

org.sakaiproject.coursemanagement.impl.provider.CourseManagementGroupProvider

All Implemented Interfaces:

GroupProvider

public class CourseManagementGroupProvider
extends Object
implements GroupProvider

A Sakai GroupProvider that utilizes the CourseManagementService and the CmMappingService to supply authz data to Sakai. This implementation uses a list of RoleResolvers, which can be used to resolve a user's role in a section based on memberships in parent objects such as CourseSets.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EID_SEPARATOR
static Pattern	EID_SEPARATOR_PATTERN
static String	QUOTED_SEPARATOR
static String	SITE_ROLE_RESOLUTION_ORDER

Constructor Summary

Constructors

Constructor and Description
CourseManagementGroupProvider()

Method Summary

Modifier and Type	Method and Description
void	destroy()
Map<String,String>	getGroupRolesForUser(String userEid) Provides a map of Course Section EIDs (which can be used as AuthzGroup provider IDs) to Sakai roles for a given user.
String	getRole(String id, String user) This method is not longer in use in Sakai.
Map<String,String>	getUserRolesForGroup(String id) Provides a Map of user IDs to (Sakai) roles for the Course Section EIDs specified in the input AuthzGroup provider string.
boolean	groupExists(String groupId)
void	init()
String	packId(String[] ids)
String	preferredRole(String one, String other)
void	setCmService(CourseManagementService cmService)
void	setConfiguration(Map<String,Object> configuration)
void	setRolePreferences(List<String> rolePreferences)
void	setRoleResolvers(List<RoleResolver> roleResolvers)
String[]	unpackId(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SITE_ROLE_RESOLUTION_ORDER

public static final String SITE_ROLE_RESOLUTION_ORDER

See Also:

Constant Field Values

EID_SEPARATOR

public static String EID_SEPARATOR

QUOTED_SEPARATOR

public static String QUOTED_SEPARATOR

EID_SEPARATOR_PATTERN

public static Pattern EID_SEPARATOR_PATTERN

Constructor Detail

CourseManagementGroupProvider

public CourseManagementGroupProvider()

Method Detail

getRole

public String getRole(String id,
                      String user)

This method is not longer in use in Sakai. It should be removed from the GroupProvider interface.

Specified by:

getRole in interface GroupProvider

getUserRolesForGroup

public Map<String,String> getUserRolesForGroup(String id)

Provides a Map of user IDs to (Sakai) roles for the Course Section EIDs specified in the input AuthzGroup provider string.

Specified by:

getUserRolesForGroup in interface GroupProvider

getGroupRolesForUser

public Map<String,String> getGroupRolesForUser(String userEid)

Provides a map of Course Section EIDs (which can be used as AuthzGroup provider IDs) to Sakai roles for a given user.

Specified by:

getGroupRolesForUser in interface GroupProvider

packId

public String packId(String[] ids)

Specified by:

packId in interface GroupProvider

unpackId

public String[] unpackId(String id)

Specified by:

unpackId in interface GroupProvider

init

public void init()

destroy

public void destroy()

setCmService

public void setCmService(CourseManagementService cmService)

setRoleResolvers

public void setRoleResolvers(List<RoleResolver> roleResolvers)

preferredRole

public String preferredRole(String one,
                            String other)

Specified by:

preferredRole in interface GroupProvider

setRolePreferences

public void setRolePreferences(List<String> rolePreferences)

setConfiguration

public void setConfiguration(Map<String,Object> configuration)

groupExists

public boolean groupExists(String groupId)

Specified by:

groupExists in interface GroupProvider