org.jboss.resteasy.plugins.providers

Class DocumentProvider

java.lang.Object

org.jboss.resteasy.plugins.providers.AbstractEntityProvider<Document>

org.jboss.resteasy.plugins.providers.DocumentProvider

All Implemented Interfaces:

MessageBodyReader<Document>, MessageBodyWriter<Document>

@Provider
 @Produces(value={"text/*+xml","application/*+xml"})
 @Consumes(value={"text/*+xml","application/*+xml"})
public class DocumentProvider
extends AbstractEntityProvider<Document>

Provider that reads and writes org.w3c.dom.Document

Version:

$Revision: $

Author:

Constructor Summary

Constructors

Constructor and Description
DocumentProvider(ResteasyConfiguration config)

Method Summary

Modifier and Type	Method and Description
boolean	isReadable(Class<?> clazz, Type type, Annotation[] annotation, MediaType mediaType) Ascertain if the MessageBodyReader can produce an instance of a particular type.
boolean	isWriteable(Class<?> clazz, Type type, Annotation[] annotation, MediaType mediaType) Ascertain if the MessageBodyWriter supports a particular type.
Document	readFrom(Class<Document> clazz, Type type, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> headers, InputStream input) Read a type from the InputStream.
void	writeTo(Document document, Class<?> clazz, Type type, Annotation[] annotation, MediaType mediaType, MultivaluedMap<String,Object> headers, OutputStream output) Write a type to an HTTP message.

Methods inherited from class org.jboss.resteasy.plugins.providers.AbstractEntityProvider

getSize

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentProvider

public DocumentProvider(@Context
                        ResteasyConfiguration config)

Method Detail

isReadable

public boolean isReadable(Class<?> clazz,
                          Type type,
                          Annotation[] annotation,
                          MediaType mediaType)

Description copied from interface: MessageBodyReader

Ascertain if the MessageBodyReader can produce an instance of a particular type. The type parameter gives the class of the instance that should be produced, the genericType parameter gives the java.lang.reflect.Type of the instance that should be produced. E.g. if the instance to be produced is List<String>, the type parameter will be java.util.List and the genericType parameter will be java.lang.reflect.ParameterizedType.

Parameters:

clazz - the class of instance to be produced.

type - the type of instance to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Method.getGenericParameterTypes.

annotation - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.

mediaType - the media type of the HTTP entity, if one is not specified in the request then application/octet-stream is used.

Returns:

true if the type is supported, otherwise false.

readFrom

public Document readFrom(Class<Document> clazz,
                         Type type,
                         Annotation[] annotations,
                         MediaType mediaType,
                         MultivaluedMap<String,String> headers,
                         InputStream input)
                  throws IOException,
                         WebApplicationException

Description copied from interface: MessageBodyReader

Read a type from the InputStream.

In case the entity input stream is empty, the reader is expected to either return a Java representation of a zero-length entity or throw a NoContentException in case no zero-length entity representation is defined for the supported Java type. A NoContentException, if thrown by a message body reader while reading a server request entity, is automatically translated by JAX-RS server runtime into a BadRequestException wrapping the original NoContentException and rethrown for a standard processing by the registered exception mappers.

Parameters:

clazz - the type that is to be read from the entity stream.

type - the type of instance to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Method.getGenericParameterTypes.

annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.

mediaType - the media type of the HTTP entity.

headers - the read-only HTTP headers associated with HTTP entity.

input - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.

Returns:

the type that was read from the stream. In case the entity input stream is empty, the reader is expected to either return an instance representing a zero-length entity or throw a NoContentException in case no zero-length entity representation is defined for the supported Java type.

Throws:

IOException - if an IO error arises. In case the entity input stream is empty and the reader is not able to produce a Java representation for a zero-length entity, NoContentException is expected to be thrown.

WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed.

isWriteable

public boolean isWriteable(Class<?> clazz,
                           Type type,
                           Annotation[] annotation,
                           MediaType mediaType)

Description copied from interface: MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

Parameters:

clazz - the class of instance that is to be written.

type - the type of instance 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.

annotation - an array of the annotations attached to the message entity instance.

mediaType - the media type of the HTTP entity.

Returns:

true if the type is supported, otherwise false.

writeTo

public void writeTo(Document document,
                    Class<?> clazz,
                    Type type,
                    Annotation[] annotation,
                    MediaType mediaType,
                    MultivaluedMap<String,Object> headers,
                    OutputStream output)
             throws IOException,
                    WebApplicationException

Description copied from interface: MessageBodyWriter

Write a type to an HTTP message. The message 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 message body.

Parameters:

document - the instance to write.

clazz - the class of instance that is to be written.

type - the type of instance to be written. GenericEntity provides a way to specify this information at runtime.

annotation - an array of the annotations attached to the message entity instance.

mediaType - the media type of the HTTP entity.

headers - a mutable map of the HTTP message headers.

output - the OutputStream for the HTTP entity. The implementation should not close the output stream.

Throws:

IOException - if an IO error arises.

WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the message being committed.