org.springframework.security.test.web.reactive.server

Class SecurityMockServerConfigurers.OidcLoginMutator

java.lang.Object

org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.OidcLoginMutator

All Implemented Interfaces:

org.springframework.test.web.reactive.server.MockServerConfigurer, org.springframework.test.web.reactive.server.WebTestClientConfigurer

Enclosing class:

SecurityMockServerConfigurers

public static final class SecurityMockServerConfigurers.OidcLoginMutator
extends java.lang.Object
implements org.springframework.test.web.reactive.server.WebTestClientConfigurer, org.springframework.test.web.reactive.server.MockServerConfigurer

Since:

5.3

Method Summary

Modifier and Type	Method and Description
void	afterConfigureAdded(org.springframework.test.web.reactive.server.WebTestClient.MockServerSpec<?> serverSpec)
void	afterConfigurerAdded(org.springframework.test.web.reactive.server.WebTestClient.Builder builder, org.springframework.web.server.adapter.WebHttpHandlerBuilder httpHandlerBuilder, org.springframework.http.client.reactive.ClientHttpConnector connector)
SecurityMockServerConfigurers.OidcLoginMutator	authorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities) Use the provided authorities in the Authentication
SecurityMockServerConfigurers.OidcLoginMutator	authorities(org.springframework.security.core.GrantedAuthority... authorities) Use the provided authorities in the Authentication
void	beforeServerCreated(org.springframework.web.server.adapter.WebHttpHandlerBuilder builder)
SecurityMockServerConfigurers.OidcLoginMutator	clientRegistration(org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration) Use the provided ClientRegistration as the client to authorize.
SecurityMockServerConfigurers.OidcLoginMutator	idToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcIdToken.Builder> idTokenBuilderConsumer) Use the provided OidcIdToken when constructing the authenticated user
SecurityMockServerConfigurers.OidcLoginMutator	oidcUser(org.springframework.security.oauth2.core.oidc.user.OidcUser oidcUser) Use the provided OidcUser as the authenticated user.
SecurityMockServerConfigurers.OidcLoginMutator	userInfoToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder> userInfoBuilderConsumer) Use the provided OidcUserInfo when constructing the authenticated user

Methods inherited from class java.lang.Object

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

Method Detail

authorities

public SecurityMockServerConfigurers.OidcLoginMutator authorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities)

Use the provided authorities in the Authentication

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

authorities

public SecurityMockServerConfigurers.OidcLoginMutator authorities(org.springframework.security.core.GrantedAuthority... authorities)

Use the provided authorities in the Authentication

Parameters:

authorities - the authorities to use

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

idToken

public SecurityMockServerConfigurers.OidcLoginMutator idToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcIdToken.Builder> idTokenBuilderConsumer)

Use the provided OidcIdToken when constructing the authenticated user

Parameters:

idTokenBuilderConsumer - a Consumer of a OidcIdToken.Builder

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

userInfoToken

public SecurityMockServerConfigurers.OidcLoginMutator userInfoToken(java.util.function.Consumer<org.springframework.security.oauth2.core.oidc.OidcUserInfo.Builder> userInfoBuilderConsumer)

Use the provided OidcUserInfo when constructing the authenticated user

Parameters:

userInfoBuilderConsumer - a Consumer of a OidcUserInfo.Builder

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

oidcUser

public SecurityMockServerConfigurers.OidcLoginMutator oidcUser(org.springframework.security.oauth2.core.oidc.user.OidcUser oidcUser)

Use the provided OidcUser as the authenticated user.

Supplying an OidcUser will take precedence over idToken, userInfo, and list of GrantedAuthoritys to use.

Parameters:

oidcUser - the OidcUser to use

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

clientRegistration

public SecurityMockServerConfigurers.OidcLoginMutator clientRegistration(org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration)

Use the provided ClientRegistration as the client to authorize.

The supplied ClientRegistration will be registered into an WebSessionServerOAuth2AuthorizedClientRepository. Tests relying on org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient annotations should register an WebSessionServerOAuth2AuthorizedClientRepository bean to the application context.

Parameters:

clientRegistration - the ClientRegistration to use

Returns:

the SecurityMockServerConfigurers.OidcLoginMutator for further configuration

beforeServerCreated

public void beforeServerCreated(org.springframework.web.server.adapter.WebHttpHandlerBuilder builder)

Specified by:

beforeServerCreated in interface org.springframework.test.web.reactive.server.MockServerConfigurer

afterConfigureAdded

public void afterConfigureAdded(org.springframework.test.web.reactive.server.WebTestClient.MockServerSpec<?> serverSpec)

Specified by:

afterConfigureAdded in interface org.springframework.test.web.reactive.server.MockServerConfigurer

afterConfigurerAdded

public void afterConfigurerAdded(org.springframework.test.web.reactive.server.WebTestClient.Builder builder,
                                 @Nullable
                                 org.springframework.web.server.adapter.WebHttpHandlerBuilder httpHandlerBuilder,
                                 @Nullable
                                 org.springframework.http.client.reactive.ClientHttpConnector connector)

Specified by:

afterConfigurerAdded in interface org.springframework.test.web.reactive.server.WebTestClientConfigurer