org.springframework.security.userdetails.hierarchicalroles
Interface RoleHierarchy

All Known Implementing Classes:

RoleHierarchyImpl

public interface RoleHierarchy

The simple interface of a role hierarchy.

Author:

Michael Mayr

Method Summary

GrantedAuthority[]

getReachableGrantedAuthorities(GrantedAuthority[] authorities) This method returns an array of all reachable authorities. Reachable authorities are the directly assigned authorities plus all authorities that are (transitively) reachable from them in the role hierarchy. Example: Role hierarchy: ROLE_A > ROLE_B and ROLE_B > ROLE_C. Directly assigned authority: ROLE_A. Reachable authorities: ROLE_A, ROLE_B, ROLE_C.

Method Detail

getReachableGrantedAuthorities

GrantedAuthority[] getReachableGrantedAuthorities(GrantedAuthority[] authorities)

This method returns an array of all reachable authorities.
Reachable authorities are the directly assigned authorities plus all authorities that are (transitively) reachable from them in the role hierarchy.
Example:
Role hierarchy: ROLE_A > ROLE_B and ROLE_B > ROLE_C.
Directly assigned authority: ROLE_A.
Reachable authorities: ROLE_A, ROLE_B, ROLE_C.

Parameters:

authorities - - Array of the directly assigned authorities.

Returns:

Array of all reachable authorities given the assigned authorities.