org.kuali.kra.service

Interface KraAuthorizationService

All Known Implementing Classes:

KraAuthorizationServiceImpl

public interface KraAuthorizationService

The Authorization Service handles access to Documents.

Author:

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

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()
List<RolePersons>	getAllRolePersons(Permissionable permissionable) Get the list of all of the award roles and the persons in those roles for a given Award.
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.
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.

Method Detail

getUserNames

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.

Parameters:

permissionable - the Permissionable

roleName - the name of the Role

Returns:

the list of usernames

addRole

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

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

Parameters:

username - the user's username

roleName - the name of the Role

award - the Award

removeRole

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

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

Parameters:

username - the user's username

roleName - the name of the Role

award - the Award

hasPermission

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

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

Parameters:

username - the user's username

award - the Award

permissionName - the name of the Permission

Returns:

true if the user has permission; otherwise false

hasPermission

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

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

Parameters:

userId -

permissionable -

permissionNamespace -

permissionName -

Returns:

hasRole

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

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

Parameters:

username - the user's username

doc - the Award

roleName - the name of the Role

Returns:

true if the user has the role; otherwise false

getRoles

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

Get the roles for this user in the Award.

Parameters:

username - the user's username

award - the Award

Returns:

the list of role names this person has in the award

getPersonsInRole

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

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

Parameters:

award - the Award

roleName - the name of the role

Returns:

the list of persons in the role for the award

getAllRolePersons

List<RolePersons> getAllRolePersons(Permissionable permissionable)

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

Parameters:

award - the Award

Returns:

the list of all roles and the people in those roles

hasRole

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

forceFlushRoleCaches

void forceFlushRoleCaches()