org.springframework.http.codec.json

Class Jackson2CodecSupport

java.lang.Object

org.springframework.http.codec.json.Jackson2CodecSupport

Direct Known Subclasses:

AbstractJackson2Decoder, AbstractJackson2Encoder

public abstract class Jackson2CodecSupport
extends Object

Base class providing support methods for Jackson 2.9 encoding and decoding.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static 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 Log	logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jackson2CodecSupport(ObjectMapper objectMapper, MimeType... mimeTypes) Constructor with a Jackson ObjectMapper to use.

Method Summary

Modifier and Type	Method and Description
protected abstract <A extends Annotation> A	getAnnotation(MethodParameter parameter, Class<A> annotType)
protected Map<String,Object>	getHints(ResolvableType resolvableType)
protected JavaType	getJavaType(Type type, Class<?> contextClass)
protected List<MimeType>	getMimeTypes() Subclasses should expose this as "decodable" or "encodable" mime types.
ObjectMapper	getObjectMapper()
protected MethodParameter	getParameter(ResolvableType type)
protected void	logWarningIfNecessary(Type type, Throwable cause) Determine whether to log the given exception coming from a ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check.
protected boolean	supportsMimeType(MimeType mimeType)

Methods inherited from class java.lang.Object

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

Field Detail

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.

See Also:

Jackson JSON Views

logger

protected final Log logger

Constructor Detail

Jackson2CodecSupport

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

Constructor with a Jackson ObjectMapper to use.

Method Detail

getObjectMapper

public ObjectMapper getObjectMapper()

getMimeTypes

protected List<MimeType> getMimeTypes()

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

supportsMimeType

protected boolean supportsMimeType(@Nullable
                                   MimeType mimeType)

logWarningIfNecessary

protected void logWarningIfNecessary(Type type,
                                     @Nullable
                                     Throwable cause)

Determine whether to log the given exception coming from a ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType) / ObjectMapper.canSerialize(java.lang.Class<?>) check.

Parameters:

type - the class that Jackson tested for (de-)serializability

cause - the Jackson-thrown exception to evaluate (typically a JsonMappingException)

Since:

5.3.1

getJavaType

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

getHints

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

getParameter

@Nullable
protected MethodParameter getParameter(ResolvableType type)

getAnnotation

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