类 ProtobufHttpMessageConverter

字段详细资料

• DEFAULT_CHARSET

  public static final Charset DEFAULT_CHARSET

  The default charset used by the converter.

• PROTOBUF

  public static final MediaType PROTOBUF

  The media-type for protobuf application/x-protobuf.

• X_PROTOBUF_SCHEMA_HEADER

  public static final String X_PROTOBUF_SCHEMA_HEADER

  The HTTP header containing the protobuf schema.

  另请参阅:

  常量字段值

• X_PROTOBUF_MESSAGE_HEADER

  public static final String X_PROTOBUF_MESSAGE_HEADER

  The HTTP header containing the protobuf message.

  另请参阅:

  常量字段值

构造器详细资料

• ProtobufHttpMessageConverter

  public ProtobufHttpMessageConverter()

  Construct a new ProtobufHttpMessageConverter.

• ProtobufHttpMessageConverter

  @Deprecated
  public ProtobufHttpMessageConverter​(@Nullable
                                      ExtensionRegistryInitializer registryInitializer)

  已过时。

  as of Spring Framework 5.1, use ProtobufHttpMessageConverter(ExtensionRegistry) instead
  Construct a new ProtobufHttpMessageConverter with an initializer that allows the registration of message extensions.

  参数:

  registryInitializer - an initializer for message extensions

• ProtobufHttpMessageConverter

  public ProtobufHttpMessageConverter​(com.google.protobuf.ExtensionRegistry extensionRegistry)

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

  参数:

  extensionRegistry - the registry to populate

方法详细资料

• supports

  protected boolean supports​(Class<?> clazz)

  从类复制的说明: AbstractHttpMessageConverter
  Indicates whether the given class is supported by this converter.

  指定者:

  supports 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

  参数:

  clazz - the class to test for support

  返回:

  true if supported; false otherwise

• getDefaultContentType

  protected MediaType getDefaultContentType​(com.google.protobuf.Message message)

  从类复制的说明: AbstractHttpMessageConverter
  Returns the default content type for the given type. Called when AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) 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.

  覆盖:

  getDefaultContentType 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

  参数:

  message - the type to return the content type for

  返回:

  the content type, or null if not known

• readInternal

  protected com.google.protobuf.Message readInternal​(Class<? extends com.google.protobuf.Message> clazz,
                                                     HttpInputMessage inputMessage)
                                              throws IOException,
                                                     HttpMessageNotReadableException

  从类复制的说明: AbstractHttpMessageConverter
  Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage).

  指定者:

  readInternal 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

  参数:

  clazz - the type of object to return

  inputMessage - the HTTP input message to read from

  返回:

  the converted object

  抛出:

  IOException - in case of I/O errors

  HttpMessageNotReadableException - in case of conversion errors

• canWrite

  protected boolean canWrite​(@Nullable
                             MediaType mediaType)

  从类复制的说明: AbstractHttpMessageConverter
  Returns true if the given media type includes any of the supported media types.

  覆盖:

  canWrite 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

  参数:

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

  返回:

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

• writeInternal

  protected void writeInternal​(com.google.protobuf.Message message,
                               HttpOutputMessage outputMessage)
                        throws IOException,
                               HttpMessageNotWritableException

  从类复制的说明: AbstractHttpMessageConverter
  Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).

  指定者:

  writeInternal 在类中 AbstractHttpMessageConverter<com.google.protobuf.Message>

  参数:

  message - the object to write to the output message

  outputMessage - the HTTP output message to write to

  抛出:

  IOException - in case of I/O errors

  HttpMessageNotWritableException - in case of conversion errors