Classloader problem with Java 7 and WebServices in Grails

Our Grails 2.1 application communicates with external SOAP WebServices. It worked fine as we follow Software Guy’s advices from this blog post. Recently, our client required new functionality – export to Excel. We’ve used Apache POI libraries for expor…

Our Grails 2.1 application communicates with external SOAP WebServices. It worked fine as we follow Software Guy’s advices from this blog post.

Recently, our client required new functionality – export to Excel. We’ve used Apache POI libraries for export. And our web service communication died. All it gave us was:

Caused by: java.lang.LinkageError: loader constraint violation: when resolving field "DATETIME" the class loader (instance of org/codehaus/groovy/grails/cli/support/GrailsRootLoader) of the referring class, javax/xml/datatype/DatatypeConstants, and the class loader (instance of <bootloader>) for the field's resolved type, ants, have different Class objects for that type</bootloader>

This message is strange, LinkageError can give you creeps. But read carefully: resolved type, ants? Something is definitely wrong here. After many searches it turned out that Java 7 already contains some conflicting classes from stax-api.jar. To solve this problem there are two thing you need to do:

  1. Ensure that your jaxws-rt dependency is runtime, not compile! // http://asoftwareguy.com/2012/02/25/web-service-clients-where-grails-lost-its-mojo/
    // Do not remove this dependency. Web services need this to work flawlessly.
    runtime (‘com.sun.xml.ws:jaxws-rt:2.1.4’)
  2. Create dependency report (grails dependency-report), search and exclude all stax-api dependencies other than jaxws-rt like this example:
    compile ('org.apache.poi:poi-ooxml-3.7') {
        excludes 'stax-api'
    }
    compile ('org.apache.poi:poi-ooxml-schemas:3.7') {
        excludes 'stax-api'
    }
You May Also Like

Grails render as JSON catch

One of a reasons your controller doesn't render a proper response in JSON format might be wrong package name that you use. It is easy to overlook. Import are on top of a file, you look at your code and everything seems to be fine. Except response is still not in JSON format.

Consider this simple controller:

class RestJsonCatchController {
def grailsJson() {
render([first: 'foo', second: 5] as grails.converters.JSON)
}

def netSfJson() {
render([first: 'foo', second: 5] as net.sf.json.JSON)
}
}

And now, with finger crossed... We have a winner!

$ curl localhost:8080/example/restJsonCatch/grailsJson
{"first":"foo","second":5}
$ curl localhost:8080/example/restJsonCatch/netSfJson
{first=foo, second=5}

As you can see only grails.converters.JSON converts your response to JSON format. There is no such converter for net.sf.json.JSON, so Grails has no converter to apply and it renders Map normally.

Conclusion: always carefully look at your imports if you're working with JSON in Grails!

Edit: Burt suggested that this is a bug. I've submitted JIRA issue here: GRAILS-9622 render as class that is not a codec should throw exception