JAXB Example

This example demonstrates how to use JAXB types with resource classes and the JAX-RS Client API.

The following JAXB types are supported and demonstrated:

• JAXB classes annotated with @XmlRootElement
• JAXB classes annotated with @XmlType
• JAXBElement<T> where T is a JAXB xml type that may or may not be annotated with @XmlType
• List<T>, Collection<T>, and T[] where T is a JAXB class annotated with @XmlRootElement or @XmlType

It also shows how to use @XmlHeader annotation to specify the header of the XML responses.

Contents

The mapping of the URI path space is presented in the following table:

JAXB classes annotated with @XmlRootElement may be produced and consumed. JAXB classses annotated with @XmlType can only be consumed hence why only the POST method is supported for the resources associated with XmlType. This is because the JAXB requires enough information to serialize the JAXB instance to a well-formed XML document. The same rules apply to collections of such classes.

For the serialization of a Collection of JAXB type, or an array, Jersey will automatically derive the XML root element of the XML document to serialize from the XML name of the JAXB class annoated with @XmlRootElement.

Running the Example

Run the example as follows:

mvn clean compile exec:java

This deploys the example using Grizzly container. You can access the application at:

• http://localhost:8080/jaxb/jaxb/XmlRootElement
• http://localhost:8080/jaxb/jaxb/XmlRootElementWithHeader
• http://localhost:8080/jaxb/jaxb/JAXBElement
• http://localhost:8080/jaxb/jaxb/collection/XmlRootElement
• http://localhost:8080/jaxb/jaxb/array/XmlRootElement

or you can post an xml entity:

curl -v -X POST http://localhost:8080/jaxb/jaxb/XmlRootElement -H “Content-Type:application/xml” -d ' xml root element '

You can see test classes at src/main/test subdirectory for detailed information how to consume the service using JAX-RS Client API