fix #243, offer a way to close the input source for XMLStreamReaderHandle

Author: sammefford

src/main/java/com/marklogic/client/io/XMLStreamReaderHandle.java

@@ -46,7 +46,7 @@
  * An XML Stream Reader Handle represents XML content as an XML stream reader
  * for reading as a StAX pull stream.
  * 
- * When finished with the stream reader, close the stream reader to release
+ * When finished with the stream reader, call {@link #close} to release
  * the response.
  */
 public class XMLStreamReaderHandle
@@ -59,6 +59,7 @@ public class XMLStreamReaderHandle
 
 	private XMLResolver     resolver;
 	private XMLStreamReader content;
+	private InputStream contentSource;
 	private XMLInputFactory factory;
 
 	/**
@@ -98,7 +99,7 @@ public void setResolver(XMLResolver resolver) {
 	 * Returns an XML Stream Reader for for reading a resource from the database
 	 * as a StAX pull stream.
 	 * 
-     * When finished with the stream reader, close the stream reader to release
+	 * When finished with the stream reader, call {@link #close} to release
      * the response.
 	 * 
 	 * @return	the XML stream reader
@@ -166,6 +167,16 @@ public byte[] toBuffer() {
 			throw new MarkLogicIOException(e);
 		}
 	}
+	/**
+	 * Closes the XMLStreamReader and the InputStream, if any, used to populate
+	 * the XMLStreamReader.  This method should always be called when finished
+	 * with the stream reader.
+	 */
+	public void close() throws XMLStreamException, IOException {
+		if ( content != null ) content.close();
+		if ( contentSource != null ) contentSource.close();
+	}
+
 	/**
 	 * Buffers the StAX stream and returns the buffer as an XML string.
 	 */
@@ -226,6 +237,7 @@ protected void receiveContent(InputStream content) {
 				factory.setXMLResolver(resolver);
 
 			this.content = factory.createXMLStreamReader(content, "UTF-8");
+			this.contentSource = content;
 		} catch (XMLStreamException e) {
 			logger.error("Failed to parse StAX stream from input stream",e);
 			throw new MarkLogicInternalException(e);
@@ -267,4 +279,4 @@ public void write(OutputStream out) throws IOException {
 			throw new MarkLogicInternalException(e);
 		}
 	}
-}
+}

src/test/java/com/marklogic/client/test/XMLDocumentTest.java

@@ -131,7 +131,8 @@ public void startElement(String uri, String localName, String qName, Attributes
 		assertTrue("Failed to process XML document with SAX",
 				counter.get("elementCount") == 2 && counter.get("attributeCount") == 2);
 
-		XMLStreamReader streamReader = docMgr.read(docId, new XMLStreamReaderHandle()).get();
+		XMLStreamReaderHandle streamReaderHandle = docMgr.read(docId, new XMLStreamReaderHandle());
+		XMLStreamReader streamReader = streamReaderHandle.get();
 		int elementCount = 0;
 		int attributeCount = 0;
 		while (streamReader.hasNext()) {
@@ -142,7 +143,7 @@ public void startElement(String uri, String localName, String qName, Attributes
 			if (elementAttributeCount > 0)
 				attributeCount += elementAttributeCount;
 		}
-		streamReader.close();
+		streamReaderHandle.close();
 		assertTrue("Failed to process XML document with StAX stream reader",
 				elementCount == 2 && attributeCount == 2);