public abstract class AbstractJackson2Encoder extends Jackson2CodecSupport implements HttpMessageEncoder<Object>
Flux elements are collected into a List before serialization for
performance reason.JSON_VIEW_HINT, logger| Modifier | Constructor and Description |
|---|---|
protected |
AbstractJackson2Encoder(ObjectMapper mapper,
MimeType... mimeTypes)
Constructor with a Jackson
ObjectMapper to use. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
canEncode(ResolvableType elementType,
MimeType mimeType)
Whether the encoder supports the given source element type and the MIME
type for the output stream.
|
protected ObjectWriter |
customizeWriter(ObjectWriter writer,
MimeType mimeType,
ResolvableType elementType,
Map<String,Object> hints) |
reactor.core.publisher.Flux<DataBuffer> |
encode(Publisher<?> inputStream,
DataBufferFactory bufferFactory,
ResolvableType elementType,
MimeType mimeType,
Map<String,Object> hints)
Encode a stream of Objects of type
T into a DataBuffer
output stream. |
DataBuffer |
encodeValue(Object value,
DataBufferFactory bufferFactory,
ResolvableType valueType,
MimeType mimeType,
Map<String,Object> hints)
Encode an Object of type T to a data buffer.
|
protected <A extends Annotation> |
getAnnotation(MethodParameter parameter,
Class<A> annotType) |
List<MimeType> |
getEncodableMimeTypes()
Return the list of MIME types supported by this Encoder.
|
List<MimeType> |
getEncodableMimeTypes(ResolvableType elementType)
Return the list of MIME types supported by this Encoder for the given type
of element.
|
Map<String,Object> |
getEncodeHints(ResolvableType actualType,
ResolvableType elementType,
MediaType mediaType,
ServerHttpRequest request,
ServerHttpResponse response)
Get decoding hints based on the server request or annotations on the
target controller method parameter.
|
protected JsonEncoding |
getJsonEncoding(MimeType mimeType)
Determine the JSON encoding to use for the given mime type.
|
List<MediaType> |
getStreamingMediaTypes()
Return "streaming" media types for which flushing should be performed
automatically vs at the end of the input stream.
|
protected byte[] |
getStreamingMediaTypeSeparator(MimeType mimeType)
Return the separator to use for the given mime type.
|
void |
setStreamingMediaTypes(List<MediaType> mediaTypes)
Configure "streaming" media types for which flushing should be performed
automatically vs at the end of the stream.
|
getHints, getJavaType, getMimeTypes, getMimeTypes, getObjectMapper, getObjectMapperRegistrations, getObjectMappersForType, getParameter, logWarningIfNecessary, registerObjectMappersForType, selectObjectMapper, setObjectMapper, supportsMimeTypeprotected AbstractJackson2Encoder(ObjectMapper mapper, MimeType... mimeTypes)
ObjectMapper to use.public void setStreamingMediaTypes(List<MediaType> mediaTypes)
public boolean canEncode(ResolvableType elementType, @Nullable MimeType mimeType)
Encoderpublic reactor.core.publisher.Flux<DataBuffer> encode(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
EncoderT into a DataBuffer
output stream.encode in interface Encoder<Object>inputStream - the input stream of Objects to encode. If the input should be
encoded as a single value rather than as a stream of elements, an instance of
Mono should be used.bufferFactory - for creating output stream DataBuffer'selementType - the expected type of elements in the input stream;
this type must have been previously passed to the Encoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
method and it must have returned true.mimeType - the MIME type for the output content (optional)hints - additional information about how to encodepublic DataBuffer encodeValue(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
EncoderBy default this method raises UnsupportedOperationException
and it is expected that some encoders cannot produce a single buffer or
cannot do so synchronously (e.g. encoding a Resource).
encodeValue in interface Encoder<Object>value - the value to be encodedbufferFactory - for creating the output DataBuffervalueType - the type for the value being encodedmimeType - the MIME type for the output content (optional)hints - additional information about how to encodeprotected ObjectWriter customizeWriter(ObjectWriter writer, @Nullable MimeType mimeType, ResolvableType elementType, @Nullable Map<String,Object> hints)
@Nullable protected byte[] getStreamingMediaTypeSeparator(@Nullable MimeType mimeType)
By default, this method returns new line "\n" if the given
mime type is one of the configured streaming mime types.
protected JsonEncoding getJsonEncoding(@Nullable MimeType mimeType)
mimeType - the mime type as requested by the callernull)public List<MimeType> getEncodableMimeTypes()
EncodercanEncode(elementType, null). The list may also exclude MIME types
supported only for a specific element type. Alternatively, use
Encoder.getEncodableMimeTypes(ResolvableType) for a more precise list.getEncodableMimeTypes in interface Encoder<Object>public List<MimeType> getEncodableMimeTypes(ResolvableType elementType)
EncoderEncoder.getEncodableMimeTypes()
if the Encoder doesn't support the element type or if it supports it only
for a subset of MIME types.getEncodableMimeTypes in interface Encoder<Object>elementType - the type of element to check for encodingpublic List<MediaType> getStreamingMediaTypes()
HttpMessageEncodergetStreamingMediaTypes in interface HttpMessageEncoder<Object>public Map<String,Object> getEncodeHints(@Nullable ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response)
HttpMessageEncodergetEncodeHints in interface HttpMessageEncoder<Object>actualType - the actual source type to encode, possibly a reactive
wrapper and sourced from MethodParameter,
i.e. providing access to method annotations.elementType - the element type within Flux/Mono that we're
trying to encode.request - the current requestresponse - the current responseprotected <A extends Annotation> A getAnnotation(MethodParameter parameter, Class<A> annotType)
getAnnotation in class Jackson2CodecSupport