Class HttpRequestValues

java.lang.Object

org.springframework.web.service.invoker.HttpRequestValues

Direct Known Subclasses:

ReactiveHttpRequestValues

public class HttpRequestValues
extends Object

Container for HTTP request values extracted from an @HttpExchange-annotated method and argument values passed to it. This is then given to HttpExchangeAdapter to adapt to the underlying HTTP client.

Since:

6.0

Author:

Rossen Stoyanchev, Olga Maciaszek-Sharma

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRequestValues.Builder	Builder for HttpRequestValues.
static interface	HttpRequestValues.Metadata	Expose static metadata from @HttpExchange annotation attributes.
static interface	HttpRequestValues.Processor	A contract that allows further customization of HttpRequestValues in addition to those added by argument resolvers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpRequestValues(@Nullable HttpMethod httpMethod, @Nullable URI uri, @Nullable UriBuilderFactory uriBuilderFactory, @Nullable String uriTemplate, Map<String,String> uriVariables, HttpHeaders headers, MultiValueMap<String,String> cookies, @Nullable Object version, Map<String,Object> attributes, @Nullable Object bodyValue, @Nullable ParameterizedTypeReference<?> bodyValueType)	Construct HttpRequestValues.

Method Summary

Modifier and Type	Method	Description
static HttpRequestValues.Builder	builder()	Return a builder for HttpRequestValues.
@Nullable Object	getApiVersion()
Map<String,Object>	getAttributes()	Return the attributes associated with the request, or an empty map.
@Nullable Object	getBodyValue()	Return the request body as a value to be serialized, if set.
@Nullable ParameterizedTypeReference<?>	getBodyValueType()	Return the type for the body value.
MultiValueMap<String,String>	getCookies()	Return the cookies for the request, or an empty map.
HttpHeaders	getHeaders()	Return the headers for the request, if any.
@Nullable HttpMethod	getHttpMethod()	Return the HTTP method to use for the request.
@Nullable URI	getUri()	Return the URL to use.
@Nullable UriBuilderFactory	getUriBuilderFactory()	Return the UriBuilderFactory to expand the uriTemplate and getUriVariables() with.
@Nullable String	getUriTemplate()	Return the URL template for the request.
Map<String,String>	getUriVariables()	Return the URL template variables, or an empty map.

Methods inherited from class Object

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

Constructor Details

HttpRequestValues

protected HttpRequestValues(@Nullable HttpMethod httpMethod,
 @Nullable URI uri,
 @Nullable UriBuilderFactory uriBuilderFactory,
 @Nullable String uriTemplate,
 Map<String,String> uriVariables,
 HttpHeaders headers,
 MultiValueMap<String,String> cookies,
 @Nullable Object version,
 Map<String,Object> attributes,
 @Nullable Object bodyValue,
 @Nullable ParameterizedTypeReference<?> bodyValueType)

Construct HttpRequestValues.

Since:

7.0

Method Details

getHttpMethod

public @Nullable HttpMethod getHttpMethod()

Return the HTTP method to use for the request.

getUri

public @Nullable URI getUri()

Return the URL to use.

Typically, this comes from a URI method argument, which provides the caller with the option to override the uriTemplate from class and method HttpExchange annotations.

getUriBuilderFactory

public @Nullable UriBuilderFactory getUriBuilderFactory()

Return the UriBuilderFactory to expand the uriTemplate and getUriVariables() with.

The UriBuilderFactory is passed into the HTTP Service client method in order to override the UriBuilderFactory (and its baseUrl) used by the underlying client.

Since:

6.1

getUriTemplate

public @Nullable String getUriTemplate()

Return the URL template for the request. This comes from the values in class and method HttpExchange annotations.

getUriVariables

public Map<String,String> getUriVariables()

Return the URL template variables, or an empty map.

getHeaders

public HttpHeaders getHeaders()

Return the headers for the request, if any.

getCookies

public MultiValueMap<String,String> getCookies()

Return the cookies for the request, or an empty map.

getApiVersion

public @Nullable Object getApiVersion()

getAttributes

public Map<String,Object> getAttributes()

Return the attributes associated with the request, or an empty map.

getBodyValue

public @Nullable Object getBodyValue()

Return the request body as a value to be serialized, if set.

getBodyValueType

public @Nullable ParameterizedTypeReference<?> getBodyValueType()

Return the type for the body value.

Since:

6.2.7

builder

public static HttpRequestValues.Builder builder()

Return a builder for HttpRequestValues.