org.glassfish.jersey.message.internal
Class AbstractCollectionJaxbProvider

java.lang.Object
  org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider<T>
      org.glassfish.jersey.message.internal.AbstractJaxbProvider<Object>
          org.glassfish.jersey.message.internal.AbstractCollectionJaxbProvider

All Implemented Interfaces:

MessageBodyReader<Object>, MessageBodyWriter<Object>

Direct Known Subclasses:

XmlCollectionJaxbProvider

public abstract class AbstractCollectionJaxbProvider
extends AbstractJaxbProvider<Object>

An abstract provider for T[], Collection<T>, and its subtypes as long as they have the public default constructor or are interfaces implemented by one the following classes:

• ArrayList
• LinkedList
• HashSet
• TreeSet
• Stack

T must be a JAXB type annotated with XmlRootElement.

Implementing classes may extend this class to provide specific marshalling and unmarshalling behaviour.

When unmarshalling a UnmarshalException will result in a WebApplicationException being thrown with a status of 400 (Client error), and a JAXBException will result in a WebApplicationException being thrown with a status of 500 (Internal Server error).

When marshalling a JAXBException will result in a WebApplicationException being thrown with a status of 500 (Internal Server error).

Author:

Paul Sandoz, Martin Matula

Nested Class Summary

static interface

AbstractCollectionJaxbProvider.JaxbTypeChecker This is to allow customized JAXB collections checking.

Field Summary

Fields inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

UTF8

Constructor Summary

AbstractCollectionJaxbProvider(Providers ps)

AbstractCollectionJaxbProvider(Providers ps, MediaType mt)

Method Summary

protected static Class	getElementClass(Class<?> type, Type genericType)
protected static String	getElementName(Class<?> elementType)
protected String	getRootElementName(Class<?> elementType)
protected abstract XMLStreamReader	getXMLStreamReader(Class<?> elementType, MediaType mediaType, Unmarshaller unmarshaller, InputStream entityStream) Get the XMLStreamReader for unmarshalling.
boolean	isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) Ascertain if the MessageBodyReader can produce an instance of a particular type.
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) Ascertain if the MessageBodyWriter supports a particular type.
Object	readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream inputStream) Read a type from the InputStream.
static boolean	verifyArrayType(Class type, AbstractCollectionJaxbProvider.JaxbTypeChecker checker) The method could be used to check if given type is an array of JAXB beans.
static boolean	verifyCollectionSubclass(Class<?> type)
static boolean	verifyGenericType(Type genericType, AbstractCollectionJaxbProvider.JaxbTypeChecker checker) The method could be used to check if given type is a collection of JAXB beans.
abstract void	writeList(Class<?> elementType, Collection<?> t, MediaType mediaType, Charset c, Marshaller m, OutputStream entityStream) Write a collection of JAXB objects as child elements of the root element.
void	writeTo(Object t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) Write a type to an HTTP message.

Methods inherited from class org.glassfish.jersey.message.internal.AbstractJaxbProvider

getMarshaller, getSAXSource, getStoredJaxbContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeader

Methods inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

getCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCollectionJaxbProvider

public AbstractCollectionJaxbProvider(Providers ps)

AbstractCollectionJaxbProvider

public AbstractCollectionJaxbProvider(Providers ps,
                                      MediaType mt)

Method Detail

isReadable

public boolean isReadable(Class<?> type,
                          Type genericType,
                          Annotation[] annotations,
                          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:

type - the class of instance to be produced.

genericType - 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, if one is not specified in the request then application/octet-stream is used.

Returns:

true if the type is supported, otherwise false.

isWriteable

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

Description copied from interface: MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

Parameters:

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

genericType - 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.

annotations - 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.

verifyCollectionSubclass

public static boolean verifyCollectionSubclass(Class<?> type)

verifyArrayType

public static boolean verifyArrayType(Class type,
                                      AbstractCollectionJaxbProvider.JaxbTypeChecker checker)

The method could be used to check if given type is an array of JAXB beans. It allows customizing the "is this a JAXB bean?" part.

Parameters:

type - the array to be checked

checker - allows JAXB bean check customization

Returns:

true if given type is an array of JAXB beans

verifyGenericType

public static boolean verifyGenericType(Type genericType,
                                        AbstractCollectionJaxbProvider.JaxbTypeChecker checker)

The method could be used to check if given type is a collection of JAXB beans. It allows customizing the "is this a JAXB bean?" part.

Parameters:

genericType - the type to be checked

checker - allows JAXB bean check customization

Returns:

true if given type is a collection of JAXB beans

writeTo

public final void writeTo(Object t,
                          Class<?> type,
                          Type genericType,
                          Annotation[] annotations,
                          MediaType mediaType,
                          MultivaluedMap<String,Object> httpHeaders,
                          OutputStream entityStream)
                   throws IOException

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:

t - the instance to write.

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

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

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

mediaType - the media type of the HTTP entity.

httpHeaders - a mutable map of the HTTP message headers.

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

Throws:

IOException - if an IO error arises.

writeList

public abstract void writeList(Class<?> elementType,
                               Collection<?> t,
                               MediaType mediaType,
                               Charset c,
                               Marshaller m,
                               OutputStream entityStream)
                        throws JAXBException,
                               IOException

Write a collection of JAXB objects as child elements of the root element.

Parameters:

elementType - the element type in the collection.

t - the collecton to marshall

mediaType - the media type

c - the charset

m - the marshaller

entityStream - the output stream to marshall the collection

Throws:

JAXBException

IOException

readFrom

public final Object readFrom(Class<Object> type,
                             Type genericType,
                             Annotation[] annotations,
                             MediaType mediaType,
                             MultivaluedMap<String,String> httpHeaders,
                             InputStream inputStream)
                      throws IOException

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:

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

genericType - 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.

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

inputStream - 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.

getXMLStreamReader

protected abstract XMLStreamReader getXMLStreamReader(Class<?> elementType,
                                                      MediaType mediaType,
                                                      Unmarshaller unmarshaller,
                                                      InputStream entityStream)
                                               throws XMLStreamException

Get the XMLStreamReader for unmarshalling.

Parameters:

elementType - the individual element type.

mediaType - the media type.

unmarshaller - the unmarshaller as a carrier of possible config options.

entityStream - the input stream.

Returns:

the XMLStreamReader.

Throws:

XMLStreamException

getElementClass

protected static Class getElementClass(Class<?> type,
                                       Type genericType)

getRootElementName

protected final String getRootElementName(Class<?> elementType)

getElementName

protected static final String getElementName(Class<?> elementType)