Class JacksonCborEncoder

java.lang.Object

org.springframework.http.codec.JacksonCodecSupport

org.springframework.http.codec.AbstractJacksonEncoder

org.springframework.http.codec.cbor.JacksonCborEncoder

All Implemented Interfaces:

Encoder<Object>, HttpMessageEncoder<Object>

public class JacksonCborEncoder
extends AbstractJacksonEncoder

Encode from an Object to bytes of CBOR objects using Jackson 3.x.

Stream encoding is currently not supported.

Since:

7.0

Author:

Sebastien Deleuze

See Also:

• JacksonCborDecoder
• Add CBOR support to WebFlux

Field Summary

Fields inherited from class org.springframework.http.codec.JacksonCodecSupport

FILTER_PROVIDER_HINT, JSON_VIEW_HINT, logger, objectMapperRegistrations

Constructor Summary

Constructors

Constructor	Description
JacksonCborEncoder()	Construct a new instance with a CBORMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper)	Construct a new instance with the provided CBORMapper.
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper, MimeType... mimeTypes)	Construct a new instance with the provided CBORMapper and MimeTypes.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Flux<DataBuffer>	encode(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)	Encode a stream of Objects of type T into a DataBuffer output stream.

Methods inherited from class org.springframework.http.codec.AbstractJacksonEncoder

canEncode, customizeWriter, encodeValue, getAnnotation, getEncodableMimeTypes, getEncodableMimeTypes, getEncodeHints, getJsonEncoding, getStreamingMediaTypes, getStreamingMediaTypeSeparator, setStreamingMediaTypes

Methods inherited from class org.springframework.http.codec.JacksonCodecSupport

getHints, getJavaType, getMediaTypesForProblemDetail, getMimeTypes, getMimeTypes, getObjectMapper, getObjectMapperRegistrations, getObjectMappersForType, getParameter, registerObjectMappersForType, selectObjectMapper, supportsMimeType

Methods inherited from class java.lang.Object

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

Constructor Details

JacksonCborEncoder

public JacksonCborEncoder()

Construct a new instance with a CBORMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper)

Construct a new instance with the provided CBORMapper.

See Also:

• CBORMapper.builder()
• MapperBuilder.findAndAddModules(ClassLoader)

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper,
 MimeType... mimeTypes)

Construct a new instance with the provided CBORMapper and MimeTypes.

See Also:

• CBORMapper.builder()
• MapperBuilder.findAndAddModules(ClassLoader)

Method Details

encode

public reactor.core.publisher.Flux<DataBuffer> encode(Publisher<?> inputStream,
 DataBufferFactory bufferFactory,
 ResolvableType elementType,
 @Nullable MimeType mimeType,
 @Nullable Map<String,Object> hints)

Description copied from interface: Encoder

Encode a stream of Objects of type T into a DataBuffer output stream.

Specified by:

encode in interface Encoder<Object>

Overrides:

encode in class AbstractJacksonEncoder

Parameters:

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's

elementType - 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 encode

Returns:

the output stream