You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by ve...@apache.org on 2016/05/05 08:24:34 UTC

svn commit: r1742374 - in /webservices/axiom/trunk: axiom-api/ axiom-api/src/main/java/org/apache/axiom/om/ds/ axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/ axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/ axiom-api/src/main/...

Author: veithen
Date: Thu May  5 08:24:33 2016
New Revision: 1742374

URL: http://svn.apache.org/viewvc?rev=1742374&view=rev
Log:
Deprecate StreamingOMSerializer and friends. Also, now that DOOM implements the complete Axiom API (see in particular AXIOM-471), allow DOOM to be used as default Axiom implementation if LLOM is not present.

Added:
    webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java
      - copied, changed from r1742318, webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java
    webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java
      - copied, changed from r1742318, webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java
    webservices/axiom/trunk/axiom-compat/src/test/java/org/apache/axiom/om/impl/serialize/
    webservices/axiom/trunk/axiom-compat/src/test/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializerTest.java
      - copied unchanged from r1742318, webservices/axiom/trunk/axiom-api/src/test/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializerTest.java
Removed:
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/util/
    webservices/axiom/trunk/axiom-api/src/test/java/org/apache/axiom/om/impl/
Modified:
    webservices/axiom/trunk/axiom-api/pom.xml
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractPullOMDataSource.java
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/BlobOMDataSourceCustomBuilder.java
    webservices/axiom/trunk/implementations/axiom-dom/src/main/resources/META-INF/axiom.xml
    webservices/axiom/trunk/systests/old-tests/src/test/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReaderTest.java

Modified: webservices/axiom/trunk/axiom-api/pom.xml
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/pom.xml?rev=1742374&r1=1742373&r2=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/pom.xml (original)
+++ webservices/axiom/trunk/axiom-api/pom.xml Thu May  5 08:24:33 2016
@@ -326,8 +326,6 @@
                                 org.apache.axiom.om.ds.BlobOMDataSource -> org.apache.axiom.om.util.StAXUtils,
                                 org.apache.axiom.om.ds.StringOMDataSource -> org.apache.axiom.om.util.StAXUtils,
                                 org.apache.axiom.om.impl.MTOMXMLStreamWriter -> org.apache.axiom.om.util.StAXUtils,
-                                <!-- This should go away in a redesign of the OMDataSource API -->
-                                org.apache.axiom.om.ds.AbstractPullOMDataSource -> org.apache.axiom.om.impl.serialize.StreamingOMSerializer,
                                 <!-- TODO: Detachable should go to om-aspects -->
                                 org.apache.axiom.om.impl.builder.Detachable -> org.apache.axiom.om.OMException,
                                 <!-- TODO -->

Modified: webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractPullOMDataSource.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractPullOMDataSource.java?rev=1742374&r1=1742373&r2=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractPullOMDataSource.java (original)
+++ webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractPullOMDataSource.java Thu May  5 08:24:33 2016
@@ -22,8 +22,8 @@ import javax.xml.stream.XMLStreamExcepti
 import javax.xml.stream.XMLStreamReader;
 import javax.xml.stream.XMLStreamWriter;
 
+import org.apache.axiom.om.OMAbstractFactory;
 import org.apache.axiom.om.OMDataSourceExt;
-import org.apache.axiom.om.impl.serialize.StreamingOMSerializer;
 
 /**
  * Base class for {@link OMDataSourceExt} implementations that can easily produce the content as an
@@ -37,13 +37,8 @@ public abstract class AbstractPullOMData
         return isDestructiveRead();
     }
 
+    // Note: this method is never executed by Axiom itself
     public final void serialize(XMLStreamWriter xmlWriter) throws XMLStreamException {
-        StreamingOMSerializer serializer = new StreamingOMSerializer();
-        XMLStreamReader reader = getReader();
-        try {
-            serializer.serialize(reader, xmlWriter);
-        } finally {
-            reader.close();
-        }
+        OMAbstractFactory.getOMFactory().createOMElement(this).serialize(xmlWriter, false);
     }
 }

Modified: webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/BlobOMDataSourceCustomBuilder.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/BlobOMDataSourceCustomBuilder.java?rev=1742374&r1=1742373&r2=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/BlobOMDataSourceCustomBuilder.java (original)
+++ webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/ds/custombuilder/BlobOMDataSourceCustomBuilder.java Thu May  5 08:24:33 2016
@@ -23,15 +23,13 @@ import java.io.OutputStream;
 
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
-import javax.xml.stream.XMLStreamWriter;
 
 import org.apache.axiom.blob.WritableBlob;
 import org.apache.axiom.blob.WritableBlobFactory;
 import org.apache.axiom.om.OMDataSource;
 import org.apache.axiom.om.OMException;
+import org.apache.axiom.om.OMXMLBuilderFactory;
 import org.apache.axiom.om.ds.BlobOMDataSource;
-import org.apache.axiom.om.impl.serialize.StreamingOMSerializer;
-import org.apache.axiom.om.util.StAXUtils;
 
 /**
  * {@link CustomBuilder} implementation that creates a {@link BlobOMDataSource}.
@@ -55,13 +53,10 @@ public final class BlobOMDataSourceCusto
 
     public OMDataSource create(XMLStreamReader reader) throws OMException {
         try {
-            StreamingOMSerializer serializer = new StreamingOMSerializer();
             WritableBlob blob = blobFactory.createBlob();
             OutputStream out = blob.getOutputStream();
             try {
-                XMLStreamWriter writer = StAXUtils.createXMLStreamWriter(out, encoding);
-                serializer.serialize(reader, writer, false);
-                writer.flush();
+                OMXMLBuilderFactory.createStAXOMBuilder(reader).getDocument().serializeAndConsume(out);
             } finally {
                 out.close();
             }

Copied: webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java (from r1742318, webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java)
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java?p2=webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java&p1=webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java&r1=1742318&r2=1742374&rev=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java (original)
+++ webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/serialize/StreamingOMSerializer.java Thu May  5 08:24:33 2016
@@ -22,8 +22,11 @@ package org.apache.axiom.om.impl.seriali
 import org.apache.axiom.ext.stax.DTDReader;
 import org.apache.axiom.ext.stax.datahandler.DataHandlerReader;
 import org.apache.axiom.ext.stax.datahandler.DataHandlerWriter;
+import org.apache.axiom.om.OMContainer;
 import org.apache.axiom.om.OMDataSource;
+import org.apache.axiom.om.OMDocument;
 import org.apache.axiom.om.OMSerializer;
+import org.apache.axiom.om.OMXMLBuilderFactory;
 import org.apache.axiom.om.impl.OMXMLStreamReaderEx;
 import org.apache.axiom.om.impl.util.OMSerializerUtil;
 import org.apache.axiom.util.stax.XMLStreamReaderUtils;
@@ -40,7 +43,12 @@ import javax.xml.stream.XMLStreamWriter;
 import java.io.IOException;
 import java.util.ArrayList;
 
-/** Class StreamingOMSerializer */
+/**
+ * @deprecated To copy events from an {@link XMLStreamReader} to an {@link XMLStreamWriter}, use
+ *             {@link OMXMLBuilderFactory#createStAXOMBuilder(XMLStreamReader)} to create an
+ *             {@link OMDocument}, then serialize it using
+ *             {@link OMContainer#serializeAndConsume(XMLStreamWriter)}.
+ */
 public class StreamingOMSerializer implements XMLStreamConstants, OMSerializer {
     
     private static final Log log = LogFactory.getLog(StreamingOMSerializer.class);

Copied: webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java (from r1742318, webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java)
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java?p2=webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java&p1=webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java&r1=1742318&r2=1742374&rev=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java (original)
+++ webservices/axiom/trunk/axiom-compat/src/main/java/org/apache/axiom/om/impl/util/OMSerializerUtil.java Thu May  5 08:24:33 2016
@@ -37,6 +37,9 @@ import javax.xml.stream.XMLStreamWriter;
 import java.util.ArrayList;
 import java.util.Iterator;
 
+/**
+ * @deprecated
+ */
 public class OMSerializerUtil {
     private static final Log log = LogFactory.getLog(OMSerializerUtil.class);
     private static boolean ADV_DEBUG_ENABLED = true;

Modified: webservices/axiom/trunk/implementations/axiom-dom/src/main/resources/META-INF/axiom.xml
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/implementations/axiom-dom/src/main/resources/META-INF/axiom.xml?rev=1742374&r1=1742373&r2=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/implementations/axiom-dom/src/main/resources/META-INF/axiom.xml (original)
+++ webservices/axiom/trunk/implementations/axiom-dom/src/main/resources/META-INF/axiom.xml Thu May  5 08:24:33 2016
@@ -20,5 +20,6 @@
 <implementations xmlns="http://ws.apache.org/axiom/">
     <implementation name="doom" loader="org.apache.axiom.om.impl.dom.factory.OMDOMMetaFactoryLoader">
         <feature name="dom" priority="100"/>
+        <feature name="default" priority="0"/>
     </implementation>
 </implementations>
\ No newline at end of file

Modified: webservices/axiom/trunk/systests/old-tests/src/test/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReaderTest.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/systests/old-tests/src/test/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReaderTest.java?rev=1742374&r1=1742373&r2=1742374&view=diff
==============================================================================
--- webservices/axiom/trunk/systests/old-tests/src/test/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReaderTest.java (original)
+++ webservices/axiom/trunk/systests/old-tests/src/test/java/org/apache/axiom/util/stax/WrappedTextNodeStreamReaderTest.java Thu May  5 08:24:33 2016
@@ -27,14 +27,11 @@ import java.io.StringWriter;
 
 import javax.xml.namespace.QName;
 import javax.xml.stream.XMLStreamReader;
-import javax.xml.stream.XMLStreamWriter;
 
 import junit.framework.TestCase;
 
 import org.apache.axiom.om.OMElement;
 import org.apache.axiom.om.OMXMLBuilderFactory;
-import org.apache.axiom.om.impl.serialize.StreamingOMSerializer;
-import org.apache.axiom.om.util.StAXUtils;
 import org.apache.axiom.util.stax.WrappedTextNodeStreamReader;
 
 public class WrappedTextNodeStreamReaderTest extends TestCase {
@@ -84,53 +81,6 @@ public class WrappedTextNodeStreamReader
     }
     
     //
-    // Test that serialize the stream of XML events to plain XML and compare
-    // with the expected result.
-    //
-    
-    private void testUsingSerializer(QName wrapperElementName,
-                                     String testString,
-                                     int chunkSize,
-                                     String expectedXML) throws Exception {
-        StringReader reader = new StringReader(testString);
-        XMLStreamReader xmlStreamReader
-            = new WrappedTextNodeStreamReader(wrapperElementName, reader, chunkSize);
-        StringWriter writer = new StringWriter();
-        XMLStreamWriter xmlStreamWriter = StAXUtils.createXMLStreamWriter(writer);
-        new StreamingOMSerializer().serialize(xmlStreamReader, xmlStreamWriter);
-        xmlStreamWriter.flush();
-        assertAbout(xml())
-                .that(writer.toString())
-                .hasSameContentAs(expectedXML);
-    }
-
-    public void testShortStringUsingSerializer() throws Exception {
-        String testString = "This is a test string for WrappedTextNodeStreamReader";
-        testUsingSerializer(
-                new QName("urn:test", "test"),
-                testString,
-                4096,
-                "<test xmlns=\"urn:test\">" + testString + "</test>");
-    }
-
-    public void testLongStringUsingSerializer() throws Exception {
-        String testString = "This is a test string for WrappedTextNodeStreamReader";
-        testUsingSerializer(
-                new QName("urn:test", "test"),
-                testString,
-                10,
-                "<test xmlns=\"urn:test\">" + testString + "</test>");
-    }
-
-    public void testStringWithAmpersandUsingSerializer() throws Exception {
-        testUsingSerializer(
-                new QName("urn:test", "test"),
-                "String containing ampersand (&)",
-                4096,
-                "<test xmlns=\"urn:test\">String containing ampersand (&amp;)</test>");
-    }
-    
-    //
     // Tests that construct the Axiom tree, serialize it using serializeAndConsume and
     // compare with the expected result.
     //