Class AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>

java.lang.Object

org.springframework.security.authorization.AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>

Type Parameters:

T - the type for the DefaultAuthorizationManagerFactory

Enclosing class:

AuthorizationManagerFactories

public static final class AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>
extends Object

A builder that allows creating DefaultAuthorizationManagerFactory with additional requirements for RequiredFactors.

Since:

7.0

Method Summary

Modifier and Type	Method	Description
DefaultAuthorizationManagerFactory<T>	build()	Builds a DefaultAuthorizationManagerFactory that has the DefaultAuthorizationManagerFactory.setAdditionalAuthorization(AuthorizationManager) set.
AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>	requireFactor(Consumer<RequiredFactor.Builder> factor)
AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>	requireFactors(String... additionalAuthorities)	Add additional authorities that will be required.
AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>	requireFactors(Consumer<AllRequiredFactorsAuthorizationManager.Builder<T>> factors)
AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>	when(Predicate<Authentication> condition)	Apply the required factors only when the given condition is true for the current Authentication.
AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T>	withWhen(Function<@Nullable Predicate<Authentication>, @Nullable Predicate<Authentication>> condition)	Customize the condition that determines if the required factors are evaluated.

Methods inherited from class Object

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

Method Details

when

public AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T> when(Predicate<Authentication> condition)

Apply the required factors only when the given condition is true for the current Authentication. When the condition is false, no additional factors are required (equivalent to permit-all for the additional authorization). Implemented using ConditionalAuthorizationManager.when(java.util.function.Predicate).

Parameters:

condition - the condition to evaluate (must not be null)

Returns:

the AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder to further customize

Since:

7.1

withWhen

public AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T> withWhen(Function<@Nullable Predicate<Authentication>, @Nullable Predicate<Authentication>> condition)

Customize the condition that determines if the required factors are evaluated.

Parameters:

condition - a function that takes the current condition and returns the new condition

Returns:

the AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder to further customize

Since:

7.1

requireFactors

public AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T> requireFactors(String... additionalAuthorities)

Add additional authorities that will be required.

Parameters:

additionalAuthorities - the additional authorities.

Returns:

the AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder to further customize.

requireFactors

public AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T> requireFactors(Consumer<AllRequiredFactorsAuthorizationManager.Builder<T>> factors)

requireFactor

public AuthorizationManagerFactories.AdditionalRequiredFactorsBuilder<T> requireFactor(Consumer<RequiredFactor.Builder> factor)

build

public DefaultAuthorizationManagerFactory<T> build()

Builds a DefaultAuthorizationManagerFactory that has the DefaultAuthorizationManagerFactory.setAdditionalAuthorization(AuthorizationManager) set.

Returns:

the DefaultAuthorizationManagerFactory.