org.assistments.service.manager.core.impl

Class RolesManagerImpl

java.lang.Object

org.assistments.service.manager.core.impl.RolesManagerImpl

All Implemented Interfaces:

RolesManager

@Component
public class RolesManagerImpl
extends java.lang.Object
implements RolesManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.assistments.service.manager.core.RolesManager

RolesManager.GrantedAuthorityDisplayComparator, RolesManager.GrantedAuthorityNameComparator, RolesManager.GrantedAuthorityNoCamparator, RolesManager.SortRolesByType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	classType

Fields inherited from interface org.assistments.service.manager.core.RolesManager

USER

Constructor Summary

Constructors

Constructor and Description
RolesManagerImpl()

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.

Methods inherited from class java.lang.Object

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

Field Detail

classType

public static final java.lang.String classType

Constructor Detail

RolesManagerImpl

public RolesManagerImpl()

Method Detail

addRoleType

public void addRoleType(java.lang.String roleName,
                        java.lang.String displayName)

Description copied from interface: RolesManager

Creates a new role for the current partner.

Specified by:

addRoleType in interface RolesManager

Parameters:

roleName - Role, by name, to add

displayName - Role's display name

addGlobalRoleType

public void addGlobalRoleType(GrantedAuthority ga)

Description copied from interface: RolesManager

Creates a new global role available to all partners.

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

Specified by:

addGlobalRoleType in interface RolesManager

Parameters:

ga - Role to add

deleteRoleType

@Transactional
public int deleteRoleType(GrantedAuthority roleToDelete)
                                   throws NotFoundException

Description copied from interface: RolesManager

Deletes a role for the current partner.

Specified by:

deleteRoleType in interface RolesManager

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

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

Description copied from interface: RolesManager

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)

Specified by:

getRoleTypes in interface RolesManager

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

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

Description copied from interface: RolesManager

Returns the set of roles for the current partner

Specified by:

getRoleTypes in interface RolesManager

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

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

Description copied from interface: RolesManager

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

Specified by:

getUserRoles in interface RolesManager

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

public void addUserRole(XInfo userXinfo,
                        GrantedAuthority roleToAdd)
                 throws NotFoundException

Description copied from interface: RolesManager

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

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

Specified by:

addUserRole in interface RolesManager

Parameters:

userXinfo - A user's external identifier information

roleToAdd - The role to add

Throws:

NotFoundException - If the user was not found.

removeUserRole

public void removeUserRole(XInfo userXinfo,
                           GrantedAuthority roleToRemove)
                    throws NotFoundException

Description copied from interface: RolesManager

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

Specified by:

removeUserRole in interface RolesManager

Parameters:

userXinfo - A user's external identifier information

roleToRemove - The role to remove

Throws:

NotFoundException - When the user

hasRole

public boolean hasRole(XInfo userXinfo,
                       GrantedAuthority role)
                throws NotFoundException

Description copied from interface: RolesManager

Returns whether a user holds a particular role.

Specified by:

hasRole in interface RolesManager

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

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

Description copied from interface: RolesManager

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

Specified by:

getRoleHolders in interface RolesManager

Parameters:

role - Role to check

Returns:

the xinfo (XPair) for each user granted role

getUnconnectedRoleHolders

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

Description copied from interface: RolesManager

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

Specified by:

getUnconnectedRoleHolders in interface RolesManager

Parameters:

role - Role to check

Returns:

the xinfo (XPair) for each user granted role