Add XML examples.

gk-brown · gk-brown · commit d4d40684ded4 · 2019-01-20T12:17:53.000-05:00
diff --git a/httprpc-test/src/main/java/org/httprpc/test/mongodb/RestaurantService.java b/httprpc-test/src/main/java/org/httprpc/test/mongodb/RestaurantService.java
@@ -25,6 +25,7 @@
 import org.httprpc.WebService;
 import org.httprpc.io.CSVEncoder;
 import org.httprpc.io.JSONEncoder;
+import org.httprpc.io.XMLEncoder;
 import org.httprpc.RequestMethod;
 import org.httprpc.Response;
 
@@ -85,6 +86,12 @@ public Iterator<Document> iterator() {
                 CSVEncoder csvEncoder = new CSVEncoder(Arrays.asList("name", "address.building", "address.street", "borough", "cuisine"));
 
                 csvEncoder.write(cursorAdapter, getResponse().getOutputStream());
+            } else if (format.equals("xml")) {
+                getResponse().setContentType("text/xml");
+
+                XMLEncoder xmlEncoder = new XMLEncoder();
+
+                xmlEncoder.write(cursorAdapter, getResponse().getOutputStream());
             } else {
                 throw new UnsupportedOperationException();
             }
diff --git a/httprpc-test/src/main/java/org/httprpc/test/mysql/PetService.java b/httprpc-test/src/main/java/org/httprpc/test/mysql/PetService.java
@@ -33,6 +33,7 @@
 import org.httprpc.WebService;
 import org.httprpc.io.CSVEncoder;
 import org.httprpc.io.JSONEncoder;
+import org.httprpc.io.XMLEncoder;
 import org.httprpc.RequestMethod;
 import org.httprpc.ResourcePath;
 import org.httprpc.Response;
@@ -104,6 +105,12 @@ public void getPets(String owner, String format) throws SQLException, IOExceptio
                     CSVEncoder csvEncoder = new CSVEncoder(Arrays.asList("name", "species", "sex", "birth"));
 
                     csvEncoder.write(resultSetAdapter, getResponse().getOutputStream());
+                } else if (format.equals("xml")) {
+                    getResponse().setContentType("text/xml");
+
+                    XMLEncoder xmlEncoder = new XMLEncoder();
+
+                    xmlEncoder.write(resultSetAdapter, getResponse().getOutputStream());
                 } else {
                     throw new UnsupportedOperationException();
                 }
diff --git a/httprpc-test/src/main/resources/org/httprpc/test/mongodb/RestaurantService.properties b/httprpc-test/src/main/resources/org/httprpc/test/mongodb/RestaurantService.properties
@@ -2,4 +2,4 @@ RestaurantService = Example service based on MongoDB sample "restaurants" datase
 
 getRestaurants = Retreives a list of all restaurants in a given zip code.
 getRestaurants.zipCode = The zip code to search.
-getRestaurants.format = The response format (either "json" or "csv"). The default is "json".
+getRestaurants.format = The response format ("json", "csv", or "xml"). The default is "json".
diff --git a/httprpc-test/src/main/resources/org/httprpc/test/mysql/PetService.properties b/httprpc-test/src/main/resources/org/httprpc/test/mysql/PetService.properties
@@ -2,6 +2,6 @@ PetService = Example service based on MySQL sample "menagerie" database.
 
 getPets = Retreives a list of all pets belonging to a given owner.
 getPets.owner = The pet owner.
-getPets.format = The response format (either "json" or "csv"). The default is "json".
+getPets.format = The response format ("json", "csv", or "xml"). The default is "json".
 
 getAverageAge = Calculates the average age (in years) of all pets in the database.
diff --git a/httprpc-test/src/main/webapp/index.jsp b/httprpc-test/src/main/webapp/index.jsp
@@ -187,13 +187,15 @@
 <br/>
 <a href="${pageContext.request.contextPath}/restaurants?zipCode=10462">Restaurants (JSON)</a><br/>
 <a href="${pageContext.request.contextPath}/restaurants?zipCode=10462&format=csv">Restaurants (CSV)</a><br/>
+<a href="${pageContext.request.contextPath}/restaurants?zipCode=10462&format=xml">Restaurants (XML)</a><br/>
 
 <h2>MySQL</h2>
 
 <a href="${pageContext.request.contextPath}/pets?api">Pets (API)</a><br/>
 <br/>
 <a href="${pageContext.request.contextPath}/pets?owner=Gwen">Pets (JSON)</a><br/>
 <a href="${pageContext.request.contextPath}/pets?owner=Gwen&format=csv">Pets (CSV)</a><br/>
+<a href="${pageContext.request.contextPath}/pets?owner=Gwen&format=xml">Pets (XML)</a><br/>
 <br/>
 <a href="${pageContext.request.contextPath}/pets/average-age">Average Age</a><br/>
 
diff --git a/httprpc/src/main/java/org/httprpc/io/XMLEncoder.java b/httprpc/src/main/java/org/httprpc/io/XMLEncoder.java
@@ -31,22 +31,6 @@
  * XML encoder.
  */
 public class XMLEncoder {
-    private String rootElementName;
-
-    /**
-     * Constructs a new XML encoder.
-     *
-     * @param rootElementName
-     * The root element name.
-     */
-    public XMLEncoder(String rootElementName) {
-        if (rootElementName == null) {
-            throw new IllegalArgumentException();
-        }
-
-        this.rootElementName = rootElementName;
-    }
-
     /**
      * Writes a sequence of values to an output stream.
      *
@@ -82,9 +66,9 @@ public void write(Iterable<? extends Map<String, ?>> values, Writer writer) thro
             XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
 
             streamWriter.writeStartDocument();
-            streamWriter.writeStartElement(rootElementName);
+            streamWriter.writeStartElement("root");
 
-            writeSequence(values, streamWriter);
+            writeValues(values, streamWriter);
 
             streamWriter.writeEndElement();
             streamWriter.writeEndDocument();
@@ -95,7 +79,7 @@ public void write(Iterable<? extends Map<String, ?>> values, Writer writer) thro
         writer.flush();
     }
 
-    private void writeSequence(Iterable<? extends Map<String, ?>> values, XMLStreamWriter streamWriter) throws XMLStreamException {
+    private void writeValues(Iterable<? extends Map<String, ?>> values, XMLStreamWriter streamWriter) throws XMLStreamException {
         for (Map<String, ?> map : values) {
             streamWriter.writeStartElement("item");
 
@@ -135,7 +119,7 @@ private void writeMap(Map<String, ?> map, XMLStreamWriter streamWriter) throws X
         for (Map.Entry<String, Iterable<?>> entry : sequences.entrySet()) {
             streamWriter.writeStartElement(entry.getKey());
 
-            writeSequence((Iterable<? extends Map<String, ?>>)entry.getValue(), streamWriter);
+            writeValues((Iterable<? extends Map<String, ?>>)entry.getValue(), streamWriter);
 
             streamWriter.writeEndElement();
         }
diff --git a/httprpc/src/test/java/org/httprpc/io/XMLEncoderTest.java b/httprpc/src/test/java/org/httprpc/io/XMLEncoderTest.java
@@ -29,13 +29,13 @@ public class XMLEncoderTest extends AbstractTest {
     @Test
     public void testWrite() throws IOException {
         String expected = "<?xml version=\"1.0\" ?>"
-            + "<test>"
+            + "<root>"
             + "<item a=\"ABC\" b=\"1\" c=\"2.345\" f=\"0\" g=\"3\">"
             + "<d><item e=\"true\"></item><item e=\"false\"></item></d>"
             + "<e><f g=\"XYZ\"></f></e>"
             + "</item>"
             + "<item a=\"DÉF\" b=\"2\" c=\"4.5678\"></item>"
-            + "</test>";
+            + "</root>";
 
         List<Map<String, ?>> values = listOf(
             mapOf(
@@ -63,7 +63,7 @@ public void testWrite() throws IOException {
 
         StringWriter writer = new StringWriter();
 
-        XMLEncoder xmlEncoder = new XMLEncoder("test");
+        XMLEncoder xmlEncoder = new XMLEncoder();
 
         xmlEncoder.write(values, writer);
 
