Class AuthorityAuthorizationManager<T>

java.lang.Object

org.springframework.security.authorization.AuthorityAuthorizationManager<T>

Type Parameters:

T - the type of object being authorized.

All Implemented Interfaces:

AuthorizationManager<T>

public final class AuthorityAuthorizationManager<T>
extends Object
implements AuthorizationManager<T>

An AuthorizationManager that determines if the current user is authorized by evaluating if the Authentication contains a specified authority.

Since:

5.5

See Also:

• AllAuthoritiesAuthorizationManager

Method Summary

Modifier and Type	Method	Description
AuthorizationResult	authorize(Supplier<? extends @Nullable Authentication> authentication, T object)	Determines if access is granted for a specific authentication and object.
static <T> AuthorityAuthorizationManager<T>	hasAnyAuthority(String... authorities)	Creates an instance of AuthorityAuthorizationManager with the provided authorities.
static <T> AuthorityAuthorizationManager<T>	hasAnyRole(String... roles)	Creates an instance of AuthorityAuthorizationManager with the provided authorities.
static <T> AuthorityAuthorizationManager<T>	hasAnyRole(String rolePrefix, String[] roles)	Creates an instance of AuthorityAuthorizationManager with the provided authorities.
static <T> AuthorityAuthorizationManager<T>	hasAuthority(String authority)	Creates an instance of AuthorityAuthorizationManager with the provided authority.
static <T> AuthorityAuthorizationManager<T>	hasRole(String role)	Creates an instance of AuthorityAuthorizationManager with the provided authority.
void	setRoleHierarchy(RoleHierarchy roleHierarchy)	Sets the RoleHierarchy to be used.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AuthorizationManager

verify

Method Details

setRoleHierarchy

public void setRoleHierarchy(RoleHierarchy roleHierarchy)

Sets the RoleHierarchy to be used. Default is NullRoleHierarchy. Cannot be null.

Parameters:

roleHierarchy - the RoleHierarchy to use

Since:

5.8

hasRole

public static <T> AuthorityAuthorizationManager<T> hasRole(String role)

Creates an instance of AuthorityAuthorizationManager with the provided authority.

Type Parameters:

T - the type of object being authorized

Parameters:

role - the authority to check for prefixed with "ROLE_". Role should not start with "ROLE_" since it is automatically prepended already.

Returns:

the new instance

hasAuthority

public static <T> AuthorityAuthorizationManager<T> hasAuthority(String authority)

Creates an instance of AuthorityAuthorizationManager with the provided authority.

Type Parameters:

T - the type of object being authorized

Parameters:

authority - the authority to check for

Returns:

the new instance

hasAnyRole

public static <T> AuthorityAuthorizationManager<T> hasAnyRole(String... roles)

Creates an instance of AuthorityAuthorizationManager with the provided authorities.

Type Parameters:

T - the type of object being authorized

Parameters:

roles - the authorities to check for prefixed with "ROLE_". Each role should not start with "ROLE_" since it is automatically prepended already.

Returns:

the new instance

hasAnyRole

public static <T> AuthorityAuthorizationManager<T> hasAnyRole(String rolePrefix,
 String[] roles)

Creates an instance of AuthorityAuthorizationManager with the provided authorities.

Type Parameters:

T - the type of object being authorized

Parameters:

rolePrefix - the role prefix for roles

roles - the authorities to check for prefixed with rolePrefix

Returns:

the new instance

hasAnyAuthority

public static <T> AuthorityAuthorizationManager<T> hasAnyAuthority(String... authorities)

Creates an instance of AuthorityAuthorizationManager with the provided authorities.

Type Parameters:

T - the type of object being authorized

Parameters:

authorities - the authorities to check for

Returns:

the new instance

authorize

public AuthorizationResult authorize(Supplier<? extends @Nullable Authentication> authentication,
 T object)

Determines if access is granted for a specific authentication and object.

Specified by:

authorize in interface AuthorizationManager<T>

Parameters:

authentication - the Supplier of the Authentication to authorize

object - the T object to authorize

Returns:

an AuthorizationResult

toString

public String toString()

Overrides:

toString in class Object