Google Git
Sign in
apache / axis-site / e5aad6c42d12325bd236fd2b1848273f47f70c65 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / builder / Builder.html
blob: bef0aa26badaba30a4afd1fc00a088353c598fcc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Builder (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.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 methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../org/apache/axis2/builder/ApplicationXMLBuilder.html" title="class in org.apache.axis2.builder"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/axis2/builder/BuilderUtil.html" title="class in org.apache.axis2.builder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/builder/Builder.html" target="_top">Frames</a></li>
<li><a href="Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.axis2.builder</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><a href="../../../../org/apache/axis2/format/DataSourceMessageBuilder.html" title="interface in org.apache.axis2.format">DataSourceMessageBuilder</a>, <a href="../../../../org/apache/axis2/builder/MIMEAwareBuilder.html" title="interface in org.apache.axis2.builder">MIMEAwareBuilder</a>, <a href="../../../../org/apache/axis2/format/TextMessageBuilder.html" title="interface in org.apache.axis2.format">TextMessageBuilder</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis2/json/AbstractJSONOMBuilder.html" title="class in org.apache.axis2.json">AbstractJSONOMBuilder</a>, <a href="../../../../org/apache/axis2/builder/ApplicationXMLBuilder.html" title="class in org.apache.axis2.builder">ApplicationXMLBuilder</a>, <a href="../../../../org/apache/axis2/format/BinaryBuilder.html" title="class in org.apache.axis2.format">BinaryBuilder</a>, <a href="../../../../org/apache/axis2/builder/DataSourceBuilder.html" title="class in org.apache.axis2.builder">DataSourceBuilder</a>, <a href="../../../../org/apache/axis2/fastinfoset/FastInfosetBuilder.html" title="class in org.apache.axis2.fastinfoset">FastInfosetBuilder</a>, <a href="../../../../org/apache/axis2/fastinfoset/FastInfosetPOXBuilder.html" title="class in org.apache.axis2.fastinfoset">FastInfosetPOXBuilder</a>, <a href="../../../../org/apache/axis2/json/JSONBadgerfishOMBuilder.html" title="class in org.apache.axis2.json">JSONBadgerfishOMBuilder</a>, <a href="../../../../org/apache/axis2/json/gson/JsonBuilder.html" title="class in org.apache.axis2.json.gson">JsonBuilder</a>, <a href="../../../../org/apache/axis2/json/JSONOMBuilder.html" title="class in org.apache.axis2.json">JSONOMBuilder</a>, <a href="../../../../org/apache/axis2/builder/MIMEBuilder.html" title="class in org.apache.axis2.builder">MIMEBuilder</a>, <a href="../../../../org/apache/axis2/builder/MTOMBuilder.html" title="class in org.apache.axis2.builder">MTOMBuilder</a>, <a href="../../../../org/apache/axis2/builder/MultipartFormDataBuilder.html" title="class in org.apache.axis2.builder">MultipartFormDataBuilder</a>, <a href="../../../../org/apache/axis2/format/PlainTextBuilder.html" title="class in org.apache.axis2.format">PlainTextBuilder</a>, <a href="../../../../org/apache/axis2/builder/SOAPBuilder.html" title="class in org.apache.axis2.builder">SOAPBuilder</a>, <a href="../../../../org/apache/axis2/format/TextMessageBuilderAdapter.html" title="class in org.apache.axis2.format">TextMessageBuilderAdapter</a>, <a href="../../../../org/apache/axis2/builder/unknowncontent/UnknownContentBuilder.html" title="class in org.apache.axis2.builder.unknowncontent">UnknownContentBuilder</a>, <a href="../../../../org/apache/axis2/builder/XFormURLEncodedBuilder.html" title="class in org.apache.axis2.builder">XFormURLEncodedBuilder</a></dd>
</dl>
<hr>
<br>
<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="../../../../org/apache/axis2/transport/TransportListener.html" title="interface in org.apache.axis2.transport"><code>TransportListener</code></a>
implementations to process the raw payload of the message and turn it into SOAP.
Transports should use
<a href="../../../../org/apache/axis2/builder/BuilderUtil.html#getBuilderFromSelector-java.lang.String-org.apache.axis2.context.MessageContext-"><code>BuilderUtil.getBuilderFromSelector(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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/axis2/builder/Builder.html#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">InputStream</a>&nbsp;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">String</a>&nbsp;contentType,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)</code>
<div class="block">Process a message.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="processDocument-java.io.InputStream-java.lang.String-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>processDocument</h4>
<pre><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a>&nbsp;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">InputStream</a>&nbsp;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">String</a>&nbsp;contentType,
<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;messageContext)
throws <a href="../../../../org/apache/axis2/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="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li><a href="../../../../org/apache/axis2/builder/ApplicationXMLBuilder.html" title="class in org.apache.axis2.builder"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/axis2/builder/BuilderUtil.html" title="class in org.apache.axis2.builder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/builder/Builder.html" target="_top">Frames</a></li>
<li><a href="Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>