Class JacksonCodecSupport

java.lang.Object

org.springframework.http.codec.JacksonCodecSupport

Direct Known Subclasses:

AbstractJacksonDecoder, AbstractJacksonEncoder

public abstract class JacksonCodecSupport
extends Object

Base class providing support methods for Jackson 2.x encoding and decoding.

Since:

7.0

Author:

Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_PROVIDER_HINT	The key for the hint to specify a FilterProvider.
static final String	JSON_VIEW_HINT	The key for the hint to specify a "JSON View" for encoding or decoding with the value expected to be a Class.
protected final org.apache.commons.logging.Log	logger
protected @Nullable Map<Class<?>, Map<MimeType, ObjectMapper>>	objectMapperRegistrations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JacksonCodecSupport(MapperBuilder<?,?> builder, MimeType... mimeTypes)	Construct a new instance with the provided builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and MimeTypes.
protected	JacksonCodecSupport(ObjectMapper objectMapper, MimeType... mimeTypes)	Construct a new instance with the provided ObjectMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and MimeTypes.

Method Summary

Modifier and Type	Method	Description
protected abstract <A extends Annotation> @Nullable A	getAnnotation(MethodParameter parameter, Class<A> annotType)
protected Map<String,Object>	getHints(ResolvableType resolvableType)
protected JavaType	getJavaType(Type type, @Nullable Class<?> contextClass)
protected List<MimeType>	getMediaTypesForProblemDetail()	Return the supported media type(s) for ProblemDetail.
protected List<MimeType>	getMimeTypes()	Subclasses should expose this as "decodable" or "encodable" mime types.
protected List<MimeType>	getMimeTypes(ResolvableType elementType)
ObjectMapper	getObjectMapper()	Return the configured default ObjectMapper.
protected Map<Class<?>, Map<MimeType, ObjectMapper>>	getObjectMapperRegistrations()
@Nullable Map<MimeType, ObjectMapper>	getObjectMappersForType(Class<?> clazz)	Return ObjectMapper registrations for the given class, if any.
protected @Nullable MethodParameter	getParameter(ResolvableType type)
void	registerObjectMappersForType(Class<?> clazz, Consumer<Map<MimeType, ObjectMapper>> registrar)	Configure the ObjectMapper instances to use for the given Class.
protected @Nullable ObjectMapper	selectObjectMapper(ResolvableType targetType, @Nullable MimeType targetMimeType)	Select an ObjectMapper to use, either the main ObjectMapper or another if the handling for the given Class has been customized through registerObjectMappersForType(Class, Consumer).
protected boolean	supportsMimeType(@Nullable MimeType mimeType)

Methods inherited from class java.lang.Object

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

Field Details

JSON_VIEW_HINT

public static final String JSON_VIEW_HINT

The key for the hint to specify a "JSON View" for encoding or decoding with the value expected to be a Class.

FILTER_PROVIDER_HINT

public static final String FILTER_PROVIDER_HINT

The key for the hint to specify a FilterProvider.

logger

protected final org.apache.commons.logging.Log logger

objectMapperRegistrations

protected @Nullable Map<Class<?>, Map<MimeType, ObjectMapper>> objectMapperRegistrations

Constructor Details

JacksonCodecSupport

protected JacksonCodecSupport(MapperBuilder<?,?> builder,
 MimeType... mimeTypes)

Construct a new instance with the provided builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and MimeTypes.

JacksonCodecSupport

protected JacksonCodecSupport(ObjectMapper objectMapper,
 MimeType... mimeTypes)

Construct a new instance with the provided ObjectMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader) and MimeTypes.

Method Details

getObjectMapper

public ObjectMapper getObjectMapper()

Return the configured default ObjectMapper.

registerObjectMappersForType

public void registerObjectMappersForType(Class<?> clazz,
 Consumer<Map<MimeType, ObjectMapper>> registrar)

Configure the ObjectMapper instances to use for the given Class. This is useful when you want to deviate from the default ObjectMapper or have the ObjectMapper vary by MediaType.

Note: Use of this method effectively turns off use of the default ObjectMapper and supported MimeTypes for the given class. Therefore it is important for the mappings configured here to include every MediaType that must be supported for the given class.

Parameters:

clazz - the type of Object to register ObjectMapper instances for

registrar - a consumer to populate or otherwise update the MediaType-to-ObjectMapper associations for the given Class

getObjectMappersForType

public @Nullable Map<MimeType, ObjectMapper> getObjectMappersForType(Class<?> clazz)

Return ObjectMapper registrations for the given class, if any.

Parameters:

clazz - the class to look up for registrations for

Returns:

a map with registered MediaType-to-ObjectMapper registrations, or empty if in case of no registrations for the given class.

getObjectMapperRegistrations

protected Map<Class<?>, Map<MimeType, ObjectMapper>> getObjectMapperRegistrations()

getMimeTypes

protected List<MimeType> getMimeTypes()

Subclasses should expose this as "decodable" or "encodable" mime types.

getMimeTypes

protected List<MimeType> getMimeTypes(ResolvableType elementType)

getMediaTypesForProblemDetail

protected List<MimeType> getMediaTypesForProblemDetail()

Return the supported media type(s) for ProblemDetail. By default, an empty list, unless overridden in subclasses.

supportsMimeType

protected boolean supportsMimeType(@Nullable MimeType mimeType)

getJavaType

protected JavaType getJavaType(Type type,
 @Nullable Class<?> contextClass)

getHints

protected Map<String,Object> getHints(ResolvableType resolvableType)

getParameter

protected @Nullable MethodParameter getParameter(ResolvableType type)

getAnnotation

protected abstract <A extends Annotation>
@Nullable A getAnnotation(MethodParameter parameter,
 Class<A> annotType)

selectObjectMapper

protected @Nullable ObjectMapper selectObjectMapper(ResolvableType targetType,
 @Nullable MimeType targetMimeType)

Select an ObjectMapper to use, either the main ObjectMapper or another if the handling for the given Class has been customized through registerObjectMappersForType(Class, Consumer).