Modifier and Type	Class and Description
private static class	DefaultServerHttpRequestBuilder.MutatedServerHttpRequest

Access	Constructor and Description
public	DefaultServerHttpRequestBuilder(ServerHttpRequest original)

Method Summary

Modifier and Type	Method and Description
public ServerHttpRequest	build() Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.build. Build a `ServerHttpRequest` decorator with the mutated properties.
public ServerHttpRequest.Builder	contextPath(String contextPath) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.contextPath. Set the contextPath to use.
private URI	getUriToUse()
public ServerHttpRequest.Builder	header(String the header name headerName, String... the header values headerValues) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.header. Set or override the specified header values under the given name.
public ServerHttpRequest.Builder	headers(Consumer<HttpHeaders> headersConsumer) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.headers. Manipulate request headers.
public ServerHttpRequest.Builder	method(HttpMethod httpMethod) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.method. Set the HTTP method to return.
public ServerHttpRequest.Builder	path(String path) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.path. Set the path to use instead of the `"rawPath"` of the URI of the request with the following conditions: If `uri` is also set, the path given here overrides the path of the given URI. If `contextPath` is also set, or already present, it must match the start of the path given here. The given value must begin with a slash.
public ServerHttpRequest.Builder	remoteAddress(InetSocketAddress remoteAddress) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.remoteAddress. Set the address of the remote client.
public ServerHttpRequest.Builder	sslInfo(SslInfo sslInfo) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.sslInfo. Set the SSL session information.
public ServerHttpRequest.Builder	uri(URI uri) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.uri. Set the URI to use with the following conditions: If `path` is also set, it overrides the path of the URI provided here. If `contextPath` is also set, or already present, it must match the start of the path of the URI provided here.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

body	back to summary
private final Flux<DataBuffer> body

contextPath	back to summary
private String contextPath Annotations @Nullable

headers	back to summary
private final HttpHeaders headers

httpMethod	back to summary
private HttpMethod httpMethod

originalRequest	back to summary
private final ServerHttpRequest originalRequest

remoteAddress	back to summary
private InetSocketAddress remoteAddress Annotations @Nullable

sslInfo	back to summary
private SslInfo sslInfo Annotations @Nullable

uri	back to summary
private URI uri

uriPath	back to summary
private String uriPath Annotations @Nullable

DefaultServerHttpRequestBuilder	back to summary
public DefaultServerHttpRequestBuilder(ServerHttpRequest original)

Method Detail

build back to summary

build	back to summary
public ServerHttpRequest build() Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.build. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.build. Build a `ServerHttpRequest` decorator with the mutated properties. Annotations @Override

public ServerHttpRequest build()

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.build.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.build.

Build a ServerHttpRequest decorator with the mutated properties.

Annotations

@Override

contextPath back to summary

contextPath	back to summary
public ServerHttpRequest.Builder contextPath(String contextPath) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.contextPath. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.contextPath. Set the contextPath to use. The given value must be a valid `contextPath` and it must match the start of the path of the URI of the request. That means changing the contextPath, implies also changing the path via `path(String)`. Annotations @Override

public ServerHttpRequest.Builder contextPath(String contextPath)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.contextPath.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.contextPath.

Set the contextPath to use.

The given value must be a valid contextPath and it must match the start of the path of the URI of the request. That means changing the contextPath, implies also changing the path via path(String).

Annotations

@Override

getUriToUse	back to summary
private URI getUriToUse()

header back to summary

header	back to summary
public ServerHttpRequest.Builder header(String headerName, String... headerValues) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.header. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.header. Set or override the specified header values under the given name. If you need to add header values, remove headers, etc., use `headers(Consumer)` for greater control. Parameters headerName:String the header name headerValues:String[] the header values Annotations @Override

public ServerHttpRequest.Builder header(String headerName, String... headerValues)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.header.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.header.

Set or override the specified header values under the given name.

If you need to add header values, remove headers, etc., use headers(Consumer) for greater control.

Parameters

headerName:String: the header name
headerValues:String[]: the header values

Annotations

@Override

headers back to summary

headers	back to summary
public ServerHttpRequest.Builder headers(Consumer<HttpHeaders> headersConsumer) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.headers. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.headers. Manipulate request headers. The provided `HttpHeaders` contains current request headers, so that the `Consumer` can overwrite or remove existing values, or use any other `HttpHeaders` methods. Annotations @Override

public ServerHttpRequest.Builder headers(Consumer<HttpHeaders> headersConsumer)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.headers.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.headers.

Manipulate request headers. The provided HttpHeaders contains current request headers, so that the Consumer can overwrite or remove existing values, or use any other HttpHeaders methods.

Annotations

@Override

method	back to summary
public ServerHttpRequest.Builder method(HttpMethod httpMethod) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.method. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.method. Set the HTTP method to return. Annotations @Override

method

back to summary

public ServerHttpRequest.Builder method(HttpMethod httpMethod)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.method.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.method.

Set the HTTP method to return.

Annotations

@Override

path back to summary

path	back to summary
public ServerHttpRequest.Builder path(String path) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.path. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.path. Set the path to use instead of the `"rawPath"` of the URI of the request with the following conditions: If `uri` is also set, the path given here overrides the path of the given URI. If `contextPath` is also set, or already present, it must match the start of the path given here. The given value must begin with a slash. Annotations @Override

public ServerHttpRequest.Builder path(String path)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.path.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.path.

Set the path to use instead of the "rawPath" of the URI of the request with the following conditions:

If uri is also set, the path given here overrides the path of the given URI.
If contextPath is also set, or already present, it must match the start of the path given here.
The given value must begin with a slash.

Annotations

@Override

remoteAddress	back to summary
public ServerHttpRequest.Builder remoteAddress(InetSocketAddress remoteAddress) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.remoteAddress. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.remoteAddress. Set the address of the remote client. Annotations @Override

remoteAddress

back to summary

public ServerHttpRequest.Builder remoteAddress(InetSocketAddress remoteAddress)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.remoteAddress.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.remoteAddress.

Set the address of the remote client.

Annotations

@Override

sslInfo	back to summary
public ServerHttpRequest.Builder sslInfo(SslInfo sslInfo) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.sslInfo. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.sslInfo. Set the SSL session information. This may be useful in environments where TLS termination is done at the router, but SSL information is made available in some other way such as through a header. Annotations @Override

sslInfo

back to summary

public ServerHttpRequest.Builder sslInfo(SslInfo sslInfo)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.sslInfo.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.sslInfo.

Set the SSL session information. This may be useful in environments where TLS termination is done at the router, but SSL information is made available in some other way such as through a header.

Annotations

@Override

uri back to summary

uri	back to summary
public ServerHttpRequest.Builder uri(URI uri) Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.uri. Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.uri. Set the URI to use with the following conditions: If `path` is also set, it overrides the path of the URI provided here. If `contextPath` is also set, or already present, it must match the start of the path of the URI provided here. Annotations @Override

public ServerHttpRequest.Builder uri(URI uri)

Implements org.springframework.http.server.reactive.ServerHttpRequest.Builder.uri.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.Builder.uri.

Set the URI to use with the following conditions:

If path is also set, it overrides the path of the URI provided here.
If contextPath is also set, or already present, it must match the start of the path of the URI provided here.

Annotations

@Override

org.springframework.http.server.reactive back to summary

private Class DefaultServerHttpRequestBuilder.MutatedServerHttpRequest

Class Inheritance

extends AbstractServerHttpRequest

java.lang.Object
org.springframework.http.server.reactive.AbstractServerHttpRequest
org.springframework.http.server.reactive.DefaultServerHttpRequestBuilder.MutatedServerHttpRequest

Field Summary

Modifier and Type	Field and Description
private final Flux<DataBuffer>	body
private final ServerHttpRequest	originalRequest
private final InetSocketAddress	remoteAddress
private final SslInfo	sslInfo Hides org.springframework.http.server.reactive.AbstractServerHttpRequest.sslInfo.

Constructor Summary

Access	Constructor and Description
public	MutatedServerHttpRequest(URI uri, String contextPath, HttpMethod method, SslInfo sslInfo, InetSocketAddress remoteAddress, HttpHeaders headers, Flux<DataBuffer> body, ServerHttpRequest originalRequest)

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	getBody() Implements org.springframework.http.ReactiveHttpInputMessage.getBody. Return the body of the message as a `Publisher`.
public String	getId() Overrides org.springframework.http.server.reactive.AbstractServerHttpRequest.getId. Implements org.springframework.http.server.reactive.ServerHttpRequest.getId. Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.
public InetSocketAddress	getLocalAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Return the local address the request was accepted on, if available.
public <T> T	getNativeRequest() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.getNativeRequest. Return the underlying server response.
public InetSocketAddress	getRemoteAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Return the remote address where this request is connected to, if available.
protected MultiValueMap<String, HttpCookie>	initCookies() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.initCookies. Obtain the cookies from the underlying "native" request and adapt those to an `HttpCookie` map.
protected SslInfo	initSslInfo() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.initSslInfo. Obtain SSL session information from the underlying "native" request.

Inherited from org.springframework.http.server.reactive.AbstractServerHttpRequest:: getCookies getHeaders getLogPrefix getMethod getPath getQueryParams getSslInfo getURI initId initLogPrefix initQueryParams

Field Detail

body	back to summary
private final Flux<DataBuffer> body

originalRequest	back to summary
private final ServerHttpRequest originalRequest

remoteAddress	back to summary
private final InetSocketAddress remoteAddress Annotations @Nullable

sslInfo	back to summary
private final SslInfo sslInfo Hides org.springframework.http.server.reactive.AbstractServerHttpRequest.sslInfo. Annotations @Nullable

Constructor Detail

MutatedServerHttpRequest	back to summary
public MutatedServerHttpRequest(URI uri, String contextPath, HttpMethod method, SslInfo sslInfo, InetSocketAddress remoteAddress, HttpHeaders headers, Flux<DataBuffer> body, ServerHttpRequest originalRequest)

Method Detail

getBody back to summary

getBody	back to summary
public Flux<DataBuffer> getBody() Implements org.springframework.http.ReactiveHttpInputMessage.getBody. Doc from org.springframework.http.ReactiveHttpInputMessage.getBody. Return the body of the message as a `Publisher`. Returns:Flux<DataBuffer> the body content publisher Annotations @Override

public Flux<DataBuffer> getBody()

Implements org.springframework.http.ReactiveHttpInputMessage.getBody.

Doc from org.springframework.http.ReactiveHttpInputMessage.getBody.

Return the body of the message as a Publisher.

Returns:Flux<DataBuffer>

the body content publisher

Annotations

@Override

getId	back to summary
public String getId() Overrides org.springframework.http.server.reactive.AbstractServerHttpRequest.getId. Implements org.springframework.http.server.reactive.ServerHttpRequest.getId. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getId. Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages. Annotations @Override

getId

back to summary

public String getId()

Overrides org.springframework.http.server.reactive.AbstractServerHttpRequest.getId.

Implements org.springframework.http.server.reactive.ServerHttpRequest.getId.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getId.

Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.

Annotations

@Override

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Return the local address the request was accepted on, if available. Annotations @Override @Nullable

getLocalAddress

back to summary

public InetSocketAddress getLocalAddress()

Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress.

Return the local address the request was accepted on, if available.

Annotations

@Override
@Nullable

getNativeRequest	back to summary
public <T> T getNativeRequest() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.getNativeRequest. Doc from org.springframework.http.server.reactive.AbstractServerHttpRequest.getNativeRequest. Return the underlying server response. Note This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module. Annotations @SuppressWarnings:unchecked @Override

getNativeRequest

back to summary

public <T> T getNativeRequest()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.getNativeRequest.

Doc from org.springframework.http.server.reactive.AbstractServerHttpRequest.getNativeRequest.

Return the underlying server response.

Note

This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module.

Annotations

@SuppressWarnings:unchecked
@Override

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Return the remote address where this request is connected to, if available. Annotations @Override @Nullable

getRemoteAddress

back to summary

public InetSocketAddress getRemoteAddress()

Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress.

Return the remote address where this request is connected to, if available.

Annotations

@Override
@Nullable

initCookies back to summary

protected MultiValueMap<String, HttpCookie> initCookies()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.initCookies.

Doc from org.springframework.http.server.reactive.AbstractServerHttpRequest.initCookies.

Obtain the cookies from the underlying "native" request and adapt those to an HttpCookie map. The return value is turned into an immutable map and cached.

Note that this method is invoked lazily on access to getCookies(). Subclasses should synchronize cookie initialization if the underlying "native" request does not provide thread-safe access to cookie data.

Annotations

@Override

initSslInfo back to summary

initSslInfo	back to summary
protected SslInfo initSslInfo() Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.initSslInfo. Doc from org.springframework.http.server.reactive.AbstractServerHttpRequest.initSslInfo. Obtain SSL session information from the underlying "native" request. Returns:SslInfo the session information, or `null` if none available Annotations @Override @Nullable

protected SslInfo initSslInfo()

Implements abstract org.springframework.http.server.reactive.AbstractServerHttpRequest.initSslInfo.

Doc from org.springframework.http.server.reactive.AbstractServerHttpRequest.initSslInfo.

Obtain SSL session information from the underlying "native" request.

Returns:SslInfo

the session information, or null if none available

Annotations

@Override
@Nullable

pack-priv Class DefaultServerHttpRequestBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultServerHttpRequestBuilder.MutatedServerHttpRequest

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Flux<DataBuffer>	body
private String	contextPath
private final HttpHeaders	headers
private HttpMethod	httpMethod
private final ServerHttpRequest	originalRequest
private InetSocketAddress	remoteAddress
private SslInfo	sslInfo
private URI	uri
private String	uriPath