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

SEC-2930: Update SecurityExpressionOperations javadoc

This commit is contained in:
Rob Winch 2015-04-21 09:21:29 -05:00
parent 7000652fd1
commit b433cdda7e
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
core/src/main/java/org/springframework/security/access/expression/SecurityExpressionOperations.java
View File

@ -19,8 +19,7 @@ public interface SecurityExpressionOperations {
/** /**
* Determines if the {@link #getAuthentication()} has a particular authority within * Determines if the {@link #getAuthentication()} has a particular authority within
* {@link Authentication#getAuthorities()}. This is a synonym for * {@link Authentication#getAuthorities()}.
* {@link #hasAuthority(String)}.
* @param authority the authority to test (i.e. "ROLE_USER") * @param authority the authority to test (i.e. "ROLE_USER")
* @return true if the authority is found, else false * @return true if the authority is found, else false
*/ */
@ -28,27 +27,42 @@ public interface SecurityExpressionOperations {
/** /**
* Determines if the {@link #getAuthentication()} has any of the specified authorities * Determines if the {@link #getAuthentication()} has any of the specified authorities
* within {@link Authentication#getAuthorities()}. This is a synonym for * within {@link Authentication#getAuthorities()}.
* {@link #hasAnyRole(String...)}.
* @param authorities the authorities to test (i.e. "ROLE_USER", "ROLE_ADMIN") * @param authorities the authorities to test (i.e. "ROLE_USER", "ROLE_ADMIN")
* @return true if any of the authorities is found, else false * @return true if any of the authorities is found, else false
*/ */
boolean hasAnyAuthority(String... authorities); boolean hasAnyAuthority(String... authorities);
/** /**
* <p>
* Determines if the {@link #getAuthentication()} has a particular authority within * Determines if the {@link #getAuthentication()} has a particular authority within
* {@link Authentication#getAuthorities()}. This is a synonym for * {@link Authentication#getAuthorities()}.
* {@link #hasAuthority(String)}. * </p>
* @param authority the authority to test (i.e. "ROLE_USER") * <p>
* This is similar to {@link #hasAuthority(String)} except that this method implies
* that the String passed in is a role. For example, if "USER" is passed in the
* implementation may convert it to use "ROLE_USER" instead. The way in which the role
* is converted may depend on the implementation settings.
* </p>
*
* @param authority the authority to test (i.e. "USER")
* @return true if the authority is found, else false * @return true if the authority is found, else false
*/ */
boolean hasRole(String role); boolean hasRole(String role);
/** /**
* <p>
* Determines if the {@link #getAuthentication()} has any of the specified authorities * Determines if the {@link #getAuthentication()} has any of the specified authorities
* within {@link Authentication#getAuthorities()}. This is a synonym for * within {@link Authentication#getAuthorities()}.
* {@link #hasAnyAuthority(String...)}. * </p>
* @param authorities the authorities to test (i.e. "ROLE_USER", "ROLE_ADMIN") * <p>
* This is a similar to hasAnyAuthority except that this method implies
* that the String passed in is a role. For example, if "USER" is passed in the
* implementation may convert it to use "ROLE_USER" instead. The way in which the role
* is converted may depend on the implementation settings.
* </p>
*
* @param authorities the authorities to test (i.e. "USER", "ADMIN")
* @return true if any of the authorities is found, else false * @return true if any of the authorities is found, else false
*/ */
boolean hasAnyRole(String... roles); boolean hasAnyRole(String... roles);