Google Git
Sign in
apache / axis-site / f545f87a6b723b56329b1ebb949e3b91067c8436 / . / axis / java / apiDocs / javax / xml / rpc / handler / soap / SOAPMessageContext.html
blob: a8fa726f371954cb335f05a9e9f8790e7f23192b [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>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SOAPMessageContext (Apache Axis)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SOAPMessageContext (Apache Axis)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SOAPMessageContext.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?javax/xml/rpc/handler/soap/SOAPMessageContext.html" target="_top">Frames</a></li>
<li><a href="SOAPMessageContext.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All 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">javax.xml.rpc.handler.soap</div>
<h2 title="Interface SOAPMessageContext" class="title">Interface SOAPMessageContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/axis/MessageContext.html" title="class in org.apache.axis">MessageContext</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SOAPMessageContext</span>
extends <a href="../../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a></pre>
<div class="block">The interface <code>javax.xml.rpc.soap.SOAPMessageContext</code>
provides access to the SOAP message for either RPC request or
response. The <code>javax.xml.soap.SOAPMessage</code> specifies
the standard Java API for the representation of a SOAP 1.1 message
with attachments.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap"><code>SOAPMessage</code></a></dd></dl>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../javax/xml/rpc/handler/soap/SOAPMessageContext.html#getMessage()">getMessage</a></strong>()</code>
<div class="block">Gets the SOAPMessage from this message context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../javax/xml/rpc/handler/soap/SOAPMessageContext.html#getRoles()">getRoles</a></strong>()</code>
<div class="block">Gets the SOAP actor roles associated with an execution
of the HandlerChain and its contained Handler instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../javax/xml/rpc/handler/soap/SOAPMessageContext.html#setMessage(javax.xml.soap.SOAPMessage)">setMessage</a></strong>(<a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a>&nbsp;message)</code>
<div class="block">Sets the <code>SOAPMessage</code> for this message context.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.xml.rpc.handler.MessageContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.rpc.handler.<a href="../../../../../javax/xml/rpc/handler/MessageContext.html" title="interface in javax.xml.rpc.handler">MessageContext</a></h3>
<code><a href="../../../../../javax/xml/rpc/handler/MessageContext.html#containsProperty(java.lang.String)">containsProperty</a>, <a href="../../../../../javax/xml/rpc/handler/MessageContext.html#getProperty(java.lang.String)">getProperty</a>, <a href="../../../../../javax/xml/rpc/handler/MessageContext.html#getPropertyNames()">getPropertyNames</a>, <a href="../../../../../javax/xml/rpc/handler/MessageContext.html#removeProperty(java.lang.String)">removeProperty</a>, <a href="../../../../../javax/xml/rpc/handler/MessageContext.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></code></li>
</ul>
</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="getMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre><a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a>&nbsp;getMessage()</pre>
<div class="block">Gets the SOAPMessage from this message context.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>SOAPMessage</code>; <code>null</code> if no request
<code>SOAPMessage</code> is present in this
<code>SOAPMessageContext</code></dd></dl>
</li>
</ul>
<a name="setMessage(javax.xml.soap.SOAPMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessage</h4>
<pre>void&nbsp;setMessage(<a href="../../../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a>&nbsp;message)</pre>
<div class="block">Sets the <code>SOAPMessage</code> for this message context.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - SOAP message</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../javax/xml/rpc/JAXRPCException.html" title="class in javax.xml.rpc">JAXRPCException</a></code> - if any error during the setting
of the SOAPMessage in this message context</dd>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if this
operation is not supported</dd></dl>
</li>
</ul>
<a name="getRoles()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRoles</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getRoles()</pre>
<div class="block">Gets the SOAP actor roles associated with an execution
of the HandlerChain and its contained Handler instances.
Note that SOAP actor roles apply to the SOAP node and
are managed using <code>HandlerChain.setRoles</code> and
<code>HandlerChain.getRoles</code>. Handler instances in
the HandlerChain use this information about the SOAP actor
roles to process the SOAP header blocks. Note that the
SOAP actor roles are invariant during the processing of
SOAP message through the HandlerChain.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Array of URIs for SOAP actor roles</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../javax/xml/rpc/handler/HandlerChain.html#setRoles(java.lang.String[])"><code>HandlerChain.setRoles(java.lang.String[])</code></a>,
<a href="../../../../../javax/xml/rpc/handler/HandlerChain.html#getRoles()"><code>HandlerChain.getRoles()</code></a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SOAPMessageContext.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?javax/xml/rpc/handler/soap/SOAPMessageContext.html" target="_top">Frames</a></li>
<li><a href="SOAPMessageContext.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>