org.assistments.service.manager.core

Interface RolesManager

All Known Implementing Classes:

RolesManagerImpl

public interface RolesManager

The RolesManager allows an application to define application-specific roles and to assign roles to the application's users.

All applications automatically inherit the following default roles:

• GlobalRoleType.PARTNER_ADMIN
• GlobalRoleType.GUARDIAN
• GlobalRoleType.RESEARCHER
• GlobalRoleType.STUDENT
• GlobalRoleType.TEACHER

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RolesManager.GrantedAuthorityDisplayComparator
static class	RolesManager.GrantedAuthorityNameComparator
static class	RolesManager.GrantedAuthorityNoCamparator
static class	RolesManager.SortRolesByType

Field Summary

Fields

Modifier and Type	Field and Description
static GrantedAuthority	USER Any user with at least one role is, well, a USER.

Method Summary

Modifier and Type	Method and Description
void	addGlobalRoleType(GrantedAuthority ga) Creates a new global role available to all partners.
void	addRoleType(java.lang.String roleName, java.lang.String displayName) Creates a new role for the current partner.
void	addUserRole(XInfo userXinfo, GrantedAuthority roleToAdd) For the current partner, assign a role to a user.
int	deleteRoleType(GrantedAuthority roleToDelete) Deletes a role for the current partner.
java.util.Set<XInfo>	getRoleHolders(GrantedAuthority role) For the current partner, returns the set of users that hold a specified role.
java.util.Set<GrantedAuthority>	getRoleTypes(RolesManager.SortRolesByType sortType, GrantedAuthority.RoleScope scope) Returns the set of roles for the current partner
java.util.Set<GrantedAuthority>	getRoleTypes(java.lang.String partnerRef, RolesManager.SortRolesByType sortType, GrantedAuthority.RoleScope scope) Returns the set of all roles for the specified partner.
java.util.Set<XInfo>	getUnconnectedRoleHolders(GrantedAuthority role) Returns the set of users, across all partners, that hold a specified role
java.util.Set<GrantedAuthority>	getUserRoles(XInfo userXinfo, RolesManager.SortRolesByType sortType) For the current partner, returns the set of roles assigned to a user.
boolean	hasRole(XInfo userXinfo, GrantedAuthority role) Returns whether a user holds a particular role.
void	removeUserRole(XInfo userXinfo, GrantedAuthority roleToRemove) For the current partner, removes a role from a user.

Field Detail

USER

static final GrantedAuthority USER

Any user with at least one role is, well, a USER.

Method Detail

addRoleType

void addRoleType(java.lang.String roleName,
                 java.lang.String displayName)
          throws AlreadyExistsException

Creates a new role for the current partner.

Parameters:

roleName - Role, by name, to add

displayName - Role's display name

Throws:

AlreadyExistsException - If the named role already exists

addGlobalRoleType

void addGlobalRoleType(GrantedAuthority ga)

Creates a new global role available to all partners.

Note: For use only by Service Administrators. For their application, partners call deleteRoleType(GrantedAuthority).

Parameters:

ga - Role to add

deleteRoleType

int deleteRoleType(GrantedAuthority roleToDelete)
            throws NotFoundException

Deletes a role for the current partner.

Parameters:

roleToDelete - Role to delete, by name.

Returns:

The number of users that had the now deleted role

Throws:

NotFoundException - The specified role was not found

getRoleTypes

java.util.Set<GrantedAuthority> getRoleTypes(java.lang.String partnerRef,
                                             RolesManager.SortRolesByType sortType,
                                             GrantedAuthority.RoleScope scope)
                                      throws NotFoundException

Returns the set of all roles for the specified partner.

Note: For use only by Service Administrators. For their application, partners call #getRoleTypes(SortRolesByType, RoleScope)

Parameters:

partnerRef - The partner's external reference

sortType - Specifies how to order the returned roles

scope - Specifies which roles to return based on who defined them

Returns:

List of all role types for the specified partner

Throws:

NotFoundException - The specified partner or role was not found

getRoleTypes

java.util.Set<GrantedAuthority> getRoleTypes(RolesManager.SortRolesByType sortType,
                                             GrantedAuthority.RoleScope scope)

Returns the set of roles for the current partner

Parameters:

sortType - Specifies how to order the returned roles

scope - Specifies which roles to return based on who defined them

Returns:

The set of sorted roles.

getUserRoles

java.util.Set<GrantedAuthority> getUserRoles(XInfo userXinfo,
                                             RolesManager.SortRolesByType sortType)
                                      throws NotFoundException

For the current partner, returns the set of roles assigned to a user.

Parameters:

userXinfo - A user's external identifier information

sortType - How to sort the returned roles.

Returns:

The sorted roles for the specified user.

Throws:

NotFoundException - If the user was not found.

addUserRole

void addUserRole(XInfo userXinfo,
                 GrantedAuthority roleToAdd)
          throws NotFoundException

For the current partner, assign a role to a user.

Note: For use only by Service Administrators. For their application, partners call removeUserRole(XInfo, GrantedAuthority).

Parameters:

userXinfo - A user's external identifier information

roleToAdd - The role to add

Throws:

NotFoundException - If the user was not found.

removeUserRole

void removeUserRole(XInfo userXinfo,
                    GrantedAuthority roleToRemove)
             throws NotFoundException

For the current partner, removes a role from a user.

Parameters:

userXinfo - A user's external identifier information

roleToRemove - The role to remove

Throws:

NotFoundException - When the user

hasRole

boolean hasRole(XInfo userXinfo,
                GrantedAuthority role)
         throws NotFoundException

Returns whether a user holds a particular role.

Parameters:

userXinfo - A user's external identifier information

role - Role to check

Returns:

true if the user has that role; otherwise false

Throws:

NotFoundException - If the user was not found.

getRoleHolders

java.util.Set<XInfo> getRoleHolders(GrantedAuthority role)

For the current partner, returns the set of users that hold a specified role.

Parameters:

role - Role to check

Returns:

the xinfo (XPair) for each user granted role

getUnconnectedRoleHolders

java.util.Set<XInfo> getUnconnectedRoleHolders(GrantedAuthority role)

Returns the set of users, across all partners, that hold a specified role

Parameters:

role - Role to check

Returns:

the xinfo (XPair) for each user granted role