org.springframework.web.server

Class DefaultServerWebExchangeBuilder

java.lang.Object

org.springframework.web.server.DefaultServerWebExchangeBuilder

All Implemented Interfaces:

ServerWebExchange.Builder

class DefaultServerWebExchangeBuilder
extends java.lang.Object
implements ServerWebExchange.Builder

Package-private implementation of ServerWebExchange.Builder.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultServerWebExchangeBuilder.MutativeDecorator An immutable wrapper of an exchange returning property overrides -- given to the constructor -- or original values otherwise.

Field Summary

Fields

Modifier and Type	Field and Description
private ServerWebExchange	delegate
private <any>	principalMono
private ServerHttpRequest	request
private ServerHttpResponse	response

Constructor Summary

Constructors

Constructor and Description
DefaultServerWebExchangeBuilder(ServerWebExchange delegate)

Method Summary

Modifier and Type	Method and Description
ServerWebExchange	build() Build a ServerWebExchange decorator with the mutated properties.
ServerWebExchange.Builder	principal(<any> principalMono) Set the Mono<Principal> to return for this exchange.
ServerWebExchange.Builder	request(java.util.function.Consumer<ServerHttpRequest.Builder> consumer) Configure a consumer to modify the current request using a builder.
ServerWebExchange.Builder	request(ServerHttpRequest request) Set the request to use especially when there is a need to override ServerHttpRequest methods.
ServerWebExchange.Builder	response(ServerHttpResponse response) Set the response to use.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

private final ServerWebExchange delegate

request

@Nullable
private ServerHttpRequest request

response

@Nullable
private ServerHttpResponse response

principalMono

@Nullable
private <any> principalMono

Constructor Detail

DefaultServerWebExchangeBuilder

DefaultServerWebExchangeBuilder(ServerWebExchange delegate)

Method Detail

request

public ServerWebExchange.Builder request(java.util.function.Consumer<ServerHttpRequest.Builder> consumer)

Description copied from interface: ServerWebExchange.Builder

Configure a consumer to modify the current request using a builder.

Effectively this:

 exchange.mutate().request(builder-> builder.method(HttpMethod.PUT));

 // vs...

 ServerHttpRequest request = exchange.getRequest().mutate()
     .method(HttpMethod.PUT)
     .build();

 exchange.mutate().request(request);
 

Specified by:

request in interface ServerWebExchange.Builder

See Also:

ServerHttpRequest.mutate()

request

public ServerWebExchange.Builder request(ServerHttpRequest request)

Description copied from interface: ServerWebExchange.Builder

Set the request to use especially when there is a need to override ServerHttpRequest methods. To simply mutate request properties see ServerWebExchange.Builder.request(Consumer) instead.

Specified by:

request in interface ServerWebExchange.Builder

See Also:

ServerHttpRequestDecorator

response

public ServerWebExchange.Builder response(ServerHttpResponse response)

Description copied from interface: ServerWebExchange.Builder

Set the response to use.

Specified by:

response in interface ServerWebExchange.Builder

See Also:

ServerHttpResponseDecorator

principal

public ServerWebExchange.Builder principal(<any> principalMono)

Description copied from interface: ServerWebExchange.Builder

Set the Mono<Principal> to return for this exchange.

Specified by:

principal in interface ServerWebExchange.Builder

build

public ServerWebExchange build()

Description copied from interface: ServerWebExchange.Builder

Build a ServerWebExchange decorator with the mutated properties.

Specified by:

build in interface ServerWebExchange.Builder