| <!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>TokenStore (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="TokenStore (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/TokenStore.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/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStoreFactory.html" title="class in org.apache.cxf.ws.security.tokenstore"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/ws/security/tokenstore/TokenStore.html" target="_top">Frames</a></li> |
| <li><a href="TokenStore.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.security.tokenstore</div> |
| <h2 title="Interface TokenStore" class="title">Interface TokenStore</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/cache/DefaultInMemoryTokenStore.html" title="class in org.apache.cxf.sts.cache">DefaultInMemoryTokenStore</a>, <a href="../../../../../../org/apache/cxf/ws/security/tokenstore/EHCacheTokenStore.html" title="class in org.apache.cxf.ws.security.tokenstore">EHCacheTokenStore</a>, <a href="../../../../../../org/apache/cxf/sts/cache/HazelCastTokenStore.html" title="class in org.apache.cxf.sts.cache">HazelCastTokenStore</a>, <a href="../../../../../../org/apache/cxf/ws/security/tokenstore/MemoryTokenStore.html" title="class in org.apache.cxf.ws.security.tokenstore">MemoryTokenStore</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TokenStore</span></pre> |
| <div class="block">This interface defines a caching mechanism for security tokens. It is up to the underlying implementation |
| to handle token expiration (e.g. by querying the SecurityToken's expires date).</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"> </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/cxf/ws/security/tokenstore/TokenStore.html#add(org.apache.cxf.ws.security.tokenstore.SecurityToken)">add</a></strong>(<a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a> token)</code> |
| <div class="block">Add the given token to the cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#add(java.lang.String,%20org.apache.cxf.ws.security.tokenstore.SecurityToken)">add</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier, |
| <a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a> token)</code> |
| <div class="block">Add the given token to the cache under the given identifier</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#getToken(java.lang.String)">getToken</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</code> |
| <div class="block">Returns the <code>Token</code> of the given identifier</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/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/cxf/ws/security/tokenstore/TokenStore.html#getTokenIdentifiers()">getTokenIdentifiers</a></strong>()</code> |
| <div class="block">Return the list of all valid token identifiers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStore.html#remove(java.lang.String)">remove</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</code> |
| <div class="block">Remove an existing token by its identifier</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="add(org.apache.cxf.ws.security.tokenstore.SecurityToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>void add(<a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a> token)</pre> |
| <div class="block">Add the given token to the cache. The SecurityTokens getId() identifier will be used to |
| key it in the cache.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - The token to be added</dd></dl> |
| </li> |
| </ul> |
| <a name="add(java.lang.String, org.apache.cxf.ws.security.tokenstore.SecurityToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>void add(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier, |
| <a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a> token)</pre> |
| <div class="block">Add the given token to the cache under the given identifier</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>identifier</code> - The identifier to use to key the SecurityToken in the cache</dd><dd><code>token</code> - The token to be added</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void remove(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</pre> |
| <div class="block">Remove an existing token by its identifier</div> |
| </li> |
| </ul> |
| <a name="getTokenIdentifiers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTokenIdentifiers</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getTokenIdentifiers()</pre> |
| <div class="block">Return the list of all valid token identifiers.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>As array of (valid) token identifiers</dd></dl> |
| </li> |
| </ul> |
| <a name="getToken(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getToken</h4> |
| <pre><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore">SecurityToken</a> getToken(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</pre> |
| <div class="block">Returns the <code>Token</code> of the given identifier</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>identifier</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The requested <code>Token</code> identified by the given identifier</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/TokenStore.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/ws/security/tokenstore/SecurityToken.html" title="class in org.apache.cxf.ws.security.tokenstore"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/ws/security/tokenstore/TokenStoreFactory.html" title="class in org.apache.cxf.ws.security.tokenstore"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/ws/security/tokenstore/TokenStore.html" target="_top">Frames</a></li> |
| <li><a href="TokenStore.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
