org.springframework.web.servlet.function

Class DefaultServerRequestBuilder

java.lang.Object

org.springframework.web.servlet.function.DefaultServerRequestBuilder

All Implemented Interfaces:

ServerRequest.Builder

class DefaultServerRequestBuilder
extends java.lang.Object
implements ServerRequest.Builder

Default ServerRequest.Builder implementation.

Since:

5.2

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultServerRequestBuilder.BodyInputStream
private static class	DefaultServerRequestBuilder.BuiltServerRequest

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private byte[]	body
private MultiValueMap<java.lang.String,Cookie>	cookies
private HttpHeaders	headers
private java.util.List<HttpMessageConverter<?>>	messageConverters
private java.lang.String	methodName
private HttpServletRequest	servletRequest
private java.net.URI	uri

Constructor Summary

Constructors

Constructor and Description
DefaultServerRequestBuilder(ServerRequest other)

Method Summary

Modifier and Type	Method and Description
ServerRequest.Builder	attribute(java.lang.String name, java.lang.Object value) Add an attribute with the given name and value.
ServerRequest.Builder	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer) Manipulate this request's attributes with the given consumer.
ServerRequest.Builder	body(byte[] body) Set the body of the request.
ServerRequest.Builder	body(java.lang.String body) Set the body of the request to the UTF-8 encoded bytes of the given string.
ServerRequest	build() Build the request.
ServerRequest.Builder	cookie(java.lang.String name, java.lang.String... values) Add a cookie with the given name and value(s).
ServerRequest.Builder	cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,Cookie>> cookiesConsumer) Manipulate this request's cookies with the given consumer.
ServerRequest.Builder	header(java.lang.String headerName, java.lang.String... headerValues) Add the given header value(s) under the given name.
ServerRequest.Builder	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate this request's headers with the given consumer.
ServerRequest.Builder	method(HttpMethod method) Set the method of the request.
ServerRequest.Builder	uri(java.net.URI uri) Set the URI of the request.

Methods inherited from class java.lang.Object

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

Field Detail

messageConverters

private final java.util.List<HttpMessageConverter<?>> messageConverters

servletRequest

private HttpServletRequest servletRequest

methodName

private java.lang.String methodName

uri

private java.net.URI uri

headers

private final HttpHeaders headers

cookies

private final MultiValueMap<java.lang.String,Cookie> cookies

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

body

private byte[] body

Constructor Detail

DefaultServerRequestBuilder

public DefaultServerRequestBuilder(ServerRequest other)

Method Detail

method

public ServerRequest.Builder method(HttpMethod method)

Description copied from interface: ServerRequest.Builder

Set the method of the request.

Specified by:

method in interface ServerRequest.Builder

Parameters:

method - the new method

Returns:

this builder

uri

public ServerRequest.Builder uri(java.net.URI uri)

Description copied from interface: ServerRequest.Builder

Set the URI of the request.

Specified by:

uri in interface ServerRequest.Builder

Parameters:

uri - the new URI

Returns:

this builder

header

public ServerRequest.Builder header(java.lang.String headerName,
                                    java.lang.String... headerValues)

Description copied from interface: ServerRequest.Builder

Add the given header value(s) under the given name.

Specified by:

header in interface ServerRequest.Builder

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

headers

public ServerRequest.Builder headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Description copied from interface: ServerRequest.Builder

Manipulate this request's headers with the given consumer.

The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

Specified by:

headers in interface ServerRequest.Builder

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

cookie

public ServerRequest.Builder cookie(java.lang.String name,
                                    java.lang.String... values)

Description copied from interface: ServerRequest.Builder

Add a cookie with the given name and value(s).

Specified by:

cookie in interface ServerRequest.Builder

Parameters:

name - the cookie name

values - the cookie value(s)

Returns:

this builder

cookies

public ServerRequest.Builder cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,Cookie>> cookiesConsumer)

Description copied from interface: ServerRequest.Builder

Manipulate this request's cookies with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

Specified by:

cookies in interface ServerRequest.Builder

Parameters:

cookiesConsumer - a function that consumes the cookies map

Returns:

this builder

body

public ServerRequest.Builder body(byte[] body)

Description copied from interface: ServerRequest.Builder

Set the body of the request.

Calling this methods will release the existing body of the builder.

Specified by:

body in interface ServerRequest.Builder

Parameters:

body - the new body

Returns:

this builder

body

public ServerRequest.Builder body(java.lang.String body)

Description copied from interface: ServerRequest.Builder

Set the body of the request to the UTF-8 encoded bytes of the given string.

Calling this methods will release the existing body of the builder.

Specified by:

body in interface ServerRequest.Builder

Parameters:

body - the new body

Returns:

this builder

attribute

public ServerRequest.Builder attribute(java.lang.String name,
                                       java.lang.Object value)

Description copied from interface: ServerRequest.Builder

Add an attribute with the given name and value.

Specified by:

attribute in interface ServerRequest.Builder

Parameters:

name - the attribute name

value - the attribute value

Returns:

this builder

attributes

public ServerRequest.Builder attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)

Description copied from interface: ServerRequest.Builder

Manipulate this request's attributes with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing attributes, remove attributes, or use any of the other Map methods.

Specified by:

attributes in interface ServerRequest.Builder

Parameters:

attributesConsumer - a function that consumes the attributes map

Returns:

this builder

build

public ServerRequest build()

Description copied from interface: ServerRequest.Builder

Build the request.

Specified by:

build in interface ServerRequest.Builder

Returns:

the built request