Class ProtobufEncoder

java.lang.Object
org.springframework.http.codec.protobuf.ProtobufCodecsupport
org.springframework.http.codec.protobuf.ProtobufEncoder
All Implemented Interfaces:
Encoder<com.google.protobuf.Message>, HttpMessageEncoder<com.google.protobuf.Message>
public class ProtobufEncoder extends ProtobufCodecsupport implements HttpMessageEncoder<com.google.protobuf.Message>
An Encoder that writes Messages using Google Protocol Buffers.

Flux are serialized using delimited Protobuf messages with the size of each message specified before the message itself. single values are serialized using regular Protobuf message format (without the size prepended before the message).

To generate Message Java classes, you need to install the protoc binary.

This encoder requires Protobuf 3.29 or higher, and supports "application/x-protobuf" and "application/octet-stream" with the official "com.google.protobuf:protobuf-java" library.

since:
5.1
Author:
sebastien Deleuze
see Also:

  • Constructor Details

    • ProtobufEncoder

      public&nbsp;ProtobufEncoder()

  • Method Details

    • setMimeTypes

      protected&nbsp;void&nbsp;setMimeTypes(List<MimeType>&nbsp;mimeTypes)
      Overrides:
      setMimeTypes&nbsp;in class&nbsp;ProtobufCodecsupport

    • getstreamingMediaTypes

      public&nbsp;List<MediaType>&nbsp;getstreamingMediaTypes()
      Description copied from interface:&nbsp;HttpMessageEncoder
      Return "streaming" media types for which flushing should be performed automatically vs at the end of the input stream.
      specified by:
      getstreamingMediaTypes&nbsp;in interface&nbsp;HttpMessageEncoder<com.google.protobuf.Message>

    • getEncodableMimeTypes

      public&nbsp;List<MimeType>&nbsp;getEncodableMimeTypes()
      Description copied from interface:&nbsp;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 via canEncode(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.
      specified by:
      getEncodableMimeTypes&nbsp;in interface&nbsp;Encoder<com.google.protobuf.Message>
      Returns:
      the list of supported MIME types

    • canEncode

      public&nbsp;boolean&nbsp;canEncode(ResolvableType&nbsp;elementType, @Nullable MimeType&nbsp;mimeType)
      Description copied from interface:&nbsp;Encoder
      Whether the encoder supports the given source element type and the MIME type for the output stream.
      specified by:
      canEncode&nbsp;in interface&nbsp;Encoder<com.google.protobuf.Message>
      Parameters:
      elementType - the type of elements in the source stream
      mimeType - the MIME type for the output stream (can be null if not specified)
      Returns:
      true if supported, false otherwise

    • encode

      public&nbsp;reactor.core.publisher.Flux<DataBuffer>&nbsp;encode(Publisher<? extends com.google.protobuf.Message>&nbsp;inputstream, DataBufferFactory&nbsp;bufferFactory, ResolvableType&nbsp;elementType, @Nullable MimeType&nbsp;mimeType, @Nullable Map<string,Object>&nbsp;hints)
      Description copied from interface:&nbsp;Encoder
      Encode a stream of Objects of type T into a DataBuffer output stream.
      specified by:
      encode&nbsp;in interface&nbsp;Encoder<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 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(ResolvableType, 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

    • encodeValue

      public&nbsp;DataBuffer&nbsp;encodeValue(com.google.protobuf.Message&nbsp;message, DataBufferFactory&nbsp;bufferFactory, ResolvableType&nbsp;valueType, @Nullable MimeType&nbsp;mimeType, @Nullable Map<string,Object>&nbsp;hints)
      Description copied from interface:&nbsp;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 (for example, encoding a Resource).

      specified by:
      encodeValue&nbsp;in interface&nbsp;Encoder<com.google.protobuf.Message>
      Parameters:
      message - the value to be encoded
      bufferFactory - for creating the output DataBuffer
      valueType - the type for the value being encoded
      mimeType - the MIME type for the output content (optional)
      hints - additional information about how to encode
      Returns:
      the encoded content

    • writeMessage

      protected&nbsp;void&nbsp;writeMessage(com.google.protobuf.Message&nbsp;message, boolean&nbsp;delimited, Outputstream&nbsp;outputstream) throws IOException
      Use write methods on Message to write to the given Outputstream.
      Throws:
      IOException
      since:
      7.0