org.sakaiproject.provider.authzGroup

Class SampleGroupProvider

java.lang.Object

org.sakaiproject.provider.authzGroup.SampleGroupProvider

All Implemented Interfaces:

GroupProvider

public class SampleGroupProvider
extends Object
implements GroupProvider

Sample of a GroupProvider. Shows how to handle compound ids (connected with a '+').

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

• sakai.access
• sakai.maintain
• sakai.access+sakai.maintain

You should also have a user directory provider that recognizes the users:

• user1
• user
• user3

The SampleUserDirectoryProvider does this.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_courseExternalId The external id for the "course" group.
protected int	m_courseStudents how many students in the "course" group.
protected HashSet<String>	m_usersa A collection of user ids.
protected HashSet<String>	m_usersc
protected HashSet<String>	m_usersm
protected Properties	m_usersx
protected String	m_xFile Configuration: the full file path to the external user grants file (optional).

Constructor Summary

Constructors

Constructor and Description
SampleGroupProvider() Construct.

Method Summary

Modifier and Type	Method and Description
void	destroy() Cleanup before shutting down.
Map<String,String>	getGroupRolesForUser(String userId)
Map	getGroupRolesForUser(String userId, String acadEid)
String	getRole(String id, String user)
Map<String,String>	getUserRolesForGroup(String id)
boolean	groupExists(String arg0)
void	init() Final initialization, once all dependencies are set.
String	packId(String[] ids)
String	preferredRole(String one, String other)
void	setCourseExternalId(String value) Dependency - set the external id for the "course" group.
void	setCourseStudents(String count) Set how many students in the "course" group
void	setXFile(String value) Dependency - set the full file path to the optional external user grants file.
String[]	unpackId(String id)
protected void	update()

Methods inherited from class java.lang.Object

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

Field Detail

m_xFile

protected String m_xFile

Configuration: the full file path to the external user grants file (optional).

m_courseExternalId

protected String m_courseExternalId

The external id for the "course" group.

m_courseStudents

protected int m_courseStudents

how many students in the "course" group.

m_usersa

protected HashSet<String> m_usersa

A collection of user ids.

m_usersm

protected HashSet<String> m_usersm

m_usersx

protected Properties m_usersx

m_usersc

protected HashSet<String> m_usersc

Constructor Detail

SampleGroupProvider

public SampleGroupProvider()

Construct.

Method Detail

setXFile

public void setXFile(String value)

Dependency - set the full file path to the optional external user grants file.

Parameters:

value - The full file path to the external user grants file.

setCourseExternalId

public void setCourseExternalId(String value)

Dependency - set the external id for the "course" group.

Parameters:

value - The external id for the "course" site.

setCourseStudents

public void setCourseStudents(String count)

Set how many students in the "course" group

Parameters:

count - How many students in the "course" group

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)

Specified by:

getUserRolesForGroup in interface GroupProvider

getGroupRolesForUser

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

Specified by:

getGroupRolesForUser in interface GroupProvider

getGroupRolesForUser

public Map getGroupRolesForUser(String userId,
                                String acadEid)

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

preferredRole

public String preferredRole(String one,
                            String other)

Specified by:

preferredRole in interface GroupProvider

update

protected void update()

groupExists

public boolean groupExists(String arg0)

Specified by:

groupExists in interface GroupProvider