blob: 180d9c641f84ef62824ea8ac189674a7477e68ee [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>TokenCanceller (Apache CXF JavaDoc 3.1.0 API)</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="TokenCanceller (Apache CXF JavaDoc 3.1.0 API)";
}
//-->
</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/TokenCanceller.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"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/sts/token/canceller/SCTCanceller.html" title="class in org.apache.cxf.sts.token.canceller"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerParameters.html" title="class in org.apache.cxf.sts.token.canceller"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/sts/token/canceller/TokenCanceller.html" target="_top">Frames</a></li>
<li><a href="TokenCanceller.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">org.apache.cxf.sts.token.canceller</div>
<h2 title="Interface TokenCanceller" class="title">Interface TokenCanceller</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/cxf/sts/token/canceller/SCTCanceller.html" title="class in org.apache.cxf.sts.token.canceller">SCTCanceller</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TokenCanceller</span></pre>
<div class="block">An interface that can cancel a security token.</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="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="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerResponse.html" title="class in org.apache.cxf.sts.token.canceller">TokenCancellerResponse</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCanceller.html#cancelToken(org.apache.cxf.sts.token.canceller.TokenCancellerParameters)">cancelToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerParameters.html" title="class in org.apache.cxf.sts.token.canceller">TokenCancellerParameters</a>&nbsp;tokenParameters)</code>
<div class="block">Cancel a token given a TokenCancellerParameters</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCanceller.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">canHandleToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a>&nbsp;cancelTarget)</code>
<div class="block">Return true if this TokenCanceller implementation is able to cancel a token
that corresponds to the given token.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCanceller.html#setVerifyProofOfPossession(boolean)">setVerifyProofOfPossession</a></strong>(boolean&nbsp;verifyProofOfPossession)</code>
<div class="block">boolean for enabling/disabling verification of proof of possession.</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="setVerifyProofOfPossession(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerifyProofOfPossession</h4>
<pre>void&nbsp;setVerifyProofOfPossession(boolean&nbsp;verifyProofOfPossession)</pre>
<div class="block">boolean for enabling/disabling verification of proof of possession.</div>
</li>
</ul>
<a name="canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canHandleToken</h4>
<pre>boolean&nbsp;canHandleToken(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a>&nbsp;cancelTarget)</pre>
<div class="block">Return true if this TokenCanceller implementation is able to cancel a token
that corresponds to the given token.</div>
</li>
</ul>
<a name="cancelToken(org.apache.cxf.sts.token.canceller.TokenCancellerParameters)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancelToken</h4>
<pre><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerResponse.html" title="class in org.apache.cxf.sts.token.canceller">TokenCancellerResponse</a>&nbsp;cancelToken(<a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerParameters.html" title="class in org.apache.cxf.sts.token.canceller">TokenCancellerParameters</a>&nbsp;tokenParameters)</pre>
<div class="block">Cancel a token given a TokenCancellerParameters</div>
</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/TokenCanceller.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"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/cxf/sts/token/canceller/SCTCanceller.html" title="class in org.apache.cxf.sts.token.canceller"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/cxf/sts/token/canceller/TokenCancellerParameters.html" title="class in org.apache.cxf.sts.token.canceller"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/sts/token/canceller/TokenCanceller.html" target="_top">Frames</a></li>
<li><a href="TokenCanceller.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>Apache CXF</small></p>
</body>
</html>