org.springframework.test.web.reactive.server

Class DefaultWebTestClient

java.lang.Object

org.springframework.test.web.reactive.server.DefaultWebTestClient

All Implemented Interfaces:

WebTestClient

class DefaultWebTestClient
extends java.lang.Object
implements WebTestClient

Default implementation of WebTestClient.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultWebTestClient.DefaultBodyContentSpec
private static class	DefaultWebTestClient.DefaultBodySpec<B,S extends WebTestClient.BodySpec<B,S>>
private static class	DefaultWebTestClient.DefaultListBodySpec<E>
private class	DefaultWebTestClient.DefaultRequestBodyUriSpec
private static class	DefaultWebTestClient.DefaultResponseSpec

Nested classes/interfaces inherited from interface org.springframework.test.web.reactive.server.WebTestClient

WebTestClient.BodyContentSpec, WebTestClient.BodySpec<B,S extends WebTestClient.BodySpec<B,S>>, WebTestClient.Builder, WebTestClient.ControllerSpec, WebTestClient.ListBodySpec<E>, WebTestClient.MockServerSpec<B extends WebTestClient.MockServerSpec<B>>, WebTestClient.RequestBodySpec, WebTestClient.RequestBodyUriSpec, WebTestClient.RequestHeadersSpec<S extends WebTestClient.RequestHeadersSpec<S>>, WebTestClient.RequestHeadersUriSpec<S extends WebTestClient.RequestHeadersSpec<S>>, WebTestClient.ResponseSpec, WebTestClient.RouterFunctionSpec, WebTestClient.UriSpec<S extends WebTestClient.RequestHeadersSpec<?>>

Field Summary

Fields

Modifier and Type	Field and Description
private DefaultWebTestClientBuilder	builder
private java.util.concurrent.atomic.AtomicLong	requestIndex
private java.time.Duration	timeout
private WebClient	webClient
private WiretapConnector	wiretapConnector

Fields inherited from interface org.springframework.test.web.reactive.server.WebTestClient

WEBTESTCLIENT_REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
DefaultWebTestClient(WebClient.Builder clientBuilder, ClientHttpConnector connector, java.time.Duration timeout, DefaultWebTestClientBuilder webTestClientBuilder)

Method Summary

Modifier and Type	Method and Description
WebTestClient.RequestHeadersUriSpec<?>	delete() Prepare an HTTP DELETE request.
WebTestClient.RequestHeadersUriSpec<?>	get() Prepare an HTTP GET request.
private java.time.Duration	getTimeout()
WebTestClient.RequestHeadersUriSpec<?>	head() Prepare an HTTP HEAD request.
WebTestClient.RequestBodyUriSpec	method(HttpMethod method) Prepare a request for the specified HttpMethod.
private WebTestClient.RequestBodyUriSpec	methodInternal(HttpMethod method)
WebTestClient.Builder	mutate() Return a builder to mutate properties of this web test client.
WebTestClient	mutateWith(WebTestClientConfigurer configurer) Mutate the WebTestClient, apply the given configurer, and build a new instance.
WebTestClient.RequestHeadersUriSpec<?>	options() Prepare an HTTP OPTIONS request.
WebTestClient.RequestBodyUriSpec	patch() Prepare an HTTP PATCH request.
WebTestClient.RequestBodyUriSpec	post() Prepare an HTTP POST request.
WebTestClient.RequestBodyUriSpec	put() Prepare an HTTP PUT request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.test.web.reactive.server.WebTestClient

bindToApplicationContext, bindToController, bindToRouterFunction, bindToServer, bindToServer, bindToWebHandler

Field Detail

webClient

private final WebClient webClient

wiretapConnector

private final WiretapConnector wiretapConnector

timeout

private final java.time.Duration timeout

builder

private final DefaultWebTestClientBuilder builder

requestIndex

private final java.util.concurrent.atomic.AtomicLong requestIndex

Constructor Detail

DefaultWebTestClient

DefaultWebTestClient(WebClient.Builder clientBuilder,
                     ClientHttpConnector connector,
                     @Nullable
                     java.time.Duration timeout,
                     DefaultWebTestClientBuilder webTestClientBuilder)

Method Detail

getTimeout

private java.time.Duration getTimeout()

get

public WebTestClient.RequestHeadersUriSpec<?> get()

Description copied from interface: WebTestClient

Prepare an HTTP GET request.

Specified by:

get in interface WebTestClient

Returns:

a spec for specifying the target URL

head

public WebTestClient.RequestHeadersUriSpec<?> head()

Description copied from interface: WebTestClient

Prepare an HTTP HEAD request.

Specified by:

head in interface WebTestClient

Returns:

a spec for specifying the target URL

post

public WebTestClient.RequestBodyUriSpec post()

Description copied from interface: WebTestClient

Prepare an HTTP POST request.

Specified by:

post in interface WebTestClient

Returns:

a spec for specifying the target URL

put

public WebTestClient.RequestBodyUriSpec put()

Description copied from interface: WebTestClient

Prepare an HTTP PUT request.

Specified by:

put in interface WebTestClient

Returns:

a spec for specifying the target URL

patch

public WebTestClient.RequestBodyUriSpec patch()

Description copied from interface: WebTestClient

Prepare an HTTP PATCH request.

Specified by:

patch in interface WebTestClient

Returns:

a spec for specifying the target URL

delete

public WebTestClient.RequestHeadersUriSpec<?> delete()

Description copied from interface: WebTestClient

Prepare an HTTP DELETE request.

Specified by:

delete in interface WebTestClient

Returns:

a spec for specifying the target URL

options

public WebTestClient.RequestHeadersUriSpec<?> options()

Description copied from interface: WebTestClient

Prepare an HTTP OPTIONS request.

Specified by:

options in interface WebTestClient

Returns:

a spec for specifying the target URL

method

public WebTestClient.RequestBodyUriSpec method(HttpMethod method)

Description copied from interface: WebTestClient

Prepare a request for the specified HttpMethod.

Specified by:

method in interface WebTestClient

Returns:

a spec for specifying the target URL

methodInternal

private WebTestClient.RequestBodyUriSpec methodInternal(HttpMethod method)

mutate

public WebTestClient.Builder mutate()

Description copied from interface: WebTestClient

Return a builder to mutate properties of this web test client.

Specified by:

mutate in interface WebTestClient

mutateWith

public WebTestClient mutateWith(WebTestClientConfigurer configurer)

Description copied from interface: WebTestClient

Mutate the WebTestClient, apply the given configurer, and build a new instance. Essentially a shortcut for:

 mutate().apply(configurer).build();
 

Specified by:

mutateWith in interface WebTestClient

Parameters:

configurer - the configurer to apply

Returns:

the mutated test client