Google Git
Sign in
apache / axis-site / 59f868382c795565589011a22bccb658c1da1ae8 / . / axis2 / java / rampart / apidocs / org / apache / rahas / TokenCanceler.html
blob: 2bfd0ff0270d9898747de82c5d952bc67f84a569 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>TokenCanceler (Apache Rampart)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.rahas, interface: TokenCanceler">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/TokenCanceler.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rahas</a></div>
<h1 title="Interface TokenCanceler" class="title">Interface TokenCanceler</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/TokenCancelerImpl.html" title="class in org.apache.rahas.impl">TokenCancelerImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TokenCanceler</span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.axiom.soap.SOAPEnvelope</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#cancel(org.apache.rahas.RahasData)" class="member-name-link">cancel</a><wbr>(<a href="RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cancel the token specified in the request.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getResponseAction(org.apache.rahas.RahasData)" class="member-name-link">getResponseAction</a><wbr>(<a href="RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConfigurationElement(org.apache.axiom.om.OMElement)" class="member-name-link">setConfigurationElement</a><wbr>(org.apache.axiom.om.OMElement&nbsp;configElement)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the configuration element of this TokenCanceller.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConfigurationFile(java.lang.String)" class="member-name-link">setConfigurationFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configFile)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the configuration file of this TokenCanceller.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setConfigurationParamName(java.lang.String)" class="member-name-link">setConfigurationParamName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configParamName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the name of the configuration parameter.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="cancel(org.apache.rahas.RahasData)">
<h3>cancel</h3>
<div class="member-signature"><span class="return-type">org.apache.axiom.soap.SOAPEnvelope</span>&nbsp;<span class="element-name">cancel</span><wbr><span class="parameters">(<a href="RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">Cancel the token specified in the request.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt>Returns:</dt>
<dd>Response SOAPEnveloper</dd>
<dt>Throws:</dt>
<dd><code><a href="TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationFile(java.lang.String)">
<h3>setConfigurationFile</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configFile)</span></div>
<div class="block">Set the configuration file of this TokenCanceller.
<p>
This is the text value of the &lt;configuration-file&gt; element of the
token-dispatcher-configuration</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>configFile</code> - </dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationElement(org.apache.axiom.om.OMElement)">
<h3>setConfigurationElement</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationElement</span><wbr><span class="parameters">(org.apache.axiom.om.OMElement&nbsp;configElement)</span></div>
<div class="block">Set the configuration element of this TokenCanceller.
<p>
This is the &lt;configuration&gt; element of the
token-dispatcher-configuration</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>configElement</code> - <code>OMElement</code> representing the configuration</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationParamName(java.lang.String)">
<h3>setConfigurationParamName</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationParamName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configParamName)</span></div>
<div class="block">Set the name of the configuration parameter.
<p>
If this is used then there must be a
<code>org.apache.axis2.description.Parameter</code> object available in
the via the messageContext when the <code>TokenIssuer</code> is called.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>configParamName</code> - </dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><code>Parameter</code></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getResponseAction(org.apache.rahas.RahasData)">
<h3>getResponseAction</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getResponseAction</span><wbr><span class="parameters">(<a href="RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt>Returns:</dt>
<dd>Returns the <code>wsa:Action</code> of the response</dd>
<dt>Throws:</dt>
<dd><code><a href="TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>