Package org.springframework.security.authorization

Interface AuthorizationManagerFactory<T extends @Nullable Object>

Type Parameters:

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

All Known Implementing Classes:

DefaultAuthorizationManagerFactory

public interface AuthorizationManagerFactory<T extends @Nullable Object>

A factory for creating different kinds of AuthorizationManager instances.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
default AuthorizationManager<T>	anonymous()	Creates an AuthorizationManager that allows only anonymous users.
default AuthorizationManager<T>	authenticated()	Creates an AuthorizationManager that allows any authenticated user.
default AuthorizationManager<T>	denyAll()	Creates an AuthorizationManager that does not allow anyone.
default AuthorizationManager<T>	fullyAuthenticated()	Creates an AuthorizationManager that allows users who have authenticated and were not remembered.
default AuthorizationManager<T>	hasAllAuthorities(String... authorities)	Creates an AuthorizationManager that requires users to have all the provided authorities.
default AuthorizationManager<T>	hasAllRoles(String... roles)	Creates an AuthorizationManager that requires users to have all the provided roles.
default AuthorizationManager<T>	hasAnyAuthority(String... authorities)	Creates an AuthorizationManager that requires users to have one of many authorities.
default AuthorizationManager<T>	hasAnyRole(String... roles)	Creates an AuthorizationManager that requires users to have one of many roles.
default AuthorizationManager<T>	hasAuthority(String authority)	Creates an AuthorizationManager that requires users to have the specified authority.
default AuthorizationManager<T>	hasRole(String role)	Creates an AuthorizationManager that requires users to have the specified role.
default AuthorizationManager<T>	permitAll()	Create an AuthorizationManager that allows anyone.
default AuthorizationManager<T>	rememberMe()	Creates an AuthorizationManager that allows users that have been remembered.

Method Details

permitAll

default AuthorizationManager<T> permitAll()

Create an AuthorizationManager that allows anyone.

Returns:

A new AuthorizationManager instance

denyAll

default AuthorizationManager<T> denyAll()

Creates an AuthorizationManager that does not allow anyone.

Returns:

A new AuthorizationManager instance

hasRole

default AuthorizationManager<T> hasRole(String role)

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

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

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

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

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

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

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

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

default AuthorizationManager<T> hasAuthority(String authority)

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

Parameters:

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

Returns:

A new AuthorizationManager instance

hasAnyAuthority

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

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

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

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

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

Parameters:

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

Returns:

A new AuthorizationManager instance

authenticated

default AuthorizationManager<T> authenticated()

Creates an AuthorizationManager that allows any authenticated user.

Returns:

A new AuthorizationManager instance

fullyAuthenticated

default AuthorizationManager<T> fullyAuthenticated()

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

Returns:

A new AuthorizationManager instance

rememberMe

default AuthorizationManager<T> rememberMe()

Creates an AuthorizationManager that allows users that have been remembered.

Returns:

A new AuthorizationManager instance

anonymous

default AuthorizationManager<T> anonymous()

Creates an AuthorizationManager that allows only anonymous users.

Returns:

A new AuthorizationManager instance