Class UserWebTestClientConfigurer

java.lang.Object

org.springframework.test.web.reactive.server.UserWebTestClientConfigurer

All Implemented Interfaces:

WebTestClientConfigurer

public final class UserWebTestClientConfigurer
extends Object
implements WebTestClientConfigurer

WebTestClientConfigurer that modifies WebFlux mock server requests by setting their SslInfo.

You can apply the configurer to a WebTestClient.Builder:

 WebTestClient client = webTestClientBuilder
         .apply(UserWebTestClientConfigurer.x509(certificate))
         .build();
 

Or mutate an already built WebTestClient:

 WebTestClient newClient =
         client.mutateWith(UserWebTestClientConfigurer.x509(certificate));
 

Note: This configurer is applicable only to WebFlux mock server setup. For a WebTestClient.Builder with a live server setup, or a non-WebFlux, mock server, an IllegalStateException is raised.

For tests with a MockMvc server, refer to a similar facility to set the user identity per request through Spring Security's SecurityMockMvcRequestPostProcessors.

Since:

7.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
void	afterConfigurerAdded(WebTestClient.Builder builder, @Nullable WebHttpHandlerBuilder httpHandlerBuilder, @Nullable ClientHttpConnector connector)	Use methods on WebTestClient.Builder to modify test client settings.
static UserWebTestClientConfigurer	sslInfo(SslInfo info)	Create a configurer with the given SslInfo.
static UserWebTestClientConfigurer	x509(X509Certificate... certificates)	Create a configurer with the given X509 certificate(s).

Methods inherited from class java.lang.Object

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

Method Details

afterConfigurerAdded

public void afterConfigurerAdded(WebTestClient.Builder builder,
 @Nullable WebHttpHandlerBuilder httpHandlerBuilder,
 @Nullable ClientHttpConnector connector)

Description copied from interface: WebTestClientConfigurer

Use methods on WebTestClient.Builder to modify test client settings. For a mock WebFlux server, use WebHttpHandlerBuilder to customize server configuration. For a MockMvc server, mutate the MockMvcHttpConnector and set it on WebTestClient.Builder.

Specified by:

afterConfigurerAdded in interface WebTestClientConfigurer

Parameters:

builder - the WebTestClient builder for test client changes

httpHandlerBuilder - for mock WebFlux server settings

connector - the connector in use

x509

public static UserWebTestClientConfigurer x509(X509Certificate... certificates)

Create a configurer with the given X509 certificate(s).

sslInfo

public static UserWebTestClientConfigurer sslInfo(SslInfo info)

Create a configurer with the given SslInfo.