Top Description Inners Fields Constructors Methods
org.springframework.web.service.invoker

public final Class ReactiveHttpRequestValues

extends HttpRequestValues
Class Inheritance
Imports
java.net.URI, java.util.List, .Map, org.reactivestreams.Publisher, org.springframework.core.ParameterizedTypeReference, .ResolvableType, org.springframework.http.HttpHeaders, .HttpMethod, .MediaType, org.springframework.http.client.MultipartBodyBuilder, org.springframework.lang.Nullable, org.springframework.util.Assert, .MultiValueMap, org.springframework.web.util.UriBuilderFactory
HttpRequestValues extension for use with ReactorHttpExchangeAdapter.
Authors
Rossen Stoyanchev, Olga Maciaszek-Sharma
Since
6.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ReactiveHttpRequestValues.Builder

Builder for ReactiveHttpRequestValues.

Field Summary

Modifier and TypeField and Description
private final Publisher<?>
body

private final ParameterizedTypeReference<?>
bodyElementType

Constructor Summary

AccessConstructor and Description
private
ReactiveHttpRequestValues(HttpMethod httpMethod, URI uri, UriBuilderFactory uriBuilderFactory, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue, Publisher<?> body, ParameterizedTypeReference<?> elementType)

Method Summary

Modifier and TypeMethod and Description
public static ReactiveHttpRequestValues.Builder
builder()

Hides org.springframework.web.service.invoker.HttpRequestValues.builder.

public Publisher<?>
getBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.getBody.

Return the request body as a Publisher.

public ParameterizedTypeReference<?>
getBodyElementType()

Overrides org.springframework.web.service.invoker.HttpRequestValues.getBodyElementType.

Return the element type for a Publisher body.

public Publisher<?>
getBodyPublisher()

Return a Publisher that will produce for the request body.

public ParameterizedTypeReference<?>
getBodyPublisherElementType()

Return the element type for a Publisher body.

Inherited from org.springframework.web.service.invoker.HttpRequestValues:
getAttributesgetBodyValuegetCookiesgetHeadersgetHttpMethodgetUrigetUriBuilderFactorygetUriTemplategetUriVariables

Field Detail

bodyback to summary
private final Publisher<?> body
Annotations
@Nullable
bodyElementTypeback to summary
private final ParameterizedTypeReference<?> bodyElementType
Annotations
@Nullable

Constructor Detail

ReactiveHttpRequestValuesback to summary
private ReactiveHttpRequestValues(HttpMethod httpMethod, URI uri, UriBuilderFactory uriBuilderFactory, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue, Publisher<?> body, ParameterizedTypeReference<?> elementType)

Method Detail

builderback to summary
public static ReactiveHttpRequestValues.Builder builder()

Hides org.springframework.web.service.invoker.HttpRequestValues.builder.

getBodyback to summary
public Publisher<?> getBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.getBody.

Return the request body as a Publisher.

This is mutually exclusive with getBodyValue(). Only one of the two or neither is set.

Annotations
@SuppressWarnings:removal
@Nullable
getBodyElementTypeback to summary
public ParameterizedTypeReference<?> getBodyElementType()

Overrides org.springframework.web.service.invoker.HttpRequestValues.getBodyElementType.

Return the element type for a Publisher body.

Annotations
@SuppressWarnings:removal
@Nullable
getBodyPublisherback to summary
public Publisher<?> getBodyPublisher()

Return a Publisher that will produce for the request body.

This is mutually exclusive with getBodyValue(). Only one of the two or neither is set.

Annotations
@Nullable
getBodyPublisherElementTypeback to summary
public ParameterizedTypeReference<?> getBodyPublisherElementType()

Return the element type for a Publisher body.

Annotations
@Nullable
org.springframework.web.service.invoker back to summary

public final Class ReactiveHttpRequestValues.Builder

extends Builder
Class Inheritance
Builder for ReactiveHttpRequestValues.

Field Summary

Modifier and TypeField and Description
private Publisher<?>
body

private ParameterizedTypeReference<?>
bodyElementType

private MultipartBodyBuilder
multipartBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public ReactiveHttpRequestValues.Builder
addAttribute(String
the attribute name
name, Object
the attribute value
value)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addAttribute.

Configure an attribute to associate with the request.

public ReactiveHttpRequestValues.Builder
addCookie(String name, String... values)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addCookie.

Add the given cookie name and values.

public ReactiveHttpRequestValues.Builder
addHeader(String headerName, String... headerValues)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addHeader.

Add the given header name and values.

public ReactiveHttpRequestValues.Builder
addRequestParameter(String name, String... values)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestParameter.

Add the given request parameter name and values.

public ReactiveHttpRequestValues.Builder
addRequestPart(String name, Object part)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestPart.

Add a part to a multipart request.

public <T, P extends Publisher<T>> ReactiveHttpRequestValues.Builder
addRequestPart(String name, P publisher, ResolvableType type)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestPart.

Variant of addRequestPart(String, Object) that allows the part value to be produced by a Publisher.

public <T, P extends Publisher<T>> ReactiveHttpRequestValues.Builder
addRequestPartPublisher(String name, P publisher, ParameterizedTypeReference<T> elementTye)

Variant of addRequestPart(String, Object) that allows the part value to be produced by a Publisher.

public ReactiveHttpRequestValues
build()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.build.

Build the HttpRequestValues instance.

protected Object
buildMultipartBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.buildMultipartBody.

protected ReactiveHttpRequestValues
createRequestValues(HttpMethod httpMethod, URI uri, UriBuilderFactory uriBuilderFactory, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.createRequestValues.

Create HttpRequestValues from values passed to the Builder.

protected boolean
hasBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.hasBody.

protected boolean
hasParts()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.hasParts.

public ReactiveHttpRequestValues.Builder
setAccept(List<MediaType> acceptableMediaTypes)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setAccept.

Set the media types for the request Accept header.

public <T, P extends Publisher<T>> void
setBody(P body, ParameterizedTypeReference<T> elementTye)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setBody.

Set the request body as a Reactive Streams Publisher.

public <T, P extends Publisher<T>> void
setBodyPublisher(P body, ParameterizedTypeReference<T> elementTye)

Set the request body as a Reactive Streams Publisher.

public void
setBodyValue(Object bodyValue)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setBodyValue.

Set the request body as an Object to be serialized.

public ReactiveHttpRequestValues.Builder
setContentType(MediaType contentType)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setContentType.

Set the media type for the request Content-Type header.

public ReactiveHttpRequestValues.Builder
setHttpMethod(HttpMethod httpMethod)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setHttpMethod.

Set the HTTP method for the request.

public ReactiveHttpRequestValues.Builder
setUri(URI uri)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUri.

Set the URL to use.

public ReactiveHttpRequestValues.Builder
setUriBuilderFactory(UriBuilderFactory uriBuilderFactory)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriBuilderFactory.

Set the UriBuilderFactory that will be used to expand the getUriTemplate().

public ReactiveHttpRequestValues.Builder
setUriTemplate(String uriTemplate)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriTemplate.

Set the request URL as a String template.

public ReactiveHttpRequestValues.Builder
setUriVariable(String name, String value)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriVariable.

Add a URI variable name-value pair.

Inherited from org.springframework.web.service.invoker.HttpRequestValues.Builder:
createRequestValues

Field Detail

bodyback to summary
private Publisher<?> body
Annotations
@Nullable
bodyElementTypeback to summary
private ParameterizedTypeReference<?> bodyElementType
Annotations
@Nullable
multipartBuilderback to summary
private MultipartBodyBuilder multipartBuilder
Annotations
@Nullable

Constructor Detail

Builderback to summary
public Builder()

Method Detail

addAttributeback to summary
public ReactiveHttpRequestValues.Builder addAttribute(String name, Object value)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addAttribute.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.addAttribute.

Configure an attribute to associate with the request.

Parameters
name:String

the attribute name

value:Object

the attribute value

Annotations
@Override
addCookieback to summary
public ReactiveHttpRequestValues.Builder addCookie(String name, String... values)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addCookie.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.addCookie.

Add the given cookie name and values.

Annotations
@Override
addHeaderback to summary
public ReactiveHttpRequestValues.Builder addHeader(String headerName, String... headerValues)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addHeader.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.addHeader.

Add the given header name and values.

Annotations
@Override
addRequestParameterback to summary
public ReactiveHttpRequestValues.Builder addRequestParameter(String name, String... values)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestParameter.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestParameter.

Add the given request parameter name and values.

When "content-type" is set to "application/x-www-form-urlencoded", request parameters are encoded in the request body. Otherwise, they are added as URL query parameters.

Annotations
@Override
addRequestPartback to summary
public ReactiveHttpRequestValues.Builder addRequestPart(String name, Object part)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestPart.

Add a part to a multipart request. The part value may be as described in MultipartBodyBuilder#part(String, Object).

Annotations
@Override
addRequestPartback to summary
public <T, P extends Publisher<T>> ReactiveHttpRequestValues.Builder addRequestPart(String name, P publisher, ResolvableType type)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestPart.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.addRequestPart.

Variant of addRequestPart(String, Object) that allows the part value to be produced by a Publisher.

Annotations
@SuppressWarnings:removal
@Override
addRequestPartPublisherback to summary
public <T, P extends Publisher<T>> ReactiveHttpRequestValues.Builder addRequestPartPublisher(String name, P publisher, ParameterizedTypeReference<T> elementTye)

Variant of addRequestPart(String, Object) that allows the part value to be produced by a Publisher.

buildback to summary
public ReactiveHttpRequestValues build()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.build.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.build.

Build the HttpRequestValues instance.

Annotations
@Override
buildMultipartBodyback to summary
protected Object buildMultipartBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.buildMultipartBody.

Annotations
@Override
createRequestValuesback to summary
protected ReactiveHttpRequestValues createRequestValues(HttpMethod httpMethod, URI uri, UriBuilderFactory uriBuilderFactory, String uriTemplate, Map<String, String> uriVars, HttpHeaders headers, MultiValueMap<String, String> cookies, Map<String, Object> attributes, Object bodyValue)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.createRequestValues.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.createRequestValues.

Create HttpRequestValues from values passed to the Builder.

Annotations
@Override
hasBodyback to summary
protected boolean hasBody()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.hasBody.

Annotations
@Override
hasPartsback to summary
protected boolean hasParts()

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.hasParts.

Annotations
@Override
setAcceptback to summary
public ReactiveHttpRequestValues.Builder setAccept(List<MediaType> acceptableMediaTypes)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setAccept.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setAccept.

Set the media types for the request Accept header.

Annotations
@Override
setBodyback to summary
public <T, P extends Publisher<T>> void setBody(P body, ParameterizedTypeReference<T> elementTye)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setBody.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setBody.

Set the request body as a Reactive Streams Publisher.

This is mutually exclusive with, and resets any previously set body value.

Annotations
@SuppressWarnings:removal
@Override
setBodyPublisherback to summary
public <T, P extends Publisher<T>> void setBodyPublisher(P body, ParameterizedTypeReference<T> elementTye)

Set the request body as a Reactive Streams Publisher.

This is mutually exclusive with, and resets any previously set body value.

Annotations
@SuppressWarnings:DataFlowIssue
setBodyValueback to summary
public void setBodyValue(Object bodyValue)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setBodyValue.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setBodyValue.

Set the request body as an Object to be serialized.

This is mutually exclusive with, and resets any previously set setBodyPublisher(Publisher, ParameterizedTypeReference).

Annotations
@Override
setContentTypeback to summary
public ReactiveHttpRequestValues.Builder setContentType(MediaType contentType)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setContentType.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setContentType.

Set the media type for the request Content-Type header.

Annotations
@Override
setHttpMethodback to summary
public ReactiveHttpRequestValues.Builder setHttpMethod(HttpMethod httpMethod)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setHttpMethod.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setHttpMethod.

Set the HTTP method for the request.

Annotations
@Override
setUriback to summary
public ReactiveHttpRequestValues.Builder setUri(URI uri)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUri.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setUri.

Set the URL to use. When set, this overrides the URI template from the HttpExchange annotation.

Annotations
@Override
setUriBuilderFactoryback to summary
public ReactiveHttpRequestValues.Builder setUriBuilderFactory(UriBuilderFactory uriBuilderFactory)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriBuilderFactory.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriBuilderFactory.

Set the UriBuilderFactory that will be used to expand the getUriTemplate().

Annotations
@Override
setUriTemplateback to summary
public ReactiveHttpRequestValues.Builder setUriTemplate(String uriTemplate)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriTemplate.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriTemplate.

Set the request URL as a String template.

Annotations
@Override
setUriVariableback to summary
public ReactiveHttpRequestValues.Builder setUriVariable(String name, String value)

Overrides org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriVariable.

Doc from org.springframework.web.service.invoker.HttpRequestValues.Builder.setUriVariable.

Add a URI variable name-value pair.

Annotations
@Override