[jbossws-commits] JBossWS SVN: r1324 - branches/jbossws-1.0/docs/user-guide/project/en/modules/mtom-xop

Author: heiko.braun(a)jboss.com Date: 2006-10-27 11:26:48 -0400 (Fri, 27 Oct 2006) New Revision: 1324 Modified: branches/jbossws-1.0/docs/user-guide/project/en/modules/mtom-xop/mtom-xop.xml Log: Updated the MTOM documentation Modified: branches/jbossws-1.0/docs/user-guide/project/en/modules/mtom-xop/mtom-xop.xml =================================================================== --- branches/jbossws-1.0/docs/user-guide/project/en/modules/mtom-xop/mtom-xop.xml 2006-10-27 14:55:38 UTC (rev 1323) +++ branches/jbossws-1.0/docs/user-guide/project/en/modules/mtom-xop/mtom-xop.xml 2006-10-27 15:26:48 UTC (rev 1324) @@ -12,9 +12,6 @@ and <ulink url="http://www.w3.org/TR/xop10/">XML-binary Optimized Packaging (XOP)</ulink> </para> - <para>The MTOM/XOP example uses a service endpoint interface with the same operations as in <link linkend="attachments">SOAP with Attachments</link> - </para> - <sect1 id="mtom-schema-elements"> <title>MTOM schema elements</title> @@ -49,7 +46,7 @@ </orderedlist> The JBossWS MTOM implementation scans the associated schema - and will treat any xmime:base64Binary occurance as a MTOM optimizable parameter. + and will treat any xsd:base64Binary occurance as a MTOM optimizable parameter. </para> </sect1> @@ -89,6 +86,35 @@ </sect1> <sect1> + <title>Enabling MTOM in JBossWS</title> + + <para> + Since JBossWS 1.0.2 MTOM is enabled for all schema types that picked up by the XOPScanner. + These are basically all xsd:Base64Binaries. But this also means that regardless of wether or not the receiving + side of the message is capable of processing MTOM request, JBossWS will always send particular schema types xop encoded + over the wire. + </para> + + <para> + This behaviour can be disabled by either using a MessageContext ('org.jboss.ws.mtom.enabled') property or referring + a <link linkend="template-config">configuration template</link> that disables MTOM. + </para> + </sect1> + + <note> + <title>A note on JAXRPC handlers</title> + + <para> + The fact that a SOAP message might be XOP encoded is actually transparent to any SOAP intermediary. + This also applies to <link linkend="headers-handlers">JAXRPC handlers</link>. What does this mean? + It means that JAXRPC handlers don't get to see the XOP encoded wireformat (xop:Include), instead they can access + the message as if it was inlined. This is necessary in order not to break any SOAP processing modules + that work on the real payload (i.e. Security). In JBossWS this results in the binary data being transformed into + a base64 representation, which can easily negate the optimization efforts in the first place. + </para> + </note> + + <sect1> <title>An example MTOM request</title> <para>The incomming message is multipart/related. The first part is the SOAP Envelope.</para>