| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>RememberMeIdentityStore</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="RememberMeIdentityStore"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":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="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="../../../../javax/security/enterprise/identitystore/Pbkdf2PasswordHash.html" title="interface in javax.security.enterprise.identitystore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/security/enterprise/identitystore/RememberMeIdentityStore.html" target="_top">Frames</a></li> |
| <li><a href="RememberMeIdentityStore.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">javax.security.enterprise.identitystore</div> |
| <h2 title="Interface RememberMeIdentityStore" class="title">Interface RememberMeIdentityStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RememberMeIdentityStore</span></pre> |
| <div class="block"><code>RememberMeIdentityStore</code> is a mechanism for validating a caller's |
| credentials and accessing a caller's identity attributes that's specifically |
| tailored for the "remember me" feature. |
| |
| <p> |
| This is not intended to be directly used by an authentication mechanism such as |
| the JSR 375 <a href="../../../../javax/security/enterprise/authentication/mechanism/http/HttpAuthenticationMechanism.html" title="interface in javax.security.enterprise.authentication.mechanism.http"><code>HttpAuthenticationMechanism</code></a> or the JSR 196 (JASPIC) |
| <code>ServerAuthModule</code>. Instead, the interceptor implementation backing the |
| <a href="../../../../javax/security/enterprise/authentication/mechanism/http/RememberMe.html" title="annotation in javax.security.enterprise.authentication.mechanism.http"><code>RememberMe</code></a> annotation is intended to use this.</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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/security/enterprise/identitystore/RememberMeIdentityStore.html#generateLoginToken-javax.security.enterprise.CallerPrincipal-java.util.Set-">generateLoginToken</a></span>(<a href="../../../../javax/security/enterprise/CallerPrincipal.html" title="class in javax.security.enterprise">CallerPrincipal</a> callerPrincipal, |
| java.util.Set<java.lang.String> groups)</code> |
| <div class="block">Associates the given principal and groups with a token.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/security/enterprise/identitystore/RememberMeIdentityStore.html#removeLoginToken-java.lang.String-">removeLoginToken</a></span>(java.lang.String token)</code> |
| <div class="block">Dissociates the principal and groups that were associated with the token before |
| and removes the token itself.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/security/enterprise/identitystore/CredentialValidationResult.html" title="class in javax.security.enterprise.identitystore">CredentialValidationResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/security/enterprise/identitystore/RememberMeIdentityStore.html#validate-javax.security.enterprise.credential.RememberMeCredential-">validate</a></span>(<a href="../../../../javax/security/enterprise/credential/RememberMeCredential.html" title="class in javax.security.enterprise.credential">RememberMeCredential</a> credential)</code> |
| <div class="block">Validates the given credential.</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="validate-javax.security.enterprise.credential.RememberMeCredential-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre><a href="../../../../javax/security/enterprise/identitystore/CredentialValidationResult.html" title="class in javax.security.enterprise.identitystore">CredentialValidationResult</a> validate(<a href="../../../../javax/security/enterprise/credential/RememberMeCredential.html" title="class in javax.security.enterprise.credential">RememberMeCredential</a> credential)</pre> |
| <div class="block">Validates the given credential.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>credential</code> - The credential to validate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The validation result, including associated caller groups.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generateLoginToken-javax.security.enterprise.CallerPrincipal-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateLoginToken</h4> |
| <pre>java.lang.String generateLoginToken(<a href="../../../../javax/security/enterprise/CallerPrincipal.html" title="class in javax.security.enterprise">CallerPrincipal</a> callerPrincipal, |
| java.util.Set<java.lang.String> groups)</pre> |
| <div class="block">Associates the given principal and groups with a token. |
| <p> |
| The token generated by this method is intended to be used with the |
| <a href="../../../../javax/security/enterprise/credential/RememberMeCredential.html" title="class in javax.security.enterprise.credential"><code>RememberMeCredential</code></a> and passed into the <a href="../../../../javax/security/enterprise/identitystore/RememberMeIdentityStore.html#validate-javax.security.enterprise.credential.RememberMeCredential-"><code>validate(RememberMeCredential)</code></a> |
| method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callerPrincipal</code> - The principal to be associated.</dd> |
| <dd><code>groups</code> - The groups the principal is in.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A token that can be used to get the principal and groups back at a later time.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeLoginToken-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeLoginToken</h4> |
| <pre>void removeLoginToken(java.lang.String token)</pre> |
| <div class="block">Dissociates the principal and groups that were associated with the token before |
| and removes the token itself. |
| <p> |
| If the token did not exist (i.e. no principal and groups were associated with that token) |
| no exception will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - The token that is to be removed.</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> |
| <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="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="../../../../javax/security/enterprise/identitystore/Pbkdf2PasswordHash.html" title="interface in javax.security.enterprise.identitystore"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/security/enterprise/identitystore/RememberMeIdentityStore.html" target="_top">Frames</a></li> |
| <li><a href="RememberMeIdentityStore.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 ======= --> |
| </body> |
| </html> |
