You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-dev@ws.apache.org by ve...@apache.org on 2010/06/13 13:34:11 UTC

svn commit: r954203 - /webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml

Author: veithen
Date: Sun Jun 13 11:34:11 2010
New Revision: 954203

URL: http://svn.apache.org/viewvc?rev=954203&view=rev
Log:
Added a section to the user guide about changes in XOP/MTOM handling in Axiom 1.2.9.

Modified:
    webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml

Modified: webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml?rev=954203&r1=954202&r2=954203&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml (original)
+++ webservices/commons/trunk/modules/axiom/src/docbkx/userguide.xml Sun Jun 13 11:34:11 2010
@@ -1113,6 +1113,47 @@ with CRLF</root>]]></screen>
                         This feature is described in <xref linkend="factory.properties"/>.
                     </para>
                 </section>
+                <section>
+                    <title>Changes in XOP/MTOM handling</title>
+                    <para>
+                        In Axiom 1.2.8, <classname>XMLStreamReader</classname> instances provided by Axiom could
+                        belong to one of three different categories:
+                    </para>
+                    <orderedlist>
+                        <listitem>
+                            <para>
+                                <classname>XMLStreamReader</classname> instances delivering plain XML.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                <classname>XMLStreamReader</classname> instances delivering plain XML and
+                                implementing a custom extension to retrieve optimized binary data.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                <classname>XMLStreamReader</classname> instances representing XOP
+                                encoded data.
+                            </para>
+                        </listitem>
+                    </orderedlist>
+                    <para>
+                        As explained in <ulink url="https://issues.apache.org/jira/browse/WSCOMMONS-485">WSCOMMONS-485</ulink>
+                        and <ulink url="https://issues.apache.org/jira/browse/WSCOMMONS-488">WSCOMMONS-488</ulink>,
+                        in Axiom 1.2.8, the type of stream reader provided by the API was not always well defined.
+                        Sometimes the type of the stream reader even depended on the state of the Axiom tree
+                        (i.e. whether some part of it has been accessed or not).
+                    </para>
+                    <para>
+                        In release 1.2.9 the behavior of Axiom was changed such that it never delivers XOP
+                        encoded data unless explicitly requested to do so. By default, any <classname>XMLStreamReader</classname>
+                        provided by Axiom now represents plain XML data and optionally implements the
+                        <classname>DataHandlerReader</classname> extension to retrieve optimized
+                        binary data. An XOP encoded stream can be requested from the <methodname>getXOPEncodedStream</methodname>
+                        method in <classname>XOPUtils</classname>.
+                    </para>
+                </section>
             </section>
         </section>
     </chapter>