Uses of Interface
org.springframework.http.converter.HttpMessageConverter
Package
Description
Provides an HttpMessageConverter abstraction to convert between Java objects and HTTP input/output messages.
Provides an HttpMessageConverter for the CBOR data format.
Provides HttpMessageConverter implementations for handling Atom and RSS feeds.
Provides HttpMessageConverter implementations for handling JSON.
Provides an HttpMessageConverter implementation for handling
Google Protocol Buffers.
Provides an HttpMessageConverter for the Smile data format ("binary JSON").
Provides a comprehensive HttpMessageConverter variant for form handling.
Provides HttpMessageConverter implementations for handling XML.
Provides an
HttpMessageConverter
for the YAML data format.Test support for HTTP concepts.
AssertJ support for MockMvc.
Support for testing Spring MVC applications via
WebTestClient
with MockMvc
for server request
handling.Contains built-in
MockMvcBuilder
implementations.Core package of the client-side web support.
Annotation-based setup for Spring MVC.
Provides the types that make up Spring's functional web framework for Servlet environments.
Classes supporting the
org.springframework.web.servlet.function
package.MVC infrastructure for annotation-based handler method processing, building on the
org.springframework.web.method.annotation
package.-
Uses of HttpMessageConverter in org.springframework.http.converter
Modifier and TypeInterfaceDescriptioninterface
A specialization ofHttpMessageConverter
that can convert an HTTP request into a target object of a specified generic type and a source object of a specified generic type into an HTTP response.interface
A specialization ofHttpMessageConverter
that can convert an HTTP request into a target object of a specifiedResolvableType
and a source object of a specifiedResolvableType
into an HTTP response with optional hints.Modifier and TypeClassDescriptionclass
Abstract base class for mostGenericHttpMessageConverter
implementations.class
Abstract base class for mostHttpMessageConverter
implementations.class
AbstractKotlinSerializationHttpMessageConverter<T extends kotlinx.serialization.SerialFormat>
Abstract base class forHttpMessageConverter
implementations that use Kotlin serialization.class
Abstract base class for mostSmartHttpMessageConverter
implementations.class
Implementation ofHttpMessageConverter
that can read and writeBufferedImages
.class
Implementation ofHttpMessageConverter
that can read and write byte arrays.class
Implementation ofHttpMessageConverter
to read and write 'normal' HTML forms and also to write (but not read) multipart data (for example, file uploads).class
KotlinSerializationBinaryHttpMessageConverter<T extends kotlinx.serialization.BinaryFormat>
Abstract base class forHttpMessageConverter
implementations that defer to Kotlin binary serializers.class
KotlinSerializationStringHttpMessageConverter<T extends kotlinx.serialization.StringFormat>
Abstract base class forHttpMessageConverter
implementations that defer to Kotlin string serializers.class
AnHttpMessageConverter
that usesStringHttpMessageConverter
for reading and writing content and aConversionService
for converting the String content to and from the target object type.class
Implementation ofHttpMessageConverter
that can read/writeResources
and supports byte range requests.class
Implementation ofHttpMessageConverter
that can write a singleResourceRegion
or Collections ofResourceRegions
.class
Implementation ofHttpMessageConverter
that can read and write strings.Modifier and TypeMethodDescriptionFormHttpMessageConverter.getPartConverters()
Return the configured converters for MIME parts.Modifier and TypeMethodDescriptionvoid
FormHttpMessageConverter.addPartConverter
(HttpMessageConverter<?> partConverter) Add a message body converter.Modifier and TypeMethodDescriptionvoid
FormHttpMessageConverter.setPartConverters
(List<HttpMessageConverter<?>> partConverters) Set the message body converters to use. -
Uses of HttpMessageConverter in org.springframework.http.converter.cbor
Modifier and TypeClassDescriptionclass
Implementation ofHttpMessageConverter
that can read and write CBOR using kotlinx.serialization.class
Implementation ofHttpMessageConverter
that can read and write the CBOR data format using the dedicated Jackson 2.x extension. -
Uses of HttpMessageConverter in org.springframework.http.converter.feed
Modifier and TypeClassDescriptionclass
AbstractWireFeedHttpMessageConverter<T extends com.rometools.rome.feed.WireFeed>
Abstract base class for Atom and RSS Feed message converters, using the ROME tools project.class
Implementation ofHttpMessageConverter
that can read and write Atom feeds.class
Implementation ofHttpMessageConverter
that can read and write RSS feeds. -
Uses of HttpMessageConverter in org.springframework.http.converter.json
Modifier and TypeClassDescriptionclass
Abstract base class for Jackson based and content type independentHttpMessageConverter
implementations.class
Common base class for plain JSON converters, for example, Gson and JSON-B.class
Implementation ofHttpMessageConverter
that can read and write JSON using the Google Gson library.class
Implementation ofHttpMessageConverter
that can read and write JSON using the JSON Binding API.class
Implementation ofHttpMessageConverter
that can read and write JSON using kotlinx.serialization.class
Implementation ofHttpMessageConverter
that can read and write JSON using Jackson 2.x'sObjectMapper
. -
Uses of HttpMessageConverter in org.springframework.http.converter.protobuf
Modifier and TypeClassDescriptionclass
Implementation ofHttpMessageConverter
that can read and write Protocol Buffers using kotlinx.serialization.class
AnHttpMessageConverter
that reads and writescom.google.protobuf.Messages
using Google Protocol Buffers.class
Subclass ofProtobufHttpMessageConverter
which enforces the use of Protobuf 3 and its official library"com.google.protobuf:protobuf-java-util"
for JSON processing. -
Uses of HttpMessageConverter in org.springframework.http.converter.smile
Modifier and TypeClassDescriptionclass
Implementation ofHttpMessageConverter
that can read and write Smile data format ("binary JSON") using the dedicated Jackson 2.x extension. -
Uses of HttpMessageConverter in org.springframework.http.converter.support
Modifier and TypeClassDescriptionclass
Extension ofFormHttpMessageConverter
, adding support for XML, JSON, Smile, CBOR, Protobuf and Yaml based parts when related libraries are present in the classpath. -
Uses of HttpMessageConverter in org.springframework.http.converter.xml
Modifier and TypeClassDescriptionclass
Abstract base class forHttpMessageConverters
that use JAXB2.class
Abstract base class forHttpMessageConverters
that convert from/to XML.class
Jaxb2CollectionHttpMessageConverter<T extends Collection>
AnHttpMessageConverter
that can read XML collections using JAXB2.class
Implementation ofHttpMessageConverter
that can read and write XML using JAXB2.class
Implementation ofHttpMessageConverter
that can read and write XML using Jackson 2.x extension component for reading and writing XML encoded data.class
Implementation ofHttpMessageConverter
that can read and write XML using Spring'sMarshaller
andUnmarshaller
abstractions.class
SourceHttpMessageConverter<T extends Source>
Implementation ofHttpMessageConverter
that can read and writeSource
objects. -
Uses of HttpMessageConverter in org.springframework.http.converter.yaml
Modifier and TypeClassDescriptionclass
Implementation ofHttpMessageConverter
that can read and write the YAML data format using the dedicated Jackson 2.x extension. -
Uses of HttpMessageConverter in org.springframework.test.http
Modifier and TypeMethodDescriptionstatic HttpMessageContentConverter
HttpMessageContentConverter.of
(HttpMessageConverter<?>... candidates) Create an instance with a vararg of the candidates to use.Modifier and TypeMethodDescriptionstatic HttpMessageContentConverter
HttpMessageContentConverter.of
(Iterable<HttpMessageConverter<?>> candidates) Create an instance with an iterable of the candidates to use. -
Uses of HttpMessageConverter in org.springframework.test.web.servlet.assertj
Modifier and TypeMethodDescriptionMockMvcTester.withHttpMessageConverters
(Iterable<HttpMessageConverter<?>> httpMessageConverters) Return a new instance using the specified message converters. -
Uses of HttpMessageConverter in org.springframework.test.web.servlet.client
Modifier and TypeMethodDescriptionMockMvcWebTestClient.ControllerSpec.messageConverters
(HttpMessageConverter<?>... messageConverters) Set the message converters to use.MockMvcWebTestClient.RouterFunctionSpec.messageConverters
(HttpMessageConverter<?>... messageConverters) Set the message converters to use. -
Uses of HttpMessageConverter in org.springframework.test.web.servlet.setup
Modifier and TypeMethodDescriptionRouterFunctionMockMvcBuilder.setMessageConverters
(HttpMessageConverter<?>... messageConverters) Set the message converters to use in argument resolvers and in return value handlers, which support reading and/or writing to the body of the request and response.StandaloneMockMvcBuilder.setMessageConverters
(HttpMessageConverter<?>... messageConverters) Set the message converters to use in argument resolvers and in return value handlers, which support reading and/or writing to the body of the request and response. -
Uses of HttpMessageConverter in org.springframework.web.client
Modifier and TypeMethodDescriptionRestTemplate.getMessageConverters()
Return the list of message body converters.Modifier and TypeMethodDescriptionRestClient.Builder.messageConverters
(Consumer<List<HttpMessageConverter<?>>> configurer) Configure the message converters for theRestClient
to use.RestClient.Builder.messageConverters
(List<HttpMessageConverter<?>> messageConverters) Set the message converters for theRestClient
to use.void
ExtractingResponseErrorHandler.setMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Set the message converters to use by this extractor.void
RestTemplate.setMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Set the message body converters to use.ModifierConstructorDescriptionExtractingResponseErrorHandler
(List<HttpMessageConverter<?>> messageConverters) Create a newExtractingResponseErrorHandler
with the givenHttpMessageConverter
instances.HttpMessageConverterExtractor
(Class<T> responseType, List<HttpMessageConverter<?>> messageConverters) Create a new instance of theHttpMessageConverterExtractor
with the given response type and message converters.HttpMessageConverterExtractor
(Type responseType, List<HttpMessageConverter<?>> messageConverters) Creates a new instance of theHttpMessageConverterExtractor
with the given response type and message converters.RestTemplate
(List<HttpMessageConverter<?>> messageConverters) Create a new instance of theRestTemplate
using the given list ofHttpMessageConverter
to use. -
Uses of HttpMessageConverter in org.springframework.web.servlet.config.annotation
Modifier and TypeMethodDescriptionprotected final List<HttpMessageConverter<?>>
WebMvcConfigurationSupport.getMessageConverters()
Provides access to the sharedHttpMessageConverters
used by theRequestMappingHandlerAdapter
and theExceptionHandlerExceptionResolver
.Modifier and TypeMethodDescriptionprotected final void
WebMvcConfigurationSupport.addDefaultHttpMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Adds a set of default HttpMessageConverter instances to the given list.protected void
DelegatingWebMvcConfiguration.configureMessageConverters
(List<HttpMessageConverter<?>> converters) protected void
WebMvcConfigurationSupport.configureMessageConverters
(List<HttpMessageConverter<?>> converters) Override this method to add customHttpMessageConverters
to use with theRequestMappingHandlerAdapter
and theExceptionHandlerExceptionResolver
.default void
WebMvcConfigurer.configureMessageConverters
(List<HttpMessageConverter<?>> converters) Configure theHttpMessageConverter
s for reading from the request body and for writing to the response body.protected void
DelegatingWebMvcConfiguration.extendMessageConverters
(List<HttpMessageConverter<?>> converters) protected void
WebMvcConfigurationSupport.extendMessageConverters
(List<HttpMessageConverter<?>> converters) Override this method to extend or modify the list of converters after it has been configured.default void
WebMvcConfigurer.extendMessageConverters
(List<HttpMessageConverter<?>> converters) Extend or modify the list of converters after it has been, eitherconfigured
or initialized with a default list. -
Uses of HttpMessageConverter in org.springframework.web.servlet.function
Modifier and TypeMethodDescriptionServerRequest.messageConverters()
Get the readers used to convert the body of this request.ServerResponse.Context.messageConverters()
Return theHttpMessageConverters
to be used for response body conversion.Modifier and TypeMethodDescriptionstatic ServerRequest
ServerRequest.create
(HttpServletRequest servletRequest, List<HttpMessageConverter<?>> messageReaders) Create a newServerRequest
based on the givenHttpServletRequest
and message converters. -
Uses of HttpMessageConverter in org.springframework.web.servlet.function.support
Modifier and TypeMethodDescriptionvoid
RouterFunctionMapping.setMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Set the message body converters to use. -
Uses of HttpMessageConverter in org.springframework.web.servlet.mvc.method.annotation
Modifier and TypeFieldDescriptionprotected final List<HttpMessageConverter<?>>
AbstractMessageConverterMethodArgumentResolver.messageConverters
Modifier and TypeMethodDescriptionExceptionHandlerExceptionResolver.getMessageConverters()
Return the configured message body converters.RequestMappingHandlerAdapter.getMessageConverters()
Return the configured message body converters.Modifier and TypeMethodDescriptionRequestBodyAdvice.afterBodyRead
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked third (and last) after the request body is converted to an Object.RequestBodyAdviceAdapter.afterBodyRead
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) The default implementation returns the body that was passed in.JsonViewRequestBodyAdvice.beforeBodyRead
(HttpInputMessage inputMessage, MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> selectedConverterType) RequestBodyAdvice.beforeBodyRead
(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked second before the request body is read and converted.RequestBodyAdviceAdapter.beforeBodyRead
(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) The default implementation returns the InputMessage that was passed in.final Object
AbstractMappingJacksonResponseBodyAdvice.beforeBodyWrite
(Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, ServerHttpRequest request, ServerHttpResponse response) ResponseBodyAdvice.beforeBodyWrite
(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) Invoked after anHttpMessageConverter
is selected and just before its write method is invoked.RequestBodyAdvice.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked second (and last) if the body is empty.RequestBodyAdviceAdapter.handleEmptyBody
(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) The default implementation returns the body that was passed in.void
ExceptionHandlerExceptionResolver.setMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Set the message body converters to use.void
RequestMappingHandlerAdapter.setMessageConverters
(List<HttpMessageConverter<?>> messageConverters) Provide the converters to use in argument resolvers and return value handlers that support reading and/or writing to the body of the request and response.boolean
AbstractMappingJacksonResponseBodyAdvice.supports
(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) boolean
JsonViewRequestBodyAdvice.supports
(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) boolean
JsonViewResponseBodyAdvice.supports
(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) boolean
RequestBodyAdvice.supports
(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) Invoked first to determine if this interceptor applies.boolean
ResponseBodyAdvice.supports
(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) Whether this component supports the given controller method return type and the selectedHttpMessageConverter
type.ModifierConstructorDescriptionAbstractMessageConverterMethodArgumentResolver
(List<HttpMessageConverter<?>> converters) Basic constructor with converters only.AbstractMessageConverterMethodArgumentResolver
(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice) Constructor with converters andRequest~
andResponseBodyAdvice
.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters) Constructor with list of converters only.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager contentNegotiationManager) Constructor with list of converters and ContentNegotiationManager.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Variant ofAbstractMessageConverterMethodProcessor(List)
with an additionalContentNegotiationManager
for return value handling.protected
AbstractMessageConverterMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice, List<ErrorResponse.Interceptor> interceptors) Variant ofAbstractMessageConverterMethodProcessor(List, ContentNegotiationManager, List)
with additional list ofErrorResponse.Interceptor
s for return value handling.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters) Basic constructor with converters only.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice) Complete constructor for resolvingHttpEntity
method arguments.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager) Basic constructor with converters andContentNegotiationManager
.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Variant ofHttpEntityMethodProcessor(List, List)
with an additionalContentNegotiationManager
argument for return value handling.HttpEntityMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice, List<ErrorResponse.Interceptor> interceptors) Variant ofHttpEntityMethodProcessor(List, ContentNegotiationManager, List)
with additional list ofErrorResponse.Interceptor
s for return value handling.RequestPartMethodArgumentResolver
(List<HttpMessageConverter<?>> messageConverters) Basic constructor with converters only.RequestPartMethodArgumentResolver
(List<HttpMessageConverter<?>> messageConverters, List<Object> requestResponseBodyAdvice) Constructor with converters andRequestBodyAdvice
andResponseBodyAdvice
.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters) Basic constructor with converters only.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, List<Object> requestResponseBodyAdvice) Complete constructor for resolving@RequestBody
method arguments.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager) Basic constructor with converters andContentNegotiationManager
.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice) Variant ofRequestResponseBodyMethodProcessor(List, List)
with an additionalContentNegotiationManager
argument, for return value handling.RequestResponseBodyMethodProcessor
(List<HttpMessageConverter<?>> converters, ContentNegotiationManager manager, List<Object> requestResponseBodyAdvice, List<ErrorResponse.Interceptor> interceptors) Variant ofRequestResponseBodyMethodProcessor(List, ContentNegotiationManager, List)
with an additionalErrorResponse.Interceptor
argument for return value handling.ResponseBodyEmitterReturnValueHandler
(List<HttpMessageConverter<?>> messageConverters) Simple constructor with reactive type support based on a default instance ofReactiveAdapterRegistry
,SyncTaskExecutor
, andContentNegotiationManager
with an Accept header strategy.ResponseBodyEmitterReturnValueHandler
(List<HttpMessageConverter<?>> messageConverters, ReactiveAdapterRegistry registry, TaskExecutor executor, ContentNegotiationManager manager) Constructor that with added arguments to customize "reactive" type support.ResponseBodyEmitterReturnValueHandler
(List<HttpMessageConverter<?>> messageConverters, ReactiveAdapterRegistry registry, TaskExecutor executor, ContentNegotiationManager manager, List<ViewResolver> viewResolvers, LocaleResolver localeResolver) Constructor that with added arguments for view rendering.