Spring Web 6.1.4 · org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter

An HttpMessageConverter that reads and writes com.google.protobuf.Messages using Google Protocol Buffers.

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

This converter supports by default "application/x-protobuf" and "text/plain" with the official "com.google.protobuf:protobuf-java" library. The "application/json" format is also supported with the "com.google.protobuf:protobuf-java-util" dependency. See ProtobufJsonFormatHttpMessageConverter for a configurable variant.

This converter requires Protobuf 3 or higher as of Spring Framework 6.1.

Modifier and Type	Class and Description
pack-priv static interface	ProtobufHttpMessageConverter.ProtobufFormatSupport Protobuf format support.
pack-priv static class	ProtobufHttpMessageConverter.ProtobufJavaUtilSupport `ProtobufFormatSupport` implementation used when `com.google.protobuf.util.JsonFormat` is available.

Field Summary

Modifier and Type	Field and Description
public static final Charset	DEFAULT_CHARSET The default charset used by the converter.
pack-priv final ExtensionRegistry	extensionRegistry
private static final Map<Class<?>, Method>	methodCache
public static final MediaType	PROTOBUF The media-type for protobuf `application/x-protobuf`.
private final ProtobufHttpMessageConverter.ProtobufFormatSupport	protobufFormatSupport
private static final boolean	protobufJsonFormatPresent
public static final String	X_PROTOBUF_MESSAGE_HEADER The HTTP header containing the protobuf message.
public static final String	X_PROTOBUF_SCHEMA_HEADER The HTTP header containing the protobuf schema.

Inherited from org.springframework.http.converter.AbstractHttpMessageConverter:: logger

Access	Constructor and Description
public	ProtobufHttpMessageConverter() Construct a new `ProtobufHttpMessageConverter`.
public	ProtobufHttpMessageConverter(ExtensionRegistry the registry to populate extensionRegistry) Construct a new `ProtobufHttpMessageConverter` with a registry that specifies protocol message extensions.
pack-priv	ProtobufHttpMessageConverter(ProtobufHttpMessageConverter.ProtobufFormatSupport formatSupport, ExtensionRegistry extensionRegistry)

Method Summary

Modifier and Type	Method and Description
protected boolean	canWrite(MediaType the media type to write, can be `null` if not specified. Typically the value of an `Accept` header. mediaType) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.canWrite. Returns `true` if the given media type includes any of the supported media types.
protected MediaType	getDefaultContentType(Message the type to return the content type for message) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.getDefaultContentType. Returns the default content type for the given type.
private Message.Builder	getMessageBuilder(Class<? extends Message> clazz) Create a new `Message.Builder` instance for the given class.
protected Message	readInternal(Class<? extends Message> the type of object to return clazz, HttpInputMessage the HTTP input message to read from inputMessage) Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.readInternal. Abstract template method that reads the actual object.
private void	setProtoHeader(HttpOutputMessage response, Message message) Set the "X-Protobuf-*" HTTP headers when responding with a message of content type "application/x-protobuf" Note `outputMessage.getBody()` should not have been called before because it writes HTTP headers (making them read only).
protected boolean	supports(Class<?> the class to test for support clazz) Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.supports. Indicates whether the given class is supported by this converter.
protected boolean	supportsRepeatableWrites(Message the object t message) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.supportsRepeatableWrites. Indicates whether this message converter can write the given object multiple times.
protected void	writeInternal(Message the object to write to the output message message, HttpOutputMessage the HTTP output message to write to outputMessage) Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.writeInternal. Abstract template method that writes the actual body.

Inherited from org.springframework.http.converter.AbstractHttpMessageConverter:: addDefaultHeaders canRead canRead canWrite getContentLength getDefaultCharset getSupportedMediaTypes read setDefaultCharset setSupportedMediaTypes write

Field Detail

DEFAULT_CHARSET	back to summary
public static final Charset DEFAULT_CHARSET The default charset used by the converter.

extensionRegistry	back to summary
pack-priv final ExtensionRegistry extensionRegistry

methodCache	back to summary
private static final Map<Class<?>, Method> methodCache

PROTOBUF	back to summary
public static final MediaType PROTOBUF The media-type for protobuf `application/x-protobuf`.

protobufFormatSupport	back to summary
private final ProtobufHttpMessageConverter.ProtobufFormatSupport protobufFormatSupport Annotations @Nullable

protobufJsonFormatPresent	back to summary
private static final boolean protobufJsonFormatPresent

X_PROTOBUF_MESSAGE_HEADER	back to summary
public static final String X_PROTOBUF_MESSAGE_HEADER The HTTP header containing the protobuf message.

X_PROTOBUF_SCHEMA_HEADER	back to summary
public static final String X_PROTOBUF_SCHEMA_HEADER The HTTP header containing the protobuf schema.

Constructor Detail

ProtobufHttpMessageConverter	back to summary
public ProtobufHttpMessageConverter() Construct a new `ProtobufHttpMessageConverter`.

ProtobufHttpMessageConverter back to summary

ProtobufHttpMessageConverter	back to summary
public ProtobufHttpMessageConverter(ExtensionRegistry extensionRegistry) Construct a new `ProtobufHttpMessageConverter` with a registry that specifies protocol message extensions. Parameters extensionRegistry:ExtensionRegistry the registry to populate

public ProtobufHttpMessageConverter(ExtensionRegistry extensionRegistry)

Construct a new ProtobufHttpMessageConverter with a registry that specifies protocol message extensions.

Parameters

extensionRegistry:ExtensionRegistry: the registry to populate

ProtobufHttpMessageConverter	back to summary
pack-priv ProtobufHttpMessageConverter(ProtobufHttpMessageConverter.ProtobufFormatSupport formatSupport, ExtensionRegistry extensionRegistry)

Method Detail

canWrite back to summary

canWrite	back to summary
protected boolean canWrite(MediaType mediaType) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.canWrite. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.canWrite. Returns `true` if the given media type includes any of the supported media types. Parameters mediaType:MediaType the media type to write, can be `null` if not specified. Typically the value of an `Accept` header. Returns:boolean `true` if the supported media types are compatible with the media type, or if the media type is `null` Annotations @Override

protected boolean canWrite(MediaType mediaType)

Overrides org.springframework.http.converter.AbstractHttpMessageConverter.canWrite.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.canWrite.

Returns true if the given media type includes any of the supported media types.

Parameters

mediaType:MediaType: the media type to write, can be null if not specified. Typically the value of an Accept header.

Returns:boolean

true if the supported media types are compatible with the media type, or if the media type is null

Annotations

@Override

getDefaultContentType back to summary

getDefaultContentType	back to summary
protected MediaType getDefaultContentType(Message message) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.getDefaultContentType. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.getDefaultContentType. Returns the default content type for the given type. Called when `write` is invoked without a specified content type parameter. By default, this returns the first element of the `supportedMediaTypes` property, if any. Can be overridden in subclasses. Parameters message:Message the type to return the content type for Returns:MediaType the content type, or `null` if not known Annotations @Override

protected MediaType getDefaultContentType(Message message)

Overrides org.springframework.http.converter.AbstractHttpMessageConverter.getDefaultContentType.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.getDefaultContentType.

Returns the default content type for the given type. Called when write is invoked without a specified content type parameter.

By default, this returns the first element of the supportedMediaTypes property, if any. Can be overridden in subclasses.

Parameters

message:Message: the type to return the content type for

Returns:MediaType

the content type, or null if not known

Annotations

@Override

getMessageBuilder back to summary

getMessageBuilder	back to summary
private Message.Builder getMessageBuilder(Class<? extends Message> clazz) Create a new `Message.Builder` instance for the given class. This method uses a ConcurrentReferenceHashMap for caching method lookups.

private Message.Builder getMessageBuilder(Class<? extends Message> clazz)

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

This method uses a ConcurrentReferenceHashMap for caching method lookups.

readInternal back to summary

readInternal	back to summary
protected Message readInternal(Class<? extends Message> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.readInternal. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.readInternal. Abstract template method that reads the actual object. Invoked from `read`. Parameters clazz:Class<? extends Message> the type of object to return inputMessage:HttpInputMessage the HTTP input message to read from Returns:Message the converted object Annotations @Override Exceptions IOException: in case of I/O errors HttpMessageNotReadableException: in case of conversion errors

protected Message readInternal(Class<? extends Message> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException

Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.readInternal.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.readInternal.

Abstract template method that reads the actual object. Invoked from read.

Parameters

clazz:Class<? extends Message>: the type of object to return
inputMessage:HttpInputMessage: the HTTP input message to read from

Returns:Message

the converted object

Annotations

@Override

Exceptions

IOException:: in case of I/O errors
HttpMessageNotReadableException:: in case of conversion errors

setProtoHeader	back to summary
private void setProtoHeader(HttpOutputMessage response, Message message) Set the "X-Protobuf-*" HTTP headers when responding with a message of content type "application/x-protobuf" Note `outputMessage.getBody()` should not have been called before because it writes HTTP headers (making them read only).

supports back to summary

supports	back to summary
protected boolean supports(Class<?> clazz) Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.supports. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.supports. Indicates whether the given class is supported by this converter. Parameters clazz:Class<?> the class to test for support Returns:boolean `true` if supported; `false` otherwise Annotations @Override

protected boolean supports(Class<?> clazz)

Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.supports.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.supports.

Indicates whether the given class is supported by this converter.

Parameters

clazz:Class<?>: the class to test for support

Returns:boolean

true if supported; false otherwise

Annotations

@Override

supportsRepeatableWrites back to summary

supportsRepeatableWrites	back to summary
protected boolean supportsRepeatableWrites(Message message) Overrides org.springframework.http.converter.AbstractHttpMessageConverter.supportsRepeatableWrites. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.supportsRepeatableWrites. Indicates whether this message converter can write the given object multiple times. Default implementation returns `false`. Parameters message:Message the object t Returns:boolean `true` if `t` can be written repeatedly; `false` otherwise Annotations @Override

protected boolean supportsRepeatableWrites(Message message)

Overrides org.springframework.http.converter.AbstractHttpMessageConverter.supportsRepeatableWrites.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.supportsRepeatableWrites.

Indicates whether this message converter can write the given object multiple times.

Default implementation returns false.

Parameters

message:Message: the object t

Returns:boolean

true if t can be written repeatedly; false otherwise

Annotations

@Override

writeInternal back to summary

writeInternal	back to summary
protected void writeInternal(Message message, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.writeInternal. Doc from org.springframework.http.converter.AbstractHttpMessageConverter.writeInternal. Abstract template method that writes the actual body. Invoked from `write`. Parameters message:Message the object to write to the output message outputMessage:HttpOutputMessage the HTTP output message to write to Annotations @SuppressWarnings:deprecation @Override Exceptions IOException: in case of I/O errors HttpMessageNotWritableException: in case of conversion errors

protected void writeInternal(Message message, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException

Implements abstract org.springframework.http.converter.AbstractHttpMessageConverter.writeInternal.

Doc from org.springframework.http.converter.AbstractHttpMessageConverter.writeInternal.

Abstract template method that writes the actual body. Invoked from write.

Parameters

message:Message: the object to write to the output message
outputMessage:HttpOutputMessage: the HTTP output message to write to

Annotations

@SuppressWarnings:deprecation
@Override

Exceptions

IOException:: in case of I/O errors
HttpMessageNotWritableException:: in case of conversion errors

Modifier and Type	Method and Description
public void	merge(InputStream input, Charset charset, MediaType contentType, ExtensionRegistry extensionRegistry, Message.Builder builder)
public void	print(Message message, OutputStream output, MediaType contentType, Charset charset)
public MediaType[]	supportedMediaTypes()
public boolean	supportsWriteOnly(MediaType mediaType)

Modifier and Type	Field and Description
private final JsonFormat.Parser	parser
private final JsonFormat.Printer	printer

Modifier and Type	Method and Description
public void	merge(InputStream input, Charset charset, MediaType contentType, ExtensionRegistry extensionRegistry, Message.Builder builder) Implements org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter.ProtobufFormatSupport.merge.
public void	print(Message message, OutputStream output, MediaType contentType, Charset charset) Implements org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter.ProtobufFormatSupport.print.
public MediaType[]	supportedMediaTypes() Implements org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter.ProtobufFormatSupport.supportedMediaTypes.
public boolean	supportsWriteOnly(MediaType mediaType) Implements org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter.ProtobufFormatSupport.supportsWriteOnly.

public Class ProtobufHttpMessageConverter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface ProtobufHttpMessageConverter.ProtobufFormatSupport

Method Summary

Method Detail

pack-priv Class ProtobufHttpMessageConverter.ProtobufJavaUtilSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail