| org.sakaiproject.authz.api.GroupProvider
All known Subclasses: org.sakaiproject.provider.authzGroup.AllHandsGroupProvider, org.sakaiproject.coursemanagement.impl.provider.CourseManagementGroupProvider, org.sakaiproject.provider.authzGroup.SampleGroupProvider,
| GroupProvider | | public interface GroupProvider (Code) | |
GroupProvider provides user / role membership in a group, from an external system.
|
| Method Summary | |
| Map | getGroupRolesForUser(String userId)
Access the external group id - role name map for this user in all external groups.
Parameters:
userId - The user id. | | String | getRole(String id, String user)
Access the role name for this particular user in the external group.
Parameters:
id - The external group id.
Parameters:
userId - The user Id. | | Map | getUserRolesForGroup(String id)
Access the user id - role name map for all users in the external group.
Parameters:
id - The external group id. | | public String | packId(String[] ids)
Packs any number of simple ids into a compound id. | | String | preferredRole(String one, String other)
Return one or the other of these role names - pick the one that if a user has both, is the more powerful one to give the user as their single role.
Parameters:
one - A role name. | | String[] | unpackId(String id)
Unpack a possibly compound id into it's component ids, returning at least the id unchanged if not compound.
Parameters:
id - The external realm id. |
| getGroupRolesForUser | | Map getGroupRolesForUser(String userId)(Code) | | Access the external group id - role name map for this user in all external groups.
Parameters:
userId - The user id. the the external group id - role name map for this users in all external groups. (may be empty). |
| getRole | | String getRole(String id, String user)(Code) | | Access the role name for this particular user in the external group.
Parameters:
id - The external group id.
Parameters:
userId - The user Id. the role name for this particular user in the external group, or null if none. |
| getUserRolesForGroup | | Map getUserRolesForGroup(String id)(Code) | | Access the user id - role name map for all users in the external group.
Parameters:
id - The external group id. the user id - role name map for all users in the external group (may be empty). |
| packId | | public String packId(String[] ids)(Code) | | Packs any number of simple ids into a compound id.
Parameters:
ids - The external group ids a compound id |
| preferredRole | | String preferredRole(String one, String other)(Code) | | Return one or the other of these role names - pick the one that if a user has both, is the more powerful one to give the user as their single role.
Parameters:
one - A role name. May be null!
Parameters:
other - Another role name. May be null! The better role. |
| unpackId | | String[] unpackId(String id)(Code) | | Unpack a possibly compound id into it's component ids, returning at least the id unchanged if not compound.
Parameters:
id - The external realm id. a String array of one or more ids upacked from this possibly compound id. |
|
|