blob: 359e3c3c1d55c3c2ec934ad6ce1267520355acd2 [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>PolicyInterceptorProvider (Apache CXF JavaDoc 3.4.5 API)</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="PolicyInterceptorProvider (Apache CXF JavaDoc 3.4.5 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/PolicyInterceptorProvider.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 class="aboutLanguage">Apache CXF API</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/ws/policy/PolicyInInterceptor.html" title="class in org.apache.cxf.ws.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/ws/policy/PolicyInterceptorProviderLoader.html" title="interface in org.apache.cxf.ws.policy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/ws/policy/PolicyInterceptorProvider.html" target="_top">Frames</a></li>
<li><a href="PolicyInterceptorProvider.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.cxf.ws.policy</div>
<h2 title="Interface PolicyInterceptorProvider" class="title">Interface PolicyInterceptorProvider</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html" title="interface in org.apache.cxf.interceptor">InterceptorProvider</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/cxf/ws/policy/AbstractPolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.policy">AbstractPolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/addressing/policy/AddressingPolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.addressing.policy">AddressingPolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/HttpsTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">HttpsTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/policy/IgnorablePolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.policy">IgnorablePolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/IssuedTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">IssuedTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/KerberosTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">KerberosTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/policy/mtom/MTOMPolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.policy.mtom">MTOMPolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/transport/http/policy/NoOpPolicyInterceptorProvider.html" title="class in org.apache.cxf.transport.http.policy">NoOpPolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/rm/policy/RMPolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.rm.policy">RMPolicyInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/SamlTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">SamlTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/SecureConversationTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">SecureConversationTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/SpnegoTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">SpnegoTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/UsernameTokenInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">UsernameTokenInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/WSSecurityInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">WSSecurityInterceptorProvider</a>, <a href="../../../../../org/apache/cxf/ws/security/policy/interceptors/WSSecurityPolicyInterceptorProvider.html" title="class in org.apache.cxf.ws.security.policy.interceptors">WSSecurityPolicyInterceptorProvider</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PolicyInterceptorProvider</span>
extends <a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html" title="interface in org.apache.cxf.interceptor">InterceptorProvider</a></pre>
</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/ws/policy/PolicyInterceptorProvider.html#configurationPresent-org.apache.cxf.message.Message-org.apache.neethi.Assertion-">configurationPresent</a></span>(<a href="../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>&nbsp;msg,
org.apache.neethi.Assertion&nbsp;assertion)</code>
<div class="block">Return false if the message does not contain enough contextual configuration to preemtively
support the given assertion.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cxf/ws/policy/PolicyInterceptorProvider.html#getAssertionTypes--">getAssertionTypes</a></span>()</code>
<div class="block">Returns a collection of QNames describing the xml schema types of the assertions that
this interceptor implements.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cxf.interceptor.InterceptorProvider">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cxf.interceptor.<a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html" title="interface in org.apache.cxf.interceptor">InterceptorProvider</a></h3>
<code><a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html#getInFaultInterceptors--">getInFaultInterceptors</a>, <a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html#getInInterceptors--">getInInterceptors</a>, <a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html#getOutFaultInterceptors--">getOutFaultInterceptors</a>, <a href="../../../../../org/apache/cxf/interceptor/InterceptorProvider.html#getOutInterceptors--">getOutInterceptors</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="getAssertionTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAssertionTypes</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a>&gt;&nbsp;getAssertionTypes()</pre>
<div class="block">Returns a collection of QNames describing the xml schema types of the assertions that
this interceptor implements.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>collection of QNames of known assertion types</dd>
</dl>
</li>
</ul>
<a name="configurationPresent-org.apache.cxf.message.Message-org.apache.neethi.Assertion-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>configurationPresent</h4>
<pre>boolean&nbsp;configurationPresent(<a href="../../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a>&nbsp;msg,
org.apache.neethi.Assertion&nbsp;assertion)</pre>
<div class="block">Return false if the message does not contain enough contextual configuration to preemtively
support the given assertion. Otherwise, return true. If false, the PolicyEngine.supportsAlternative
method will not select this policy and will attempt a different alternative.
Example: If the context does not contain login information, an assertion that requires it
could return false to allow the Alternative selection algorithms to try a different alternative.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - The contextual message, may be null if no message is in context at this point</dd>
<dd><code>assertion</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</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/PolicyInterceptorProvider.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 class="aboutLanguage">Apache CXF API</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/ws/policy/PolicyInInterceptor.html" title="class in org.apache.cxf.ws.policy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/ws/policy/PolicyInterceptorProviderLoader.html" title="interface in org.apache.cxf.ws.policy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/ws/policy/PolicyInterceptorProvider.html" target="_top">Frames</a></li>
<li><a href="PolicyInterceptorProvider.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>Apache CXF</small></p>
</body>
</html>