|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.http.converter.ResourceHttpMessageConverter
public class ResourceHttpMessageConverter
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.
Constructor Summary | |
---|---|
ResourceHttpMessageConverter()
|
Method Summary | |
---|---|
boolean |
canRead(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be read by this converter. |
boolean |
canWrite(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be written by this converter. |
protected Long |
getContentLength(Resource resource,
MediaType contentType)
|
List<MediaType> |
getSupportedMediaTypes()
Return the list of MediaType objects supported by this converter. |
Resource |
read(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 |
Constructor Detail |
---|
public ResourceHttpMessageConverter()
Method Detail |
---|
public boolean canRead(Class<?> clazz, MediaType mediaType)
HttpMessageConverter
canRead
in interface HttpMessageConverter<Resource>
clazz
- the class to test for readabilitymediaType
- the media type to read, can be null
if not specified.
Typically the value of a Content-Type
header.
true
if readable; false
otherwisepublic boolean canWrite(Class<?> clazz, MediaType mediaType)
HttpMessageConverter
canWrite
in interface HttpMessageConverter<Resource>
clazz
- the class to test for writabilitymediaType
- the media type to write, can be null
if not specified.
Typically the value of an Accept
header.
true
if writable; false
otherwisepublic List<MediaType> getSupportedMediaTypes()
HttpMessageConverter
MediaType
objects supported by this converter.
getSupportedMediaTypes
in interface HttpMessageConverter<Resource>
public Resource read(Class<? extends Resource> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException
HttpMessageConverter
read
in interface HttpMessageConverter<Resource>
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
IOException
- in case of I/O errors
HttpMessageNotReadableException
- in case of conversion errorspublic void write(Resource resource, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException
HttpMessageConverter
write
in interface HttpMessageConverter<Resource>
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
IOException
- in case of I/O errors
HttpMessageNotWritableException
- in case of conversion errorsprotected Long getContentLength(Resource resource, MediaType contentType) throws IOException
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |