org.kuali.kra.service.impl

Class KraAuthorizationServiceImpl

java.lang.Object

org.kuali.kra.service.impl.KraAuthorizationServiceImpl

All Implemented Interfaces:

KraAuthorizationService

public class KraAuthorizationServiceImpl
extends Object
implements KraAuthorizationService

The Kra Authorization Service Implementation.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Constructor Summary

Constructors

Constructor and Description
KraAuthorizationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRole(String userId, String roleName, Permissionable permissionable) Add a user to a role within an Award.
void	forceFlushRoleCaches() FIXME: Rice Hack - this method needs to be called because after we update kim data the cache handling is done asynchronously and subsequent reads are likely to be reading from a dirty cache.
List<RolePersons>	getAllRolePersons(Permissionable permissionable) Get the list of all of the award roles and the persons in those roles for a given Award.
org.kuali.rice.kim.api.identity.IdentityService	getIdentityService()
List<KcPerson>	getPersonsInRole(Permissionable permissionable, String roleName) Get the list of persons in a specific role for a given award.
List<String>	getRoles(String userId, Permissionable permissionable) Get the roles for this user in the Award.
org.kuali.rice.kim.api.role.RoleService	getRoleService()
List<String>	getUserNames(Permissionable permissionable, String roleName) Get the list of usernames of people who have the given role with respect to the given Permissionable.
boolean	hasPermission(String userId, Permissionable permissionable, String permissionName) Does the user have the given permission for the given Award?
boolean	hasPermission(String userId, Permissionable permissionable, String permissionNamespace, String permissionName) Does the user have the given permission in the given namespace?
boolean	hasRole(String userId, Permissionable permissionable, String roleName) Does the user have the given role for the given Award?
boolean	hasRole(String userId, String namespace, String roleName)
void	removeRole(String userId, String roleName, Permissionable permissionable) Remove a user from a role within a Award.
void	setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagementService)
void	setKcPersonService(KcPersonService personService) Set the KRA Person Service.
void	setPermissionService(org.kuali.rice.kim.api.permission.PermissionService permissionService)
void	setRoleManagementService(org.kuali.rice.kim.api.role.RoleService roleManagementService)
void	setUnitAuthorizationService(UnitAuthorizationService unitAuthorizationService) Set the Unit Authorization Service.

Methods inherited from class java.lang.Object

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

Constructor Detail

KraAuthorizationServiceImpl

public KraAuthorizationServiceImpl()

Method Detail

setUnitAuthorizationService

public void setUnitAuthorizationService(UnitAuthorizationService unitAuthorizationService)

Set the Unit Authorization Service. Injected by Spring.

Parameters:

unitAuthorizationService - the Unit Authorization Service

setKcPersonService

public void setKcPersonService(KcPersonService personService)

Set the KRA Person Service. Injected by Spring.

Parameters:

personService - the KRA Person Service

setRoleManagementService

public void setRoleManagementService(org.kuali.rice.kim.api.role.RoleService roleManagementService)

setIdentityManagementService

public void setIdentityManagementService(org.kuali.rice.kim.api.identity.IdentityService identityManagementService)

setPermissionService

public void setPermissionService(org.kuali.rice.kim.api.permission.PermissionService permissionService)

getUserNames

public List<String> getUserNames(Permissionable permissionable,
                        String roleName)

Description copied from interface: KraAuthorizationService

Get the list of usernames of people who have the given role with respect to the given Permissionable.

Specified by:

getUserNames in interface KraAuthorizationService

Parameters:

permissionable - the Permissionable

roleName - the name of the Role

Returns:

the list of usernames

See Also:

org.kuali.kra.award.service.KraAuthorizationService#getUserNames(org.kuali.kra.common.permissions.Permissionable, java.lang.String)

addRole

public void addRole(String userId,
           String roleName,
           Permissionable permissionable)

Description copied from interface: KraAuthorizationService

Add a user to a role within an Award. Standard roles for Award are Aggregator and Viewer.

Specified by:

addRole in interface KraAuthorizationService

roleName - the name of the Role

See Also:

org.kuali.kra.award.service.KraAuthorizationService#addRole(java.lang.String, java.lang.String, org.kuali.kra.common.permissions.Permissionable)

removeRole

public void removeRole(String userId,
              String roleName,
              Permissionable permissionable)

Description copied from interface: KraAuthorizationService

Remove a user from a role within a Award. Standard roles for Awards are Aggregator and Viewer.

Specified by:

removeRole in interface KraAuthorizationService

roleName - the name of the Role

See Also:

org.kuali.kra.award.service.KraAuthorizationService#removeRole(java.lang.String, java.lang.String, org.kuali.kra.common.permissions.Permissionable)

hasPermission

public boolean hasPermission(String userId,
                    Permissionable permissionable,
                    String permissionName)

Description copied from interface: KraAuthorizationService

Does the user have the given permission for the given Award?

Specified by:

hasPermission in interface KraAuthorizationService

permissionName - the name of the Permission

Returns:

true if the user has permission; otherwise false

See Also:

org.kuali.kra.award.service.KraAuthorizationService#hasPermission(java.lang.String, org.kuali.kra.common.permissions.Permissionable, java.lang.String)

hasPermission

public boolean hasPermission(String userId,
                    Permissionable permissionable,
                    String permissionNamespace,
                    String permissionName)

Description copied from interface: KraAuthorizationService

Does the user have the given permission in the given namespace?

Specified by:

hasPermission in interface KraAuthorizationService

Returns:

See Also:

org.kuali.kra.award.service.KraAuthorizationService#hasPermission(java.lang.String, org.kuali.kra.common.permissions.Permissionable, java.lang.String)

hasRole

public boolean hasRole(String userId,
              Permissionable permissionable,
              String roleName)

Description copied from interface: KraAuthorizationService

Does the user have the given role for the given Award?

Specified by:

hasRole in interface KraAuthorizationService

roleName - the name of the Role

Returns:

true if the user has the role; otherwise false

See Also:

org.kuali.kra.award.service.KraAuthorizationService#hasRole(java.lang.String, org.kuali.kra.common.permissions.Permissionable, java.lang.String)

getRoles

public List<String> getRoles(String userId,
                    Permissionable permissionable)

Description copied from interface: KraAuthorizationService

Get the roles for this user in the Award.

Specified by:

getRoles in interface KraAuthorizationService

Returns:

the list of role names this person has in the award

See Also:

org.kuali.kra.award.service.KraAuthorizationService#getRoles(java.lang.String, org.kuali.kra.common.permissions.Permissionable)

getPersonsInRole

public List<KcPerson> getPersonsInRole(Permissionable permissionable,
                              String roleName)

Description copied from interface: KraAuthorizationService

Get the list of persons in a specific role for a given award.

Specified by:

getPersonsInRole in interface KraAuthorizationService

roleName - the name of the role

Returns:

the list of persons in the role for the award

See Also:

org.kuali.kra.award.service.KraAuthorizationService#getPersonsInRole(org.kuali.kra.common.permissions.Permissionable, java.lang.String)

getAllRolePersons

public List<RolePersons> getAllRolePersons(Permissionable permissionable)

Description copied from interface: KraAuthorizationService

Get the list of all of the award roles and the persons in those roles for a given Award.

Specified by:

getAllRolePersons in interface KraAuthorizationService

Returns:

the list of all roles and the people in those roles

See Also:

org.kuali.kra.award.service.KraAuthorizationService#getAllRolePersons(org.kuali.kra.common.permissions.Permissionable)

hasRole

public boolean hasRole(String userId,
              String namespace,
              String roleName)

Specified by:

hasRole in interface KraAuthorizationService

forceFlushRoleCaches

public void forceFlushRoleCaches()

FIXME: Rice Hack - this method needs to be called because after we update kim data the cache handling is done asynchronously and subsequent reads are likely to be reading from a dirty cache.

Specified by:

forceFlushRoleCaches in interface KraAuthorizationService

getRoleService

public org.kuali.rice.kim.api.role.RoleService getRoleService()

getIdentityService

public org.kuali.rice.kim.api.identity.IdentityService getIdentityService()