org.springframework.http.codec.protobuf

Class ProtobufHttpMessageWriter

java.lang.Object

org.springframework.http.codec.EncoderHttpMessageWriter<Message>

org.springframework.http.codec.protobuf.ProtobufHttpMessageWriter

All Implemented Interfaces:

HttpMessageWriter<Message>

public class ProtobufHttpMessageWriter
extends EncoderHttpMessageWriter<Message>

HttpMessageWriter that can write a protobuf Message and adds X-Protobuf-Schema, X-Protobuf-Message headers and a delimited=true parameter is added to the content type if a flux is serialized.

For HttpMessageReader, just use new DecoderHttpMessageReader(new ProtobufDecoder()).

Since:

5.1

Author:

Sébastien Deleuze

See Also:

ProtobufEncoder

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.concurrent.ConcurrentMap<java.lang.Class<?>,java.lang.reflect.Method>	methodCache
private static java.lang.String	X_PROTOBUF_MESSAGE_HEADER
private static java.lang.String	X_PROTOBUF_SCHEMA_HEADER

Constructor Summary

Constructors

Constructor and Description
ProtobufHttpMessageWriter() Create a new ProtobufHttpMessageWriter with a default ProtobufEncoder.
ProtobufHttpMessageWriter(Encoder<Message> encoder) Create a new ProtobufHttpMessageWriter with the given encoder.

Method Summary

Modifier and Type	Method and Description
private static Message.Builder	getMessageBuilder(java.lang.Class<?> clazz) Create a new Message.Builder instance for the given class.
<any>	write(<any> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, java.util.Map<java.lang.String,java.lang.Object> hints) Write an given stream of object to the output message.

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

canWrite, getEncoder, getWritableMediaTypes, getWriteHints, write

Methods inherited from class java.lang.Object

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

Field Detail

X_PROTOBUF_SCHEMA_HEADER

private static final java.lang.String X_PROTOBUF_SCHEMA_HEADER

See Also:

Constant Field Values

X_PROTOBUF_MESSAGE_HEADER

private static final java.lang.String X_PROTOBUF_MESSAGE_HEADER

See Also:

Constant Field Values

methodCache

private static final java.util.concurrent.ConcurrentMap<java.lang.Class<?>,java.lang.reflect.Method> methodCache

Constructor Detail

ProtobufHttpMessageWriter

public ProtobufHttpMessageWriter()

Create a new ProtobufHttpMessageWriter with a default ProtobufEncoder.

ProtobufHttpMessageWriter

public ProtobufHttpMessageWriter(Encoder<Message> encoder)

Create a new ProtobufHttpMessageWriter with the given encoder.

Parameters:

encoder - the Protobuf message encoder to use

Method Detail

write

public <any> write(<any> inputStream,
                   ResolvableType elementType,
                   @Nullable
                   MediaType mediaType,
                   ReactiveHttpOutputMessage message,
                   java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: HttpMessageWriter

Write an given stream of object to the output message.

Specified by:

write in interface HttpMessageWriter<Message>

Overrides:

write in class EncoderHttpMessageWriter<Message>

Parameters:

inputStream - the objects to write

elementType - the type of objects in the stream which must have been previously checked via HttpMessageWriter.canWrite(ResolvableType, MediaType)

mediaType - the content type for the write (possibly null to indicate that the default content type of the writer must be used)

message - the message to write to

hints - additional information about how to encode and write

Returns:

indicates completion or error

getMessageBuilder

private static Message.Builder getMessageBuilder(java.lang.Class<?> clazz)
                                          throws java.lang.Exception

Create a new Message.Builder instance for the given class.

This method uses a ConcurrentHashMap for caching method lookups.

Throws:

java.lang.Exception