Aug 13, 2015

Sharing Grails HAL and JSON Renderers

Grails provides nice features for creating web services, customization is usually terse. According to the “Registering Custom Objects Marshallers” section of the Grails User Guide, custom object marshallers can registered using a simple closure. However, it turns out that these marshallers do not apply if you are serving HAL (HATEOS) in addition to JSON/XML. This post will detail a method to share marshallers across XML, JSON and HAL flavors of web services.

Create Adapter for Gson

The problem happens because the HAL renderer is using Gson for marshalling which does fit the following pattern in the Grails User Guide:

In order to include HAL in this list, we need to create an adapter class to register the closure. The adapter will then work the closure into the Gson library. Note that Gson performs input and output processing, the approach here only addresses output processing.

We need a test, right? Of course we do!

Adapter Registration

Now that we have an adapter we need to register it as a Spring bean to make it available in BootStrap.groovy.

Marshaller Registration

Now for the part for which we’ve been waiting. These are only examples and not necessary to make this work for your own marshallers.

The new GSONFAC has the registerObjectMarshaller method like JSON and XML. Using the Groovy splat operator, we can easily re-use the closure.

This was a difficult find for me, why the JSON tests were working but HAL was not. Hopefully this post will save you time and write less code!

About the Author

Patrick Double profile.

Patrick Double

Principal Technologist

I have been coding since 6th grade, circa 1986, professionally (i.e. college graduate) since 1998 when I graduated from the University of Nebraska-Lincoln. Most of my career has been in web applications using JEE. I work the entire stack from user interface to database.   I especially like solving application security and high availability problems.

One thought on “Sharing Grails HAL and JSON Renderers

Leave a Reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
Android Development for iOS Developers
Android development has greatly improved since the early days. Maybe you tried it out when Android development was done in Eclipse, emulators were slow and buggy, and Java was the required language. Things have changed […]
Add a custom object to your Liquibase diff
Adding a custom object to your liquibase diff is a pretty simple two step process. Create an implementation of DatabaseObject Create an implementation of SnapshotGenerator In my case I wanted to add tracking of Stored […]
Keeping Secrets Out of Terraform State
There are many instances where you will want to create resources via Terraform with secrets that you just don’t want anyone to see. These could be IAM credentials, certificates, RDS DB credentials, etc. One problem […]
Validating Terraform Plans using Open Policy Agent
When developing infrastructure as code using terraform, it can be difficult to test and validate changes without executing the code against a real environment. The feedback loop between writing a line of code and understanding […]