org.springframework.http.converter
Class ResourceHttpMessageConverter

java.lang.Object
  org.springframework.http.converter.ResourceHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<Resource>

public class ResourceHttpMessageConverter
extends java.lang.Object
implements HttpMessageConverter<Resource>

Implementation of HttpMessageConverter that can read and write Resources.

By default, this converter can read all media types. The Java Activation Framework (JAF) - if available - is used to determine the Content-Type of written resources. If JAF is not available, application/octet-stream is used.

Since:

3.0.2

Author:

Arjen Poutsma

Nested Class Summary

private static class

ResourceHttpMessageConverter.ActivationMediaTypeFactory Inner class to avoid hard-coded JAF dependency.

Field Summary

private static boolean

jafPresent

Constructor Summary

ResourceHttpMessageConverter()

Method Summary

boolean	canRead(java.lang.Class<?> clazz, MediaType mediaType) Indicates whether the given class can be read by this converter.
boolean	canWrite(java.lang.Class<?> clazz, MediaType mediaType) Indicates whether the given class can be written by this converter.
protected java.lang.Long	getContentLength(Resource resource, MediaType contentType)
private MediaType	getContentType(Resource resource)
java.util.List<MediaType>	getSupportedMediaTypes() Return the list of MediaType objects supported by this converter.
Resource	read(java.lang.Class<? extends Resource> clazz, HttpInputMessage inputMessage) Read an object of the given type form the given input message, and returns it.
void	write(Resource resource, MediaType contentType, HttpOutputMessage outputMessage) Write an given object to the given output message.

Methods inherited from class java.lang.Object

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

Field Detail

jafPresent

private static final boolean jafPresent

Constructor Detail

ResourceHttpMessageConverter

public ResourceHttpMessageConverter()

Method Detail

canRead

public boolean canRead(java.lang.Class<?> clazz,
                       MediaType mediaType)

Description copied from interface: HttpMessageConverter

Indicates whether the given class can be read by this converter.

Specified by:

canRead in interface HttpMessageConverter<Resource>

Parameters:

clazz - the class to test for readability

mediaType - the media type to read, can be null if not specified. Typically the value of a Content-Type header.

Returns:

true if readable; false otherwise

canWrite

public boolean canWrite(java.lang.Class<?> clazz,
                        MediaType mediaType)

Description copied from interface: HttpMessageConverter

Indicates whether the given class can be written by this converter.

Specified by:

canWrite in interface HttpMessageConverter<Resource>

Parameters:

clazz - the class to test for writability

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

Returns:

true if writable; false otherwise

getSupportedMediaTypes

public java.util.List<MediaType> getSupportedMediaTypes()

Description copied from interface: HttpMessageConverter

Return the list of MediaType objects supported by this converter.

Specified by:

getSupportedMediaTypes in interface HttpMessageConverter<Resource>

Returns:

the list of supported media types

read

public Resource read(java.lang.Class<? extends Resource> clazz,
                     HttpInputMessage inputMessage)
              throws java.io.IOException,
                     HttpMessageNotReadableException

Description copied from interface: HttpMessageConverter

Read an object of the given type form the given input message, and returns it.

Specified by:

read in interface HttpMessageConverter<Resource>

Parameters:

clazz - the type of object to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.

inputMessage - the HTTP input message to read from

Returns:

the converted object

Throws:

java.io.IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

write

public void write(Resource resource,
                  MediaType contentType,
                  HttpOutputMessage outputMessage)
           throws java.io.IOException,
                  HttpMessageNotWritableException

Description copied from interface: HttpMessageConverter

Write an given object to the given output message.

Specified by:

write in interface HttpMessageConverter<Resource>

Parameters:

resource - the object to write to the output message. The type of this object must have previously been passed to the canWrite method of this interface, which must have returned true.

contentType - the content type to use when writing. May be null to indicate that the default content type of the converter must be used. If not null, this media type must have previously been passed to the canWrite method of this interface, which must have returned true.

outputMessage - the message to write to

Throws:

java.io.IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

getContentType

private MediaType getContentType(Resource resource)

getContentLength

protected java.lang.Long getContentLength(Resource resource,
                                          MediaType contentType)
                                   throws java.io.IOException

Throws:

java.io.IOException