org.pentaho.platform.api.engine
Interface IUserRoleListService

All Known Implementing Classes:
DefaultLdapUserRoleListService, InMemoryUserRoleListService, JdbcUserRoleListService, UserRoleDaoUserRoleListService

public interface IUserRoleListService


Method Summary
 GrantedAuthority[] getAllAuthorities()
          Returns all authorities known to the provider.
 String[] getAllUsernames()
          Returns all user names known to the provider.
 GrantedAuthority[] getAuthoritiesForUser(String username)
          Returns all authorities granted for a specified user.
 String[] getUsernamesInRole(GrantedAuthority authority)
          Returns all known users in the specified role.
 

Method Detail

getAllAuthorities

GrantedAuthority[] getAllAuthorities()
Returns all authorities known to the provider. Cannot return null

Returns:
the authorities (never null)

getAllUsernames

String[] getAllUsernames()
Returns all user names known to the provider. Cannot return null

Returns:
the users (never null)

getUsernamesInRole

String[] getUsernamesInRole(GrantedAuthority authority)
Returns all known users in the specified role. Cannot return null

Parameters:
authority - The authority to look users up by. Cannot be null
Returns:
the users. (never null)

getAuthoritiesForUser

GrantedAuthority[] getAuthoritiesForUser(String username)
Returns all authorities granted for a specified user.

Parameters:
username - The name of the user to look up authorities for
Returns:
the authorities. (Never null)