org.sakaiproject.provider.authzGroup

Class AllHandsGroupProvider

java.lang.Object

org.sakaiproject.provider.authzGroup.AllHandsGroupProvider

All Implemented Interfaces:

GroupProvider

public class AllHandsGroupProvider
extends Object
implements GroupProvider

AllHands GroupProvider allows the creation of provided authzGroups that automatically include all users.

To use, set an authzGroup's external id to one of the following:

• sakai.allhands

Constructor Summary

Constructors

Constructor and Description
AllHandsGroupProvider() Construct.

Method Summary

Modifier and Type	Method and Description
void	destroy() Cleanup before shutting down.
Map<String,String>	getGroupRolesForUser(String userId) If you can do some type of directory lookup to find out some Attribute of this user you could conditionally auto-add them to any number of these "virtual groups" You might try sakai.students, sakai.faculty, sakai.staff, sakai.teamleads There is nothing specific about the string "sakai."
Map	getGroupRolesForUser(String userId, String academicSessionEid)
String	getRole(String id, String user)
Map<String,String>	getUserRolesForGroup(String id) This is not necessary - because the user has already been added because they are enrolled in the allhand.s
boolean	groupExists(String arg0)
void	init() Final initialization, once all dependencies are set.
String	packId(String[] ids)
String	preferredRole(String one, String other)
String[]	unpackId(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

AllHandsGroupProvider

public AllHandsGroupProvider()

Construct.

Method Detail

init

public void init()

Final initialization, once all dependencies are set.

destroy

public void destroy()

Cleanup before shutting down.

getRole

public String getRole(String id,
                      String user)

Specified by:

getRole in interface GroupProvider

getUserRolesForGroup

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

This is not necessary - because the user has already been added because they are enrolled in the allhand.s

Specified by:

getUserRolesForGroup in interface GroupProvider

getGroupRolesForUser

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

If you can do some type of directory lookup to find out some Attribute of this user you could conditionally auto-add them to any number of these "virtual groups" You might try sakai.students, sakai.faculty, sakai.staff, sakai.teamleads There is nothing specific about the string "sakai." these could easily be something like course.eecs280, shib:yale.edu:faculty, or h23.groups.ruk.dk One caveat - this class is respnsbile for handling the unpacking when an admin wants to put in multiple external providers The code below uses the common convention of using "+" (homage to "or") to concatenate IDs. So the user above us could set the provider ID in the Sakai Realms Tool to be h23.groups.ruk.dk+course.eecs280 to indicate thatr membership in either group is OK. To indicate membership in multiple groups in *this routine* add additional entries in the hash map (i.e. do not use the + notation in this routine).

Specified by:

getGroupRolesForUser in interface GroupProvider

getGroupRolesForUser

public Map getGroupRolesForUser(String userId,
                                String academicSessionEid)

Specified by:

getGroupRolesForUser in interface GroupProvider

unpackId

public String[] unpackId(String id)

Specified by:

unpackId in interface GroupProvider

packId

public String packId(String[] ids)

Specified by:

packId in interface GroupProvider

preferredRole

public String preferredRole(String one,
                            String other)

Specified by:

preferredRole in interface GroupProvider

groupExists

public boolean groupExists(String arg0)

Specified by:

groupExists in interface GroupProvider