Error "No factory for class com.ctc.wstx.evt.WstxEventReader" with Woodstox

[sammefford]

Woodstox is a popular implementation of XMLEventReader among other things. But since com.ctc.wstx.evt.WstxEventReader only implements XMLEventReader through two hops, our code doesn't recognize it as implementing XMLEventReader. Instead we get the following error when we add woodstox to pom.xml by adding:

<dependency>
  <groupId>org.codehaus.woodstox</groupId>
  <artifactId>woodstox-core-asl</artifactId>
  <version>4.4.1</version>
</dependency>

then run

mvn test -Dtest=HandleAsTest

we get the following

java.lang.IllegalArgumentException: No factory for class com.ctc.wstx.evt.WstxEventReader
    at com.marklogic.client.impl.HandleFactoryRegistryImpl.makeHandle(HandleFactoryRegistryImpl.java:98)
    at com.marklogic.client.impl.DocumentManagerImpl.writeAs(DocumentManagerImpl.java:608)
    at com.marklogic.client.impl.DocumentManagerImpl.writeAs(DocumentManagerImpl.java:575)
    at com.marklogic.client.test.HandleAsTest.testBuiltinReadWrite(HandleAsTest.java:190)

Which means DocumentManager.writeAs can't find a handle registered for WstxEventReader or any of the interfaces it implements.

[sammefford]

This happens because we only look at interfaces directly implemented and WstxEventReader only directly implements XMLEventReader2 which in turn implements XMLEventReader. So it's two hops to get to XMLEventReader, which is a registered class.

I believe the solution is to stop looking at what interfaces the provided class implements and instead run through all the registered classes to see if the provided class isAssignableFrom one of the registered classes.

[sammefford]

Ajit, this is yet another issue we encountered when adding woodstox to the classpath. I separated this from #388 because it seems like a different issue to me. But to test this fix just add woodstox to the classpath / gradle dependencies and you should see errors like the above without this fix and those errors should disappear with this fix.

[georgeajit]

Tested on three different machines / IDE with the latest git clone. On Mac's Eclipse env, there are no issues. However, on two Windows machines, Eclipse IDE complains on compilation, while building the project. The compilation errors are something like this:

The method newFactory() is undefined for the type XMLInputFactory   HandleAsTest.java   /java-client-api-dev/src/test/java/com/marklogic/client/test    line 188    Java Problem

It looks like the Maven dependency is not the last one in the order of the build classpath. The JRE System Library was the last one in the order. When Maven Dependencies manually moved to the last; with JRE being on the top of Maven Dependencies, the compilations errors cleared out.

Sam, assigning this back to you for time being, since .classpath changes do not seem to work at least for Windows.