JAX-RS 2.0: Custom Content Handling
JAX-RS 2.0: Custom Content Handling
Join the DZone community and get the full member experience.Join For Free
The CMS developers love. Open Source, API-first and Enterprise-grade. Try BloomReach CMS for free.
I tried to think of a better title, but failed to come up with one! Please bear with me...
The JAX-RS 2.0 specification allows us to seamlessly marshal/unmarshal JAXB objects to/from HTTP request/response bodies. Simply put, we can just work with the domain objects without being worried about the low level XML serialization within JAX-RS based solutions.
Before we begin, here is the GitHub link to the source code referenced below - not much, but just in case you need to peek in.
- Java EE 7 (of course!)
- JDK 8- don't get excited, there are no lambdas in there as yet!
- Netbeans 8
- Wildfly 8 and GlassFish 4 (yes, tested on both servers) - it's just about switching servers in Netbeans and takes anywhere b/w 15-30 seconds. So it's not really that big a deal ;-)
Let us first go through the use cases which demonstrates the out-of-the-box capabilities of JAX-RS implementations in order to deal with JAXB annotated entities/domain objects over the wire.
Here is a simple example where in we try to 'get' a representation of our domain object which happens to be JAXB annotated POJO:
The below JSON response is obtained when we fire a GET HTTP request. The tool being used here is Postman:
Similarly, the XML response can also be observed by simply toggling the AcceptHTTP header to application/xml:
Let's see a case where in we try to 'post' a representation of our domain object (XML/JSON) over the wire:
Fire POST request via Postman:
Snippet for the STDOUT in the server logs (as per code above):
So, we just saw, in JAXRS, domain objects decorated with JAXB annotations allows can be exchanged over the wire in both XML and JSON formats without breaking a sweat!
Consider a scenario where we already have rich domain Java objects available to us. But:
- We do not have access to the source code
- We cannot really annotate them with JAXB annotations
- The domain entities are legacy POJOs which are not JAXB compatible
Here is where we can leverage customized content handling feature available in JAX-RS 2.0. The MessageBodyWriter and MessageBodyReader interfaces provide us a way to plug in our customized marshalling/unmarshalling mechanism and allow the JAX-RS run time to take care of the rest!
The example which follows primarily deals with XML and JSON formats, but please note that these interfaces can be used for 'any' data formats - the internet is teeming with hundreds of these with new ones popping up daily!
Let's see some code... again...
To begin with, in order to simulate a get scenario, let's just return an instance of a Legacy POJO class from our JAXRS resource method. It's not JAXB compatible/we do not have the source code to decorate it via JAXB annotations:
How do you think this will get serialized to XML over the wire? Our custom implementation of the javax.ws.rs.ext.MessageBodyWriter interface will facilitate this.
This interface has 3 abstract methods which one would need to implement. The snippet showcases the writeTo() method, which contains the bulk of the transformation logic.
You can read about it further in the Java EE 7 javadocs
So, as usual, we ask Postman to validate things for us, and this is what he had to say. No hassles! Imagine if the Legacy POJO representation is fetched from the persistent (DB) store directly - all you need to do is return it since the on-the-wire representation has been taken care of:
Now, the reverse scenario - post an XML representation from our client layer and watch it getting serialized into the Legacy POJO instance. Want to persist it ? Sure, go ahead and fire the Entity Manager ;) (don't forget @javax.ejb.Stateless !)
How do you think the XML payload sent by the client get converted to our Leagcy POJO instance over the wire? Our custom implementation of the javax.ws.rs.ext.MessageBodyReader interface will make this happen:
Call upon Postman, post an XML representation over the wire, and see the results:
Just to ensure that our Legacy POJO indeed got serialized - confirmed via the server STDOUT logs:
So, with the help of a trivial example, we saw how easy it is for us to define custom transformation/wrapper-like logic for handling custom domain objects/entities/POJOs within JAXRS based implementations.
Couple of observations before signing off:
- JAXRS implementation in GlassFish4 does not support seamless JSON serialization/deserialization via a JAXB decorated POJO. Wildfly 8 worked like a charm! Kudos!
- On delegation of the marshall/unmarshall process to entity interceptors (reader/writer implementations), the seamless JSON support ceased to work (both in GlassFish as well as Wildfly). Not sure why. I am guessing the the JAXRS implementation is directly fetching the payload from/writing payload to the Input/Output streams respectively, and somehow there is no intermediate layer to factor in the content negotiation
I hope I am not missing a trick here! If you think so, please be kind enough to give me a heads up :-)
Well, that's it for now! Happy coding............!
Opinions expressed by DZone contributors are their own.