Package javax.ws.rs.ext
Interface MessageBodyWriter<T>
- Record Components:
T
- the type that can be written
public interface MessageBodyWriter<T>
Contract for a provider that supports the conversion of a Java type to a
stream. To add a
MessageBodyWriter
implementation, annotate the
implementation class with @Provider
.
A MessageBodyWriter
implementation may be annotated
with Produces
to restrict the media types for which it will
be considered suitable.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionlong
Called beforewriteTo
to ascertain the length in bytes of the serialized form oft
.boolean
isWriteable
(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) Ascertain if the MessageBodyWriter supports a particular type.void
writeTo
(T t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream) Write a type to an HTTP response.
-
Method Details
-
isWriteable
Ascertain if the MessageBodyWriter supports a particular type.- Parameters:
type
- the class of object that is to be written.genericType
- the type of object to be written, obtained either by reflection of a resource method return type or via inspection of the returned instance.GenericEntity
provides a way to specify this information at runtime.annotations
- an array of the annotations on the resource method that returns the object.mediaType
- the media type of the HTTP entity.- Returns:
- true if the type is supported, otherwise false.
-
getSize
Called beforewriteTo
to ascertain the length in bytes of the serialized form oft
. A non-negative return value is used in a HTTPContent-Length
header.- Parameters:
t
- the instance to writetype
- the class of object that is to be written.genericType
- the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance.GenericEntity
provides a way to specify this information at runtime.annotations
- an array of the annotations on the resource method that returns the object.mediaType
- the media type of the HTTP entity.- Returns:
- length in bytes or -1 if the length cannot be determined in advance
-
writeTo
void writeTo(T t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationExceptionWrite a type to an HTTP response. The response header map is mutable but any changes must be made before writing to the output stream since the headers will be flushed prior to writing the response body.- Parameters:
t
- the instance to write.type
- the class of object that is to be written.genericType
- the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance.GenericEntity
provides a way to specify this information at runtime.annotations
- an array of the annotations on the resource method that returns the object.mediaType
- the media type of the HTTP entity.httpHeaders
- a mutable map of the HTTP response headers.entityStream
- theOutputStream
for the HTTP entity. The implementation should not close the output stream.- Throws:
IOException
- if an IO error arisesWebApplicationException
- if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed.
-