| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Builder (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="Builder (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":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/Builder.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.builder</a></div> |
| <h2 title="Interface Builder" class="title">Interface Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../format/DataSourceMessageBuilder.html" title="interface in org.apache.axis2.format">DataSourceMessageBuilder</a></code>, <code><a href="MIMEAwareBuilder.html" title="interface in org.apache.axis2.builder">MIMEAwareBuilder</a></code>, <code><a href="../format/TextMessageBuilder.html" title="interface in org.apache.axis2.format">TextMessageBuilder</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../json/AbstractJSONOMBuilder.html" title="class in org.apache.axis2.json">AbstractJSONOMBuilder</a></code>, <code><a href="ApplicationXMLBuilder.html" title="class in org.apache.axis2.builder">ApplicationXMLBuilder</a></code>, <code><a href="../format/BinaryBuilder.html" title="class in org.apache.axis2.format">BinaryBuilder</a></code>, <code><a href="DataSourceBuilder.html" title="class in org.apache.axis2.builder">DataSourceBuilder</a></code>, <code><a href="../fastinfoset/FastInfosetBuilder.html" title="class in org.apache.axis2.fastinfoset">FastInfosetBuilder</a></code>, <code><a href="../fastinfoset/FastInfosetPOXBuilder.html" title="class in org.apache.axis2.fastinfoset">FastInfosetPOXBuilder</a></code>, <code><a href="../json/JSONBadgerfishOMBuilder.html" title="class in org.apache.axis2.json">JSONBadgerfishOMBuilder</a></code>, <code><a href="../json/gson/JsonBuilder.html" title="class in org.apache.axis2.json.gson">JsonBuilder</a></code>, <code><a href="../json/moshi/JsonBuilder.html" title="class in org.apache.axis2.json.moshi">JsonBuilder</a></code>, <code><a href="../json/JSONOMBuilder.html" title="class in org.apache.axis2.json">JSONOMBuilder</a></code>, <code><a href="MIMEBuilder.html" title="class in org.apache.axis2.builder">MIMEBuilder</a></code>, <code><a href="MTOMBuilder.html" title="class in org.apache.axis2.builder">MTOMBuilder</a></code>, <code><a href="MultipartFormDataBuilder.html" title="class in org.apache.axis2.builder">MultipartFormDataBuilder</a></code>, <code><a href="../format/PlainTextBuilder.html" title="class in org.apache.axis2.format">PlainTextBuilder</a></code>, <code><a href="SOAPBuilder.html" title="class in org.apache.axis2.builder">SOAPBuilder</a></code>, <code><a href="../format/TextMessageBuilderAdapter.html" title="class in org.apache.axis2.format">TextMessageBuilderAdapter</a></code>, <code><a href="unknowncontent/UnknownContentBuilder.html" title="class in org.apache.axis2.builder.unknowncontent">UnknownContentBuilder</a></code>, <code><a href="XFormURLEncodedBuilder.html" title="class in org.apache.axis2.builder">XFormURLEncodedBuilder</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Builder</span></pre> |
| <div class="block">Message builder able to convert a byte stream into a SOAP infoset. |
| Message builders are used by <a href="../kernel/TransportListener.html" title="interface in org.apache.axis2.kernel"><code>TransportListener</code></a> |
| implementations to process the raw payload of the message and turn it into SOAP. |
| Transports should use |
| <a href="../util/MessageProcessorSelector.html#getMessageBuilder(java.lang.String,org.apache.axis2.context.MessageContext)"><code>MessageProcessorSelector.getMessageBuilder(String, MessageContext)</code></a> |
| to select the message builder appropriate for the content type of the message.</div> |
| </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><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="#processDocument(java.io.InputStream,java.lang.String,org.apache.axis2.context.MessageContext)">processDocument</a></span>​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputStream, |
| <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> contentType, |
| <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Process a 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="processDocument(java.io.InputStream,java.lang.String,org.apache.axis2.context.MessageContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>processDocument</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> processDocument​(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> inputStream, |
| <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> contentType, |
| <a href="../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a> messageContext) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Process a message. |
| <p> |
| The raw content of the message is provided as an input stream. It is the responsibility |
| of the caller (typically a transport implementation) to close the stream after the |
| message has been processed (more precisely after the SOAP infoset returned by this method |
| is no longer used). This implies that implementations are not required to consume the |
| input stream during the execution of this method. This enables deferred parsing of the |
| message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inputStream</code> - the byte stream with the raw payload</dd> |
| <dd><code>contentType</code> - </dd> |
| <dd><code>messageContext</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The SOAP infoset for the given message.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </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/Builder.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> |
