Class ProtobufJsonEncoder
java.lang.Object
org.springframework.http.codec.protobuf.ProtobufJsonEncoder
- All Implemented Interfaces:
Encoder<com.google.protobuf.Message>
,HttpMessageEncoder<com.google.protobuf.Message>
public class ProtobufJsonEncoder
extends Object
implements HttpMessageEncoder<com.google.protobuf.Message>
A
Encoder
that writes Message
s as JSON.
To generate Message
Java classes, you need to install the
protoc
binary.
This encoder requires Protobuf 3.29 or higher, and supports
"application/json"
and "application/*+json"
with
the official "com.google.protobuf:protobuf-java-util"
library.
- Since:
- 6.2
- Author:
- Brian Clozel
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct a newProtobufJsonEncoder
using a defaultJsonFormat.Printer
instance.ProtobufJsonEncoder
(com.google.protobuf.util.JsonFormat.Printer printer) Construct a newProtobufJsonEncoder
using the givenJsonFormat.Printer
instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
canEncode
(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.reactor.core.publisher.Flux<DataBuffer>
encode
(Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String, Object> hints) Encode a stream of Objects of typeT
into aDataBuffer
output stream.encodeValue
(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String, Object> hints) Encode an Object of type T to a data buffer.Return the list of MIME types supported by this Encoder.Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.core.codec.Encoder
getEncodableMimeTypes
Methods inherited from interface org.springframework.http.codec.HttpMessageEncoder
getEncodeHints
-
Constructor Details
-
ProtobufJsonEncoder
public ProtobufJsonEncoder()Construct a newProtobufJsonEncoder
using a defaultJsonFormat.Printer
instance. -
ProtobufJsonEncoder
public ProtobufJsonEncoder(com.google.protobuf.util.JsonFormat.Printer printer) Construct a newProtobufJsonEncoder
using the givenJsonFormat.Printer
instance.
-
-
Method Details
-
getStreamingMediaTypes
Description copied from interface:HttpMessageEncoder
Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.- Specified by:
getStreamingMediaTypes
in interfaceHttpMessageEncoder<com.google.protobuf.Message>
-
getEncodableMimeTypes
Description copied from interface:Encoder
Return the list of MIME types supported by this Encoder. The list may not apply to every possible target element type and calls to this method should typically be guarded viacanEncode(elementType, null)
. The list may also exclude MIME types supported only for a specific element type. Alternatively, useEncoder.getEncodableMimeTypes(ResolvableType)
for a more precise list.- Specified by:
getEncodableMimeTypes
in interfaceEncoder<com.google.protobuf.Message>
- Returns:
- the list of supported MIME types
-
canEncode
Description copied from interface:Encoder
Whether the encoder supports the given source element type and the MIME type for the output stream. -
encode
public reactor.core.publisher.Flux<DataBuffer> encode(Publisher<? extends com.google.protobuf.Message> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String, Object> hints) Description copied from interface:Encoder
Encode a stream of Objects of typeT
into aDataBuffer
output stream.- Specified by:
encode
in interfaceEncoder<com.google.protobuf.Message>
- 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 ofMono
should be used.bufferFactory
- for creating output streamDataBuffer
'selementType
- the expected type of elements in the input stream; this type must have been previously passed to theEncoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
method and it must have returnedtrue
.mimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- Returns:
- the output stream
-
encodeValue
public DataBuffer encodeValue(com.google.protobuf.Message message, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String, Object> hints) Description copied from interface:Encoder
Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.By 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 aResource
).- Specified by:
encodeValue
in interfaceEncoder<com.google.protobuf.Message>
- Parameters:
message
- the value to be encodedbufferFactory
- for creating the outputDataBuffer
valueType
- the type for the value being encodedmimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- Returns:
- the encoded content
-