Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc tidying

This commit is contained in:
Luke Taylor 2009-04-21 03:16:57 +00:00
parent 3adbbdf50d
commit 06040853da
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchy.java
View File

@ -22,22 +22,23 @@ import org.springframework.security.core.GrantedAuthority;
* The simple interface of a role hierarchy. * The simple interface of a role hierarchy.
* *
* @author Michael Mayr * @author Michael Mayr
*
*/ */
public interface RoleHierarchy { public interface RoleHierarchy {
/** /**
* This method returns an array of all reachable authorities.<br> * Returns an array of all reachable authorities.
* <p>
* Reachable authorities are the directly assigned authorities plus all * Reachable authorities are the directly assigned authorities plus all
* authorities that are (transitively) reachable from them in the role * authorities that are (transitively) reachable from them in the role
* hierarchy.<br> * hierarchy.
* <p>
* Example:<br> * Example:<br>
* Role hierarchy: ROLE_A > ROLE_B and ROLE_B > ROLE_C.<br> * Role hierarchy: ROLE_A > ROLE_B and ROLE_B > ROLE_C.<br>
* Directly assigned authority: ROLE_A.<br> * Directly assigned authority: ROLE_A.<br>
* Reachable authorities: ROLE_A, ROLE_B, ROLE_C. * Reachable authorities: ROLE_A, ROLE_B, ROLE_C.
* *
* @param authorities - Array of the directly assigned authorities. * @param authorities - List of the directly assigned authorities.
* @return Array of all reachable authorities given the assigned authorities. * @return List of all reachable authorities given the assigned authorities.
*/ */
public List<GrantedAuthority> getReachableGrantedAuthorities(List<GrantedAuthority> authorities); public List<GrantedAuthority> getReachableGrantedAuthorities(List<GrantedAuthority> authorities);