Package org.springframework.web.service.invoker

Class HttpRequestValues.Builder

java.lang.Object

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

Direct Known Subclasses:

ReactiveHttpRequestValues.Builder

Enclosing class:

HttpRequestValues

public static class HttpRequestValues.Builder
extends Object

Builder for HttpRequestValues.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpRequestValues.Builder	addAttribute(String name, Object value)	Configure an attribute to associate with the request.
HttpRequestValues.Builder	addCookie(String name, String... values)	Add the given cookie name and values.
HttpRequestValues.Builder	addHeader(String headerName, String... headerValues)	Add the given header name and values.
HttpRequestValues.Builder	addRequestParameter(String name, String... values)	Add the given request parameter name and values.
HttpRequestValues.Builder	addRequestPart(String name, Object part)	Add a part for a multipart request.
<T, P extends Publisher<T>> HttpRequestValues.Builder	addRequestPart(String name, P publisher, ResolvableType type)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of ReactiveHttpRequestValues.Builder.addRequestPartPublisher(java.lang.String, P, org.springframework.core.ParameterizedTypeReference<T>); to be removed in 6.2
HttpRequestValues	build()	Build the HttpRequestValues instance.
protected Object	buildMultipartBody()
protected HttpRequestValues	createRequestValues(HttpMethod httpMethod, URI uri, String uriTemplate, Map<String,String> uriVars, HttpHeaders headers, MultiValueMap<String,String> cookies, Map<String,Object> attributes, Object bodyValue)	Deprecated, for removal: This API element is subject to removal in a future version. in favour of createRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map, HttpHeaders, MultiValueMap, Map, Object) to be removed in 6.2.
protected HttpRequestValues	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)	Create HttpRequestValues from values passed to the HttpRequestValues.Builder.
protected boolean	hasBody()
protected boolean	hasParts()
HttpRequestValues.Builder	setAccept(List<MediaType> acceptableMediaTypes)	Set the media types for the request Accept header.
<T, P extends Publisher<T>> void	setBody(P body, ParameterizedTypeReference<T> elementTye)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of ReactiveHttpRequestValues.Builder.setBodyPublisher(P, org.springframework.core.ParameterizedTypeReference<T>); to be removed in 6.2
void	setBodyValue(Object bodyValue)	Set the request body as an Object to be serialized.
HttpRequestValues.Builder	setContentType(MediaType contentType)	Set the media type for the request Content-Type header.
HttpRequestValues.Builder	setHttpMethod(HttpMethod httpMethod)	Set the HTTP method for the request.
HttpRequestValues.Builder	setUri(URI uri)	Set the URL to use.
HttpRequestValues.Builder	setUriBuilderFactory(UriBuilderFactory uriBuilderFactory)	Set the UriBuilderFactory that will be used to expand the HttpRequestValues.getUriTemplate().
HttpRequestValues.Builder	setUriTemplate(String uriTemplate)	Set the request URL as a String template.
HttpRequestValues.Builder	setUriVariable(String name, String value)	Add a URI variable name-value pair.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setHttpMethod

public HttpRequestValues.Builder setHttpMethod(HttpMethod httpMethod)

Set the HTTP method for the request.

setUri

public HttpRequestValues.Builder setUri(URI uri)

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

setUriBuilderFactory

public HttpRequestValues.Builder setUriBuilderFactory(@Nullable
 UriBuilderFactory uriBuilderFactory)

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

Since:

6.1

setUriTemplate

public HttpRequestValues.Builder setUriTemplate(String uriTemplate)

Set the request URL as a String template.

setUriVariable

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

Add a URI variable name-value pair.

setAccept

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

Set the media types for the request Accept header.

setContentType

public HttpRequestValues.Builder setContentType(MediaType contentType)

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

addHeader

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

Add the given header name and values.

addCookie

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

Add the given cookie name and values.

addRequestParameter

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

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.

addRequestPart

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

Add a part for a multipart request. The part may be:

• String -- form field
• Resource -- file part
• Object -- content to be encoded (e.g. to JSON)
• HttpEntity -- part content and headers although generally it's easier to add headers through the returned builder

addRequestPart

@Deprecated(since="6.1",
            forRemoval=true)
public <T,
P extends Publisher<T>>
HttpRequestValues.Builder addRequestPart(String name,
 P publisher,
 ResolvableType type)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of ReactiveHttpRequestValues.Builder.addRequestPartPublisher(java.lang.String, P, org.springframework.core.ParameterizedTypeReference<T>); to be removed in 6.2

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

addAttribute

public HttpRequestValues.Builder addAttribute(String name,
 Object value)

Configure an attribute to associate with the request.

Parameters:

name - the attribute name

value - the attribute value

setBodyValue

public void setBodyValue(Object bodyValue)

Set the request body as an Object to be serialized.

setBody

@Deprecated(since="6.1",
            forRemoval=true)
public <T,
P extends Publisher<T>> void setBody(P body,
 ParameterizedTypeReference<T> elementTye)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of ReactiveHttpRequestValues.Builder.setBodyPublisher(P, org.springframework.core.ParameterizedTypeReference<T>); to be removed in 6.2

Set the request body as a Reactive Streams Publisher.

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

build

public HttpRequestValues build()

Build the HttpRequestValues instance.

hasParts

protected boolean hasParts()

hasBody

protected boolean hasBody()

buildMultipartBody

protected Object buildMultipartBody()

createRequestValues

@Deprecated(since="6.1",
            forRemoval=true)
protected HttpRequestValues createRequestValues(@Nullable
 HttpMethod httpMethod,
 @Nullable
 URI uri,
 @Nullable
 String uriTemplate,
 Map<String,String> uriVars,
 HttpHeaders headers,
 MultiValueMap<String,String> cookies,
 Map<String,Object> attributes,
 @Nullable
 Object bodyValue)

Deprecated, for removal: This API element is subject to removal in a future version.

in favour of createRequestValues(HttpMethod, URI, UriBuilderFactory, String, Map, HttpHeaders, MultiValueMap, Map, Object) to be removed in 6.2.

Create HttpRequestValues from values passed to the HttpRequestValues.Builder.

createRequestValues

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

Create HttpRequestValues from values passed to the HttpRequestValues.Builder.

Since:

6.1