Adds Builder class to JAXBDecoder for disabling namespace-awareness. (OpenFeign#471)

chrismanning · spencergibb · commit 12e61b91c91d · 2016-10-11T12:19:43.000-04:00
Makes the SAX parser namespace aware by default (as it was prior to OpenFeign#415). Fixes OpenFeign#456
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+### Version 9.4
+* Adds Builder class to JAXBDecoder for disabling namespace-awareness (defaults to true).
+
 ### Version 9.3
 * Adds `FallbackFactory`, allowing access to the cause of a Hystrix fallback
 * Adds support for encoded parameters via `@Param(encoded = true)`
diff --git a/jaxb/README.md b/jaxb/README.md
@@ -16,3 +16,12 @@ Response response = Feign.builder()
                          .decoder(new JAXBDecoder(jaxbFactory))
                          .target(Response.class, "https://apihost");
 ```
+
+`JAXBDecoder` can also be created with a builder to allow overriding some default parser options:
+
+```java
+JAXBDecoder jaxbDecoder = new JAXBDecoder.Builder()
+    .withJAXBContextFactory(jaxbFactory)
+    .withNamespaceAware(false) // true by default
+    .build();
+```
diff --git a/jaxb/src/main/java/feign/jaxb/JAXBDecoder.java b/jaxb/src/main/java/feign/jaxb/JAXBDecoder.java
@@ -50,9 +50,16 @@
 public class JAXBDecoder implements Decoder {
 
   private final JAXBContextFactory jaxbContextFactory;
+  private final boolean namespaceAware;
 
   public JAXBDecoder(JAXBContextFactory jaxbContextFactory) {
     this.jaxbContextFactory = jaxbContextFactory;
+    this.namespaceAware = true;
+  }
+
+  private JAXBDecoder(Builder builder) {
+    this.jaxbContextFactory = builder.jaxbContextFactory;
+    this.namespaceAware = builder.namespaceAware;
   }
 
   @Override
@@ -72,6 +79,7 @@ public Object decode(Response response, Type type) throws IOException {
       saxParserFactory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
       saxParserFactory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", false);
       saxParserFactory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
+      saxParserFactory.setNamespaceAware(namespaceAware);
 
       Source source = new SAXSource(saxParserFactory.newSAXParser().getXMLReader(), new InputSource(response.body().asInputStream()));
       Unmarshaller unmarshaller = jaxbContextFactory.createUnmarshaller((Class) type);
@@ -88,4 +96,30 @@ public Object decode(Response response, Type type) throws IOException {
       }
     }
   }
+
+  public static class Builder {
+    private boolean namespaceAware = true;
+    private JAXBContextFactory jaxbContextFactory;
+
+    /**
+     * Controls whether the underlying XML parser is namespace aware.
+     * Default is true.
+     */
+    public Builder withNamespaceAware(boolean namespaceAware) {
+      this.namespaceAware = namespaceAware;
+      return this;
+    }
+
+    public Builder withJAXBContextFactory(JAXBContextFactory jaxbContextFactory) {
+      this.jaxbContextFactory = jaxbContextFactory;
+      return this;
+    }
+
+    public JAXBDecoder build() {
+      if (jaxbContextFactory == null) {
+        throw new IllegalStateException("JAXBContextFactory must be non-null");
+      }
+      return new JAXBDecoder(this);
+    }
+  }
 }
