public interface

RoleHierarchy

org.springframework.security.access.hierarchicalroles.RoleHierarchy
Known Indirect Subclasses

Class Overview

The simple interface of a role hierarchy.

Summary

Public Methods
abstract Collection<? extends GrantedAuthority> getReachableGrantedAuthorities(Collection<? extends GrantedAuthority> authorities)
Returns an array of all reachable authorities.

Public Methods

public abstract Collection<? extends GrantedAuthority> getReachableGrantedAuthorities (Collection<? extends GrantedAuthority> authorities)

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 - List of the directly assigned authorities.
Returns
  • List of all reachable authorities given the assigned authorities.