Package org.springframework.security.authorization

Class DefaultAuthorizationManagerFactory<T extends @Nullable Object>

java.lang.Object

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

Type Parameters:

T - the type of object that the authorization check is being done on

All Implemented Interfaces:

AuthorizationManagerFactory<T>

public final class DefaultAuthorizationManagerFactory<T extends @Nullable Object>
extends Object
implements AuthorizationManagerFactory<T>

A factory for creating different kinds of AuthorizationManager instances.

Since:

7.0

Constructor Summary

Constructors

Constructor	Description
DefaultAuthorizationManagerFactory()

Method Summary

Modifier and Type	Method	Description
AuthorizationManager<T>	anonymous()	Creates an AuthorizationManager that allows only anonymous users.
AuthorizationManager<T>	authenticated()	Creates an AuthorizationManager that allows any authenticated user.
AuthorizationManager<T>	fullyAuthenticated()	Creates an AuthorizationManager that allows users who have authenticated and were not remembered.
AuthorizationManager<T>	hasAllAuthorities(String... authorities)	Creates an AuthorizationManager that requires users to have all the provided authorities.
AuthorizationManager<T>	hasAllRoles(String... roles)	Creates an AuthorizationManager that requires users to have all the provided roles.
AuthorizationManager<T>	hasAnyAuthority(String... authorities)	Creates an AuthorizationManager that requires users to have one of many authorities.
AuthorizationManager<T>	hasAnyRole(String... roles)	Creates an AuthorizationManager that requires users to have one of many roles.
AuthorizationManager<T>	hasAuthority(String authority)	Creates an AuthorizationManager that requires users to have the specified authority.
AuthorizationManager<T>	hasRole(String role)	Creates an AuthorizationManager that requires users to have the specified role.
AuthorizationManager<T>	rememberMe()	Creates an AuthorizationManager that allows users that have been remembered.
void	setAdditionalAuthorization(@Nullable AuthorizationManager<T> additionalAuthorization)	Sets additional authorization to be applied to the returned AuthorizationManager for the following methods: hasRole(String) hasAnyRole(String...) hasAllRoles(String...) hasAuthority(String) hasAnyAuthority(String...) hasAllAuthorities(String...) authenticated() fullyAuthenticated() rememberMe()
void	setRoleHierarchy(RoleHierarchy roleHierarchy)	Sets the RoleHierarchy used to discover reachable authorities.
void	setRolePrefix(String rolePrefix)	Sets the prefix used to create an authority name from a role name.
void	setTrustResolver(AuthenticationTrustResolver trustResolver)	Sets the AuthenticationTrustResolver used to check the user's authentication.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.authorization.AuthorizationManagerFactory

denyAll, permitAll

Constructor Details

DefaultAuthorizationManagerFactory

public DefaultAuthorizationManagerFactory()

Method Details

setTrustResolver

public void setTrustResolver(AuthenticationTrustResolver trustResolver)

Sets the AuthenticationTrustResolver used to check the user's authentication.

Parameters:

trustResolver - the AuthenticationTrustResolver to use

setRoleHierarchy

public void setRoleHierarchy(RoleHierarchy roleHierarchy)

Sets the RoleHierarchy used to discover reachable authorities.

Parameters:

roleHierarchy - the RoleHierarchy to use

setRolePrefix

public void setRolePrefix(String rolePrefix)

Sets the prefix used to create an authority name from a role name. Can be an empty string.

Parameters:

rolePrefix - the role prefix to use

setAdditionalAuthorization

public void setAdditionalAuthorization(@Nullable AuthorizationManager<T> additionalAuthorization)

Sets additional authorization to be applied to the returned AuthorizationManager for the following methods:

• hasRole(String)
• hasAnyRole(String...)
• hasAllRoles(String...)
• hasAuthority(String)
• hasAnyAuthority(String...)
• hasAllAuthorities(String...)
• authenticated()
• fullyAuthenticated()
• rememberMe()

This does not affect anonymous, permitAll, or denyAll.

Parameters:

additionalAuthorization - the AuthorizationManager to be applied. Default is null (no additional authorization).

hasRole

public AuthorizationManager<T> hasRole(String role)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have the specified role.

Specified by:

hasRole in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

role - the role (automatically prepended with ROLE_) that should be required to allow access (i.e. USER, ADMIN, etc.)

Returns:

A new AuthorizationManager instance

hasAnyRole

public AuthorizationManager<T> hasAnyRole(String... roles)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have one of many roles.

Specified by:

hasAnyRole in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

roles - the roles (automatically prepended with ROLE_) that the user should have at least one of to allow access (i.e. USER, ADMIN, etc.)

Returns:

A new AuthorizationManager instance

hasAllRoles

public AuthorizationManager<T> hasAllRoles(String... roles)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have all the provided roles.

Specified by:

hasAllRoles in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

roles - the roles (automatically prepended with ROLE_) that the user must have to allow access (i.e. USER, ADMIN, etc.)

Returns:

A new AuthorizationManager instance

hasAuthority

public AuthorizationManager<T> hasAuthority(String authority)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have the specified authority.

Specified by:

hasAuthority in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

authority - the authority that should be required to allow access (i.e. ROLE_USER, ROLE_ADMIN, etc.)

Returns:

A new AuthorizationManager instance

hasAnyAuthority

public AuthorizationManager<T> hasAnyAuthority(String... authorities)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have one of many authorities.

Specified by:

hasAnyAuthority in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

authorities - the authorities that the user should have at least one of to allow access (i.e. ROLE_USER, ROLE_ADMIN, etc.)

Returns:

A new AuthorizationManager instance

hasAllAuthorities

public AuthorizationManager<T> hasAllAuthorities(String... authorities)

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that requires users to have all the provided authorities.

Specified by:

hasAllAuthorities in interface AuthorizationManagerFactory<T extends @Nullable Object>

Parameters:

authorities - the authorities that the user must have to allow access (i.e. USER, ADMIN, etc.)

Returns:

A new AuthorizationManager instance

authenticated

public AuthorizationManager<T> authenticated()

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that allows any authenticated user.

Specified by:

authenticated in interface AuthorizationManagerFactory<T extends @Nullable Object>

Returns:

A new AuthorizationManager instance

fullyAuthenticated

public AuthorizationManager<T> fullyAuthenticated()

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that allows users who have authenticated and were not remembered.

Specified by:

fullyAuthenticated in interface AuthorizationManagerFactory<T extends @Nullable Object>

Returns:

A new AuthorizationManager instance

rememberMe

public AuthorizationManager<T> rememberMe()

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that allows users that have been remembered.

Specified by:

rememberMe in interface AuthorizationManagerFactory<T extends @Nullable Object>

Returns:

A new AuthorizationManager instance

anonymous

public AuthorizationManager<T> anonymous()

Description copied from interface: AuthorizationManagerFactory

Creates an AuthorizationManager that allows only anonymous users.

Specified by:

anonymous in interface AuthorizationManagerFactory<T extends @Nullable Object>

Returns:

A new AuthorizationManager instance