org.pentaho.platform.api.engine

Interface IUserRoleListService

public interface IUserRoleListService

Method Summary

Modifier and Type	Method and Description
List<String>	getAllRoles() Returns all authorities known to the provider.
List<String>	getAllRoles(ITenant tenant) Returns all authorities known to the provider for a given tenant.
List<String>	getAllUsers() Returns all user names known to the provider.
List<String>	getAllUsers(ITenant tenant) Returns all user names known to the provider for a given tenant.
List<String>	getRolesForUser(ITenant tenant, String username) Returns all authorities granted for a specified user.
List<String>	getSystemRoles() Returns all system authorities known to the provider.
List<String>	getUsersInRole(ITenant tenant, String role) Returns all known users in the specified role.

Method Detail

getAllRoles

List<String> getAllRoles()

Returns all authorities known to the provider. Cannot return null.

Returns:

Returns the authorities. Cannot return null.

getSystemRoles

List<String> getSystemRoles()

Returns all system authorities known to the provider. Cannot return null.

Returns:

Returns the authorities. Cannot return null.

getAllRoles

List<String> getAllRoles(ITenant tenant)

Returns all authorities known to the provider for a given tenant. Cannot return null.

Parameters:

tenant - To be used for searching authorities.

Returns:

Returns the authorities. Cannot return null.

getAllUsers

List<String> getAllUsers()

Returns all user names known to the provider. Cannot return null.

Returns:

Returns the users. Cannot return null.

getAllUsers

List<String> getAllUsers(ITenant tenant)

Returns all user names known to the provider for a given tenant. Cannot return null.

Parameters:

tenant - Tenant to be used for searching users.

Returns:

Returns the users. Cannot return null.

getUsersInRole

List<String> getUsersInRole(ITenant tenant,
                            String role)

Returns all known users in the specified role. Cannot return null.

Parameters:

tenant - Tenant information.

authority - Indicates the authority to look users up by. Cannot be null.

Returns:

Returns the users with the specified roles in scope of the specified tenant. Cannot return null.

getRolesForUser

List<String> getRolesForUser(ITenant tenant,
                             String username)

Returns all authorities granted for a specified user.

Parameters:

tenant - Tenant information.

username - Indicates the name of the user to look up authorities for.

Returns:

Returns the authorities of the user. Cannot return null.