Google Git
Sign in
apache / axis-site / 84b9111c2d7c38de41f68c42d711fd6748a8bad1 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / jaxws / dispatchers / MustUnderstandChecker.html
blob: c25523438ea26fffedec4cd1f57cf77297a26bf1 [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>MustUnderstandChecker (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="MustUnderstandChecker (Apache Axis2)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/MustUnderstandChecker.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/jaxws/dispatchers/GenericProviderDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandUtils.html" title="class in org.apache.axis2.jaxws.dispatchers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html" target="_top">Frames</a></li>
<li><a href="MustUnderstandChecker.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><a href="#fields.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.jaxws.dispatchers</div>
<h2 title="Class MustUnderstandChecker" class="title">Class MustUnderstandChecker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">org.apache.axis2.handlers.AbstractHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">org.apache.axis2.handlers.AbstractTemplatedHandler</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.jaxws.dispatchers.MustUnderstandChecker</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MustUnderstandChecker</span>
extends <a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a></pre>
<div class="block">Plugin to remove "understood" headers for the JAXWS related headers. This class must
be configured in the axis2.xml file on both the client and the server.
Understood headers (per JAXWS 2.0 Section 10.2) include
- Headers that correspond to SEI method parameters.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.axis2.engine.Handler">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.axis2.engine.<a href="../../../../../org/apache/axis2/engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3>
<code><a href="../../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3>
<code><a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#handlerDesc">handlerDesc</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html#MustUnderstandChecker--">MustUnderstandChecker</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="../../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html#doInvoke-org.apache.axis2.context.MessageContext-">doInvoke</a></span>(<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">This should implement the actual handler invocation logic.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html#shouldInvoke-org.apache.axis2.context.MessageContext-">shouldInvoke</a></span>(<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">This method should implement the conditional check of the handler to decide whether this
particular message needs to be handled by me</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.axis2.handlers.AbstractTemplatedHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a></h3>
<code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#invoke-org.apache.axis2.context.MessageContext-">invoke</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3>
<code><a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#flowComplete-org.apache.axis2.context.MessageContext-">flowComplete</a>, <a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#getHandlerDesc--">getHandlerDesc</a>, <a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#getName--">getName</a>, <a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#getParameter-java.lang.String-">getParameter</a>, <a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#init-org.apache.axis2.description.HandlerDescription-">init</a>, <a href="../../../../../org/apache/axis2/handlers/AbstractHandler.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MustUnderstandChecker--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MustUnderstandChecker</h4>
<pre>public&nbsp;MustUnderstandChecker()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="shouldInvoke-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldInvoke</h4>
<pre>public&nbsp;boolean&nbsp;shouldInvoke(<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#shouldInvoke-org.apache.axis2.context.MessageContext-">AbstractTemplatedHandler</a></code></span></div>
<div class="block">This method should implement the conditional check of the handler to decide whether this
particular message needs to be handled by me</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#shouldInvoke-org.apache.axis2.context.MessageContext-">shouldInvoke</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgContext</code> - current <code>MessageContext</code> to be evaluated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean <code>true<code>, if this handler needs to be further invoked,
<code>false</code> if this handler has nothing to do with this specific message
and want the flow to be continued</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> - in an error in evaluating the decision</dd>
</dl>
</li>
</ul>
<a name="doInvoke-org.apache.axis2.context.MessageContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doInvoke</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a>&nbsp;doInvoke(<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#doInvoke-org.apache.axis2.context.MessageContext-">AbstractTemplatedHandler</a></code></span></div>
<div class="block">This should implement the actual handler invocation logic.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html#doInvoke-org.apache.axis2.context.MessageContext-">doInvoke</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msgContext</code> - current message to be handled by this handler</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>flow completion decision, should be one of <code>InvocationResponse#CONTINUE</code>,
<code>InvocationResponse#ABORT</code>, <code>InvocationResponse#SUSPEND</code></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> - in an error in invoking the handler</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/MustUnderstandChecker.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/jaxws/dispatchers/GenericProviderDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandUtils.html" title="class in org.apache.axis2.jaxws.dispatchers"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html" target="_top">Frames</a></li>
<li><a href="MustUnderstandChecker.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><a href="#fields.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>