public class

ByteArrayHttpMessageConverter

extends AbstractHttpMessageConverter<T>
java.lang.Object
   ↳ org.springframework.http.converter.AbstractHttpMessageConverter<T>
     ↳ org.springframework.http.converter.ByteArrayHttpMessageConverter

Class Overview

Implementation of HttpMessageConverter that can read and write byte arrays.

By default, this converter supports all media types (*/*), and writes with a Content-Type of application/octet-stream. This can be overridden by setting the supportedMediaTypes property.

Summary

[Expand]
Inherited Fields
From class org.springframework.http.converter.AbstractHttpMessageConverter
Public Constructors
ByteArrayHttpMessageConverter()
Creates a new instance of the ByteArrayHttpMessageConverter.
Public Methods
byte[] readInternal(Class clazz, HttpInputMessage inputMessage)
Abstract template method that reads the actualy object.
boolean supports(Class<?> clazz)
Indicates whether the given class is supported by this converter.
Protected Methods
Long getContentLength(byte[] bytes, MediaType contentType)
Returns the content length for the given type.
void writeInternal(byte[] bytes, HttpOutputMessage outputMessage)
Abstract template method that writes the actual body.
[Expand]
Inherited Methods
From class org.springframework.http.converter.AbstractHttpMessageConverter
From class java.lang.Object
From interface org.springframework.http.converter.HttpMessageConverter

Public Constructors

public ByteArrayHttpMessageConverter ()

Creates a new instance of the ByteArrayHttpMessageConverter.

Public Methods

public byte[] readInternal (Class clazz, HttpInputMessage inputMessage)

Abstract template method that reads the actualy object. Invoked from read(Class, HttpInputMessage).

Parameters
clazz the type of object to return
inputMessage the HTTP input message to read from
Returns
  • the converted object
Throws
IOException

public boolean supports (Class<?> clazz)

Indicates whether the given class is supported by this converter.

Parameters
clazz the class to test for support
Returns
  • true if supported; false otherwise

Protected Methods

protected Long getContentLength (byte[] bytes, MediaType contentType)

Returns the content length for the given type.

By default, this returns null, meaning that the content length is unknown. Can be overridden in subclasses.

Parameters
bytes the type to return the content length for
Returns
  • the content length, or null if not known

protected void writeInternal (byte[] bytes, HttpOutputMessage outputMessage)

Abstract template method that writes the actual body. Invoked from write(T, MediaType, HttpOutputMessage).

Parameters
bytes the object to write to the output message
outputMessage the message to write to
Throws
IOException