Google Git
Sign in
apache / axis-site / b0e13d4b24437ff26e96c3d95ca0ac6e466a3951 / . / axis2 / java / rampart-staging / apidocs / org / apache / rahas / TokenStorage.html
blob: 71eda54e68948e21ba541d87b820ede81e24b8e6 [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>TokenStorage (Apache Rampart)</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="TokenStorage (Apache Rampart)";
}
//-->
</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/TokenStorage.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/rahas/TokenRequestDispatcherConfig.html" title="class in org.apache.rahas"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/rahas/TokenValidator.html" title="interface in org.apache.rahas"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/rahas/TokenStorage.html" target="_top">Frames</a></li>
<li><a href="TokenStorage.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.rahas</div>
<h2 title="Interface TokenStorage" class="title">Interface TokenStorage</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/rahas/SimpleTokenStore.html" title="class in org.apache.rahas">SimpleTokenStore</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TokenStorage</span></pre>
<div class="block">The storage interface to store security tokens and
manipulate them</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#TOKEN_STORAGE_KEY">TOKEN_STORAGE_KEY</a></strong></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="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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#add(org.apache.rahas.Token)">add</a></strong>(<a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>&nbsp;token)</code>
<div class="block">Add the given token to the list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getCancelledTokens()">getCancelledTokens</a></strong>()</code>
<div class="block">Return the list of CANCELLED tokens</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getExpiredTokens()">getExpiredTokens</a></strong>()</code>
<div class="block">Return the list of <code>EXPIRED</code> tokens.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getRenewedTokens()">getRenewedTokens</a></strong>()</code>
<div class="block">Return the list of RENEWED tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getToken(java.lang.String)">getToken</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">Returns the <code>Token</code> of the given id</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getTokenIdentifiers()">getTokenIdentifiers</a></strong>()</code>
<div class="block">Return the list of all token identifiers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#getValidTokens()">getValidTokens</a></strong>()</code>
<div class="block">Return the list of ISSUED and RENEWED tokens.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#removeToken(java.lang.String)">removeToken</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">Removes the given token from token storage.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenStorage.html#update(org.apache.rahas.Token)">update</a></strong>(<a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>&nbsp;token)</code>
<div class="block">Update an existing token.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TOKEN_STORAGE_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TOKEN_STORAGE_KEY</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOKEN_STORAGE_KEY</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.apache.rahas.TokenStorage.TOKEN_STORAGE_KEY">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="add(org.apache.rahas.Token)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void&nbsp;add(<a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>&nbsp;token)
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Add the given token to the list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - The token to be added</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="update(org.apache.rahas.Token)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(<a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>&nbsp;token)
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Update an existing token.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getTokenIdentifiers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTokenIdentifiers</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getTokenIdentifiers()
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Return the list of all token identifiers.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>As array of token identifiers</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getExpiredTokens()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpiredTokens</h4>
<pre><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]&nbsp;getExpiredTokens()
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Return the list of <code>EXPIRED</code> tokens.
If there are no <code>EXPIRED</code> tokens <code>null</code> will be
returned</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of expired <code>Tokens</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getValidTokens()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidTokens</h4>
<pre><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]&nbsp;getValidTokens()
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Return the list of ISSUED and RENEWED tokens.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of ISSUED and RENEWED <code>Tokens</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getRenewedTokens()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenewedTokens</h4>
<pre><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]&nbsp;getRenewedTokens()
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Return the list of RENEWED tokens.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of RENEWED <code>Tokens</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getCancelledTokens()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCancelledTokens</h4>
<pre><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>[]&nbsp;getCancelledTokens()
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Return the list of CANCELLED tokens</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>An array of CANCELLED <code>Tokens</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="getToken(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToken</h4>
<pre><a href="../../../org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a>&nbsp;getToken(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Returns the <code>Token</code> of the given id</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>The requested <code>Token</code> identified by the give id</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code></dd></dl>
</li>
</ul>
<a name="removeToken(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeToken</h4>
<pre>void&nbsp;removeToken(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
<div class="block">Removes the given token from token storage.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - Token id to remove.</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><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/TokenStorage.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/rahas/TokenRequestDispatcherConfig.html" title="class in org.apache.rahas"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/rahas/TokenValidator.html" title="interface in org.apache.rahas"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/rahas/TokenStorage.html" target="_top">Frames</a></li>
<li><a href="TokenStorage.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>Copyright &copy; <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>