Package org.springframework.web.service.invoker

Class HttpRequestValues.Builder

java.lang.Object

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

Enclosing class:

HttpRequestValues

public static final 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 to a multipart request.
<T, P extends Publisher<T>> HttpRequestValues.Builder	addRequestPart(String name, P publisher, ResolvableType type)	Variant of addRequestPart(String, Object) that allows the part value to be produced by a Publisher.
HttpRequestValues	build()	Build the HttpRequestValues instance.
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)	Set the request body as a concrete value to be serialized.
void	setBodyValue(Object bodyValue)	Set the request body as a concrete value 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 request URL as a full URL.
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 request URL as a full URL.

This is mutually exclusive with, and resets any previously set URI template or URI variables.

setUriTemplate

public HttpRequestValues.Builder setUriTemplate(String uriTemplate)

Set the request URL as a String template.

This is mutually exclusive with, and resets any previously set full URI.

setUriVariable

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

Add a URI variable name-value pair.

This is mutually exclusive with, and resets any previously set full URI.

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 to a multipart request. The part value may be as described in MultipartBodyBuilder.part(String, Object).

addRequestPart

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

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 a concrete value to be serialized.

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

setBody

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

Set the request body as a concrete value to be serialized.

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

build

public HttpRequestValues build()

Build the HttpRequestValues instance.