| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>XMLPart (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XMLPart (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/XMLPart.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.axis2.jaxws.message</a></div> |
| <h2 title="Interface XMLPart" class="title">Interface XMLPart</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/MessageImpl.html" title="class in org.apache.axis2.jaxws.message.impl">MessageImpl</a></code>, <code><a href="impl/XMLPartBase.html" title="class in org.apache.axis2.jaxws.message.impl">XMLPartBase</a></code>, <code><a href="impl/XMLPartImpl.html" title="class in org.apache.axis2.jaxws.message.impl">XMLPartImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">XMLPart</span></pre> |
| <div class="block">XMLPart |
| |
| The XML portion of a Message |
| |
| The JAX-WS implementation (proxy, message receiver, etc.) interact with the |
| Message via Blocks. A Block is represented in the message as a root element tree |
| in either the header, body or fault detail section. The Blocks can be easily |
| decomposed into business objects (which are needed on the JAX-WS interfaces). |
| |
| In addition, the JAX-WS handler model requires that the XMLPart be exposed as |
| an SAAJ SOAPEnvelope. |
| |
| The XMLPart abstraction hides the details of the message transformations from |
| the JAX-WS implementation.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Message.html" title="interface in org.apache.axis2.jaxws.message"><code>Message</code></a>, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message"><code>Block</code></a>, |
| <a href="impl/XMLPartBase.html" title="class in org.apache.axis2.jaxws.message.impl"><code>for implementation details</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)">appendHeaderBlock</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block)</code></th> |
| <td class="colLast"> |
| <div class="block">appendHeaderBlock |
| Append the block to the list of header blocks.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used primarily to ensure the parser is forwarded to the end so it can be closed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsOMElement()">getAsOMElement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getAsOMElement Get the xml part as a read/write OM...note this returns an OM SOAPEnvelope for |
| all protocols...even REST</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPEnvelope.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPEnvelope</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsSOAPEnvelope()">getAsSOAPEnvelope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getAsEnvelope Get the xml part as a read/write SOAPEnvelope</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBodyBlock(int,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a></span>​(int index, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">getBodyBlock Get the body block at the specificed index.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBodyBlock(java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getBodyBlock</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">getBodyBlock Get the single Body Block.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBodyBlockQNames()">getBodyBlockQNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getBodyBlockQNames |
| Calling this method will cache the OM.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderBlock(java.lang.String,java.lang.String,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)">getHeaderBlock</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory)</code></th> |
| <td class="colLast"> |
| <div class="block">getHeaderBlock |
| Get the firstheader block with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderBlocks(java.lang.String,java.lang.String,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory,org.apache.axiom.soap.RolePlayer)">getHeaderBlocks</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/RolePlayer.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">RolePlayer</a> rolePlayer)</code></th> |
| <td class="colLast"> |
| <div class="block">getHeaderBlock |
| Get the header blocks with the specified name |
| The BlockFactory and object context |
| are passed in to help create the proper kind of block.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderQNames()">getHeaderQNames</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndirection()">getIndirection</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get indirection.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumBodyBlocks()">getNumBodyBlocks</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getNumBodyBlocks Calling this method will cache the OM.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumHeaderBlocks()">getNumHeaderBlocks</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getNumHeaderBlocks</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperationElement()">getOperationElement</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">getParent Get the Message object that this XMLPart is attached to, if it is attached to one |
| at all.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="Protocol.html" title="enum in org.apache.axis2.jaxws.message">Protocol</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocol()">getProtocol</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the protocol for this Message (soap11, soap12, etc.)</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/jws/soap/SOAPBinding.Style.html?is-external=true" title="class or interface in javax.jws.soap" class="externalLink">SOAPBinding.Style</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStyle()">getStyle</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message">XMLFault</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getXMLFault()">getXMLFault</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If the XMLPart represents a fault, an XMLFault is returned which describes the fault in a |
| protocol agnostic manner</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getXMLPartContentType()">getXMLPartContentType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The representation of the XMLPart may be in a number of different forms.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamReader</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getXMLStreamReader(boolean)">getXMLStreamReader</a></span>​(boolean consume)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the XMLStreamReader represented by this Message for the xml part</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isConsumed()">isConsumed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">isConsumed Return true if the part is consumed.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFault()">isFault</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether the XMLPart represents a Fault</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outputTo(javax.xml.stream.XMLStreamWriter,boolean)">outputTo</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer, |
| boolean consume)</code></th> |
| <td class="colLast"> |
| <div class="block">Write out the Message</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeBodyBlock(int)">removeBodyBlock</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">removeBodyBlock Removes the indicated BodyBlock</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeHeaderBlock(java.lang.String,java.lang.String)">removeHeaderBlock</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart)</code></th> |
| <td class="colLast"> |
| <div class="block">removeHeaderBlock |
| Removes all header blocks with this namespace/localpart</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBodyBlock(int,org.apache.axis2.jaxws.message.Block)">setBodyBlock</a></span>​(int index, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block)</code></th> |
| <td class="colLast"> |
| <div class="block">setBodyBlock Set the block at the specified index Once set, the Message owns the block.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBodyBlock(org.apache.axis2.jaxws.message.Block)">setBodyBlock</a></span>​(<a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block)</code></th> |
| <td class="colLast"> |
| <div class="block">setBodyBlock Set this as block as the single block for the message.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)">setHeaderBlock</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block)</code></th> |
| <td class="colLast"> |
| <div class="block">setHeaderBlock |
| replaces the first existing header block with this new block.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIndirection(int)">setIndirection</a></span>​(int indirection)</code></th> |
| <td class="colLast"> |
| <div class="block">Set indirection.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOperationElement(javax.xml.namespace.QName)">setOperationElement</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the operation element qname.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParent(org.apache.axis2.jaxws.message.Message)">setParent</a></span>​(<a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> m)</code></th> |
| <td class="colLast"> |
| <div class="block">setParent Set the Message object that will hold this XMLPart</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStyle(javax.jws.soap.SOAPBinding.Style)">setStyle</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/jws/soap/SOAPBinding.Style.html?is-external=true" title="class or interface in javax.jws.soap" class="externalLink">SOAPBinding.Style</a> style)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Style.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setXMLFault(org.apache.axis2.jaxws.message.XMLFault)">setXMLFault</a></span>​(<a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message">XMLFault</a> xmlFault)</code></th> |
| <td class="colLast"> |
| <div class="block">Change the XMLPart so that it represents the fault described by XMLFault</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traceString(java.lang.String)">traceString</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> indent)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a traceString...the trace string dumps the contents of the Block without forcing an |
| underlying ill-performant transformation of the message.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getProtocol()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocol</h4> |
| <pre class="methodSignature"><a href="Protocol.html" title="enum in org.apache.axis2.jaxws.message">Protocol</a> getProtocol()</pre> |
| <div class="block">Get the protocol for this Message (soap11, soap12, etc.)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Protocl</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="outputTo(javax.xml.stream.XMLStreamWriter,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputTo</h4> |
| <pre class="methodSignature">void outputTo​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamWriter</a> writer, |
| boolean consume) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a>, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Write out the Message</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writer</code> - XMLStreamWriter</dd> |
| <dd><code>consume</code> - true if this is the last request on the block.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getXMLStreamReader(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLStreamReader</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamReader</a> getXMLStreamReader​(boolean consume) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Get the XMLStreamReader represented by this Message for the xml part</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consume</code> - true if this is the last request on the Message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XMLStreamReader</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream" class="externalLink">XMLStreamException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStyle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStyle</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/jws/soap/SOAPBinding.Style.html?is-external=true" title="class or interface in javax.jws.soap" class="externalLink">SOAPBinding.Style</a> getStyle()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Style (document or rpc)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStyle(javax.jws.soap.SOAPBinding.Style)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStyle</h4> |
| <pre class="methodSignature">void setStyle​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/jws/soap/SOAPBinding.Style.html?is-external=true" title="class or interface in javax.jws.soap" class="externalLink">SOAPBinding.Style</a> style) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Set the Style. If the style is DOCUMENT, the body blocks are located underneath the body |
| element. If the style is set to RPC, then the body blocks are located underneath the rpc |
| operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>style</code> - Style</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>indirection</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIndirection(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndirection</h4> |
| <pre class="methodSignature">void setIndirection​(int indirection)</pre> |
| <div class="block">Set indirection. Used to force the code to look for blocks at a particular location. For |
| DOCUMENT the default is 0 For RPC the default is 1 This method is used to override these |
| settings for special cases.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>indirection</code> - (0 or 1)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIndirection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndirection</h4> |
| <pre class="methodSignature">int getIndirection()</pre> |
| <div class="block">Get indirection. Used to force the code to look for blocks at a particular location. For |
| DOCUMENT the default is 0 For RPC the default is 1 This method is used to override these |
| settings for special cases.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>indirection (0 or 1)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOperationElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperationElement</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> getOperationElement() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the QName of the operation element if Style.rpc. Otherwise null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOperationElement(javax.xml.namespace.QName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOperationElement</h4> |
| <pre class="methodSignature">void setOperationElement​(<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a> operationQName) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Set the operation element qname. The operation qname is only used if Style.rpc</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operationQName</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isConsumed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConsumed</h4> |
| <pre class="methodSignature">boolean isConsumed()</pre> |
| <div class="block">isConsumed Return true if the part is consumed. Once consumed, the information in the part is |
| no longer available.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the block is consumed (a method was called with consume=true)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFault</h4> |
| <pre class="methodSignature">boolean isFault() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Determines whether the XMLPart represents a Fault</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the message represents a fault</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getXMLFault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLFault</h4> |
| <pre class="methodSignature"><a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message">XMLFault</a> getXMLFault() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">If the XMLPart represents a fault, an XMLFault is returned which describes the fault in a |
| protocol agnostic manner</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the XMLFault object or null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message"><code>XMLFault</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setXMLFault(org.apache.axis2.jaxws.message.XMLFault)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXMLFault</h4> |
| <pre class="methodSignature">void setXMLFault​(<a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message">XMLFault</a> xmlFault) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">Change the XMLPart so that it represents the fault described by XMLFault</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xmlfault</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="XMLFault.html" title="class in org.apache.axis2.jaxws.message"><code>XMLFault</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature"><a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> getParent()</pre> |
| <div class="block">getParent Get the Message object that this XMLPart is attached to, if it is attached to one |
| at all.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="setParent(org.apache.axis2.jaxws.message.Message)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParent</h4> |
| <pre class="methodSignature">void setParent​(<a href="Message.html" title="interface in org.apache.axis2.jaxws.message">Message</a> m)</pre> |
| <div class="block">setParent Set the Message object that will hold this XMLPart</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>m</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAsSOAPEnvelope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsSOAPEnvelope</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPEnvelope.html?is-external=true" title="class or interface in javax.xml.soap" class="externalLink">SOAPEnvelope</a> getAsSOAPEnvelope() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getAsEnvelope Get the xml part as a read/write SOAPEnvelope</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SOAPEnvelope</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAsOMElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAsOMElement</h4> |
| <pre class="methodSignature"><a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a> getAsOMElement() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getAsOMElement Get the xml part as a read/write OM...note this returns an OM SOAPEnvelope for |
| all protocols...even REST</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>OMElement</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumBodyBlocks()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumBodyBlocks</h4> |
| <pre class="methodSignature">int getNumBodyBlocks() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getNumBodyBlocks Calling this method will cache the OM. Avoid it in performant situations.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of body blocks</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBodyBlockQNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyBlockQNames</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a>> getBodyBlockQNames() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getBodyBlockQNames |
| Calling this method will cache the OM. Avoid it in performant situations.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of QNames</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBodyBlock(int,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyBlock</h4> |
| <pre class="methodSignature"><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> getBodyBlock​(int index, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getBodyBlock Get the body block at the specificed index. The BlockFactory and object context are |
| passed in to help create the proper kind of block. Calling this method will cache the OM. Avoid |
| it in performant situations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - </dd> |
| <dd><code>context</code> - </dd> |
| <dd><code>blockFactory</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Block or null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getBodyBlock(int,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)"><code>getBodyBlock(int,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBodyBlock(java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBodyBlock</h4> |
| <pre class="methodSignature"><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> getBodyBlock​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getBodyBlock Get the single Body Block. The BlockFactory and object context are passed in to |
| help create the proper kind of block. This method should only be invoked when it is known |
| that there is zero or one block.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - </dd> |
| <dd><code>context</code> - </dd> |
| <dd><code>blockFactory</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Block or null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBodyBlock(int,org.apache.axis2.jaxws.message.Block)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBodyBlock</h4> |
| <pre class="methodSignature">void setBodyBlock​(int index, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">setBodyBlock Set the block at the specified index Once set, the Message owns the block. You |
| must use the getBodyBlock method to access it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - </dd> |
| <dd><code>block</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBodyBlock(org.apache.axis2.jaxws.message.Block)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBodyBlock</h4> |
| <pre class="methodSignature">void setBodyBlock​(<a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">setBodyBlock Set this as block as the single block for the message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - </dd> |
| <dd><code>block</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeBodyBlock(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeBodyBlock</h4> |
| <pre class="methodSignature">void removeBodyBlock​(int index) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">removeBodyBlock Removes the indicated BodyBlock</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumHeaderBlocks()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumHeaderBlocks</h4> |
| <pre class="methodSignature">int getNumHeaderBlocks() |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getNumHeaderBlocks</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of header blocks</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderBlock(java.lang.String,java.lang.String,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderBlock</h4> |
| <pre class="methodSignature"><a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> getHeaderBlock​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getHeaderBlock |
| Get the firstheader block with the specified name. |
| The BlockFactory and object context |
| are passed in to help create the proper kind of block.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - </dd> |
| <dd><code>localPart</code> - </dd> |
| <dd><code>context</code> - </dd> |
| <dd><code>blockFactory</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Block</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderBlocks(java.lang.String,java.lang.String,java.lang.Object,org.apache.axis2.jaxws.message.factory.BlockFactory,org.apache.axiom.soap.RolePlayer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderBlocks</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a>> getHeaderBlocks​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> context, |
| <a href="factory/BlockFactory.html" title="interface in org.apache.axis2.jaxws.message.factory">BlockFactory</a> blockFactory, |
| <a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/soap/RolePlayer.html?is-external=true" title="class or interface in org.apache.axiom.soap" class="externalLink">RolePlayer</a> rolePlayer) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">getHeaderBlock |
| Get the header blocks with the specified name |
| The BlockFactory and object context |
| are passed in to help create the proper kind of block.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - uri of header</dd> |
| <dd><code>localPart</code> - local name of header</dd> |
| <dd><code>context</code> - context for blockFactory</dd> |
| <dd><code>blockFactory</code> - kind of factory (i.e. JAXB)</dd> |
| <dd><code>RolePlayer</code> - determines acceptable roles (or null)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List<Block></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeaderBlock</h4> |
| <pre class="methodSignature">void setHeaderBlock​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">setHeaderBlock |
| replaces the first existing header block with this new block. If there is no |
| existing header block, one is added to the end of the headers</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - </dd> |
| <dd><code>localPart</code> - </dd> |
| <dd><code>block</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="appendHeaderBlock(java.lang.String,java.lang.String,org.apache.axis2.jaxws.message.Block)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendHeaderBlock</h4> |
| <pre class="methodSignature">void appendHeaderBlock​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart, |
| <a href="Block.html" title="interface in org.apache.axis2.jaxws.message">Block</a> block) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">appendHeaderBlock |
| Append the block to the list of header blocks. The Message owns the block. |
| You must use the getHeaderBlock method to access it.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - </dd> |
| <dd><code>localPart</code> - </dd> |
| <dd><code>block</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderQNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderQNames</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace" class="externalLink">QName</a>> getHeaderQNames()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>QNames of headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeHeaderBlock(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHeaderBlock</h4> |
| <pre class="methodSignature">void removeHeaderBlock​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> namespace, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> localPart) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></pre> |
| <div class="block">removeHeaderBlock |
| Removes all header blocks with this namespace/localpart</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - </dd> |
| <dd><code>localPart</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceException.html?is-external=true" title="class or interface in javax.xml.ws" class="externalLink">WebServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="traceString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>traceString</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> traceString​(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> indent)</pre> |
| <div class="block">Get a traceString...the trace string dumps the contents of the Block without forcing an |
| underlying ill-performant transformation of the message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String containing trace information</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getXMLPartContentType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLPartContentType</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getXMLPartContentType()</pre> |
| <div class="block">The representation of the XMLPart may be in a number of different forms. Currently the forms |
| are UNKNOWN, OM, SOAPENVELOPE, and SPINE. This method returns a String containing one of |
| these types. This method should only be used for trace and testing purposes. The consumer |
| of a Message should not make any decisions based on the representation of the XMLPart</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">Used primarily to ensure the parser is forwarded to the end so it can be closed.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/XMLPart.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |