org.springframework.http.codec.protobuf

Class 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 or higher, and supports "application/x-protobuf" and "application/octet-stream" with the official "com.google.protobuf:protobuf-java" library.

    Since:
    5.1
    Author:
    S├ębastien Deleuze
    See Also:
    ProtobufDecoder
    • Constructor Detail

      • ProtobufEncoder

        public ProtobufEncoder()
    • Method Detail

      • canEncode

        public boolean canEncode(ResolvableType elementType,
                                 @Nullable
                                 MimeType mimeType)
        Description copied from interface: Encoder
        Whether the encoder supports the given source element type and the MIME type for the output stream.
        Specified by:
        canEncode in interface 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 reactor.core.publisher.Flux<DataBuffer> encode(org.reactivestreams.Publisher<? extends com.google.protobuf.Message> inputStream,
                                                              DataBufferFactory bufferFactory,
                                                              ResolvableType elementType,
                                                              @Nullable
                                                              MimeType mimeType,
                                                              @Nullable
                                                              java.util.Map<java.lang.String,java.lang.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<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(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.
        mimeType - the MIME type for the output stream (optional)
        hints - additional information about how to do encode
        Returns:
        the output stream
      • getStreamingMediaTypes

        public java.util.List<MediaType> 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 interface HttpMessageEncoder<com.google.protobuf.Message>
      • getEncodableMimeTypes

        public java.util.List<MimeType> getEncodableMimeTypes()
        Description copied from interface: Encoder
        Return the list of mime types this encoder supports.
        Specified by:
        getEncodableMimeTypes in interface Encoder<com.google.protobuf.Message>