blob: a9fa239092ae665ab451de47d444f74928448a0a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MustUnderstandChecker (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="MustUnderstandChecker (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"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";
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/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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.axis2.jaxws.dispatchers</a></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" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">org.apache.axis2.handlers.AbstractHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="../../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><code><a href="../../engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MustUnderstandChecker</span>
extends <a href="../../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 ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="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="../../engine/Handler.html" title="interface in org.apache.axis2.engine">Handler</a></h3>
<code><a href="../../engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3>
<code><a href="../../handlers/AbstractHandler.html#handlerDesc">handlerDesc</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">MustUnderstandChecker</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doInvoke(org.apache.axis2.context.MessageContext)">doInvoke</a></span>&#8203;(<a href="../../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldInvoke(org.apache.axis2.context.MessageContext)">shouldInvoke</a></span>&#8203;(<a href="../../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code></th>
<td class="colLast">
<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 id="methods.inherited.from.class.org.apache.axis2.handlers.AbstractTemplatedHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a></h3>
<code><a href="../../handlers/AbstractTemplatedHandler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.axis2.handlers.AbstractHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.handlers.<a href="../../handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a></h3>
<code><a href="../../handlers/AbstractHandler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a>, <a href="../../handlers/AbstractHandler.html#getHandlerDesc()">getHandlerDesc</a>, <a href="../../handlers/AbstractHandler.html#getName()">getName</a>, <a href="../../handlers/AbstractHandler.html#getParameter(java.lang.String)">getParameter</a>, <a href="../../handlers/AbstractHandler.html#init(org.apache.axis2.description.HandlerDescription)">init</a>, <a href="../../handlers/AbstractHandler.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MustUnderstandChecker</h4>
<pre>public&nbsp;MustUnderstandChecker()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="shouldInvoke(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldInvoke</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;shouldInvoke&#8203;(<a href="../../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../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="../../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="../../handlers/AbstractTemplatedHandler.html#shouldInvoke(org.apache.axis2.context.MessageContext)">shouldInvoke</a></code>&nbsp;in class&nbsp;<code><a href="../../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="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in an error in evaluating the decision</dd>
</dl>
</li>
</ul>
<a id="doInvoke(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doInvoke</h4>
<pre class="methodSignature">public&nbsp;<a href="../../engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a>&nbsp;doInvoke&#8203;(<a href="../../context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../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="../../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="../../handlers/AbstractTemplatedHandler.html#doInvoke(org.apache.axis2.context.MessageContext)">doInvoke</a></code>&nbsp;in class&nbsp;<code><a href="../../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 <a href="../../engine/Handler.InvocationResponse.html#CONTINUE"><code>Handler.InvocationResponse.CONTINUE</code></a>,
<a href="../../engine/Handler.InvocationResponse.html#ABORT"><code>Handler.InvocationResponse.ABORT</code></a>, <a href="../../engine/Handler.InvocationResponse.html#SUSPEND"><code>Handler.InvocationResponse.SUSPEND</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - in an error in invoking the handler</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/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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>