| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CookieRememberMeManager (Apache Shiro 1.9.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CookieRememberMeManager (Apache Shiro 1.9.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CookieRememberMeManager.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.web.mgt</a></div> |
| <h2 title="Class CookieRememberMeManager" class="title">Class CookieRememberMeManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.AbstractRememberMeManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.mgt.CookieRememberMeManager</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../mgt/RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.71">CookieRememberMeManager</a> |
| extends <a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></pre> |
| <div class="block">Remembers a Subject's identity by saving the Subject's <a href="../../subject/Subject.html#getPrincipals()"><code>principals</code></a> to a <a href="../servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><code>Cookie</code></a> |
| for later retrieval. |
| <p/> |
| Cookie attributes (path, domain, maxAge, etc) may be set on this class's default |
| <a href="#getCookie()"><code>cookie</code></a> attribute, which acts as a template to use to set all properties of outgoing cookies |
| created by this implementation. |
| <p/> |
| The default cookie has the following attribute values set: |
| <table> |
| <tr> |
| <th>Attribute Name</th> |
| <th>Value</th> |
| </tr> |
| <tr><td><a href="../servlet/Cookie.html#getName()"><code>name</code></a></td> |
| <td><code>rememberMe</code></td> |
| </tr> |
| <tr> |
| <td><a href="../servlet/Cookie.html#getPath()"><code>path</code></a></td> |
| <td><code>/</code></td> |
| </tr> |
| <tr> |
| <td><a href="../servlet/Cookie.html#getMaxAge()"><code>maxAge</code></a></td> |
| <td><a href="../servlet/Cookie.html#ONE_YEAR"><code>Cookie.ONE_YEAR</code></a></td> |
| </tr> |
| </table> |
| <p/> |
| Note that because this class subclasses the <a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt"><code>AbstractRememberMeManager</code></a> which already provides serialization |
| and encryption logic, this class utilizes both for added security before setting the cookie value.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_REMEMBER_ME_COOKIE_NAME">DEFAULT_REMEMBER_ME_COOKIE_NAME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The default name of the underlying rememberMe cookie which is <code>rememberMe</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CookieRememberMeManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new <code>CookieRememberMeManager</code> with a default <code>rememberMe</code> cookie template.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forgetIdentity(org.apache.shiro.subject.Subject)">forgetIdentity</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the 'rememberMe' cookie from the associated <a href="../subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a>'s request/response pair.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forgetIdentity(org.apache.shiro.subject.SubjectContext)">forgetIdentity</a></span>​(<a href="../../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the 'rememberMe' cookie from the associated <a href="../subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><code>WebSubjectContext</code></a>'s request/response pair.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookie()">getCookie</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by |
| this <code>RememberMeManager</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)">getRememberedSerializedIdentity</a></span>​(<a href="../../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a previously serialized identity byte array or <code>null</code> if the byte array could not be acquired.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rememberSerializedIdentity(org.apache.shiro.subject.Subject,byte%5B%5D)">rememberSerializedIdentity</a></span>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| byte[] serialized)</code></th> |
| <td class="colLast"> |
| <div class="block">Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCookie(org.apache.shiro.web.servlet.Cookie)">setCookie</a></span>​(<a href="../servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a> cookie)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by |
| this <code>RememberMeManager</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.AbstractRememberMeManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.mgt.<a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></h3> |
| <code><a href="../../mgt/AbstractRememberMeManager.html#convertBytesToPrincipals(byte%5B%5D,org.apache.shiro.subject.SubjectContext)">convertBytesToPrincipals</a>, <a href="../../mgt/AbstractRememberMeManager.html#convertPrincipalsToBytes(org.apache.shiro.subject.PrincipalCollection)">convertPrincipalsToBytes</a>, <a href="../../mgt/AbstractRememberMeManager.html#decrypt(byte%5B%5D)">decrypt</a>, <a href="../../mgt/AbstractRememberMeManager.html#deserialize(byte%5B%5D)">deserialize</a>, <a href="../../mgt/AbstractRememberMeManager.html#encrypt(byte%5B%5D)">encrypt</a>, <a href="../../mgt/AbstractRememberMeManager.html#getCipherKey()">getCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#getCipherService()">getCipherService</a>, <a href="../../mgt/AbstractRememberMeManager.html#getDecryptionCipherKey()">getDecryptionCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#getEncryptionCipherKey()">getEncryptionCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#getIdentityToRemember(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationInfo)">getIdentityToRemember</a>, <a href="../../mgt/AbstractRememberMeManager.html#getRememberedPrincipals(org.apache.shiro.subject.SubjectContext)">getRememberedPrincipals</a>, <a href="../../mgt/AbstractRememberMeManager.html#getSerializer()">getSerializer</a>, <a href="../../mgt/AbstractRememberMeManager.html#isRememberMe(org.apache.shiro.authc.AuthenticationToken)">isRememberMe</a>, <a href="../../mgt/AbstractRememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a>, <a href="../../mgt/AbstractRememberMeManager.html#onLogout(org.apache.shiro.subject.Subject)">onLogout</a>, <a href="../../mgt/AbstractRememberMeManager.html#onRememberedPrincipalFailure(java.lang.RuntimeException,org.apache.shiro.subject.SubjectContext)">onRememberedPrincipalFailure</a>, <a href="../../mgt/AbstractRememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a>, <a href="../../mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken,org.apache.shiro.authc.AuthenticationInfo)">rememberIdentity</a>, <a href="../../mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject,org.apache.shiro.subject.PrincipalCollection)">rememberIdentity</a>, <a href="../../mgt/AbstractRememberMeManager.html#serialize(org.apache.shiro.subject.PrincipalCollection)">serialize</a>, <a href="../../mgt/AbstractRememberMeManager.html#setCipherKey(byte%5B%5D)">setCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#setCipherService(org.apache.shiro.crypto.CipherService)">setCipherService</a>, <a href="../../mgt/AbstractRememberMeManager.html#setDecryptionCipherKey(byte%5B%5D)">setDecryptionCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#setEncryptionCipherKey(byte%5B%5D)">setEncryptionCipherKey</a>, <a href="../../mgt/AbstractRememberMeManager.html#setSerializer(org.apache.shiro.io.Serializer)">setSerializer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DEFAULT_REMEMBER_ME_COOKIE_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_REMEMBER_ME_COOKIE_NAME</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.80">DEFAULT_REMEMBER_ME_COOKIE_NAME</a></pre> |
| <div class="block">The default name of the underlying rememberMe cookie which is <code>rememberMe</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.shiro.web.mgt.CookieRememberMeManager.DEFAULT_REMEMBER_ME_COOKIE_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CookieRememberMeManager</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.87">CookieRememberMeManager</a>()</pre> |
| <div class="block">Constructs a new <code>CookieRememberMeManager</code> with a default <code>rememberMe</code> cookie template.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getCookie()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCookie</h4> |
| <pre class="methodSignature">public <a href="../servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a> <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.106">getCookie</a>()</pre> |
| <div class="block">Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by |
| this <code>RememberMeManager</code>. Outgoing cookies will match this one except for the |
| <a href="../servlet/Cookie.html#getValue()"><code>value</code></a> attribute, which is necessarily set dynamically at runtime. |
| <p/> |
| Please see the class-level JavaDoc for the default cookie's attribute values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by |
| this <code>RememberMeManager</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCookie(org.apache.shiro.web.servlet.Cookie)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCookie</h4> |
| <pre class="methodSignature">public void <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.120">setCookie</a>​(<a href="../servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a> cookie)</pre> |
| <div class="block">Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by |
| this <code>RememberMeManager</code>. Outgoing cookies will match this one except for the |
| <a href="../servlet/Cookie.html#getValue()"><code>value</code></a> attribute, which is necessarily set dynamically at runtime. |
| <p/> |
| Please see the class-level JavaDoc for the default cookie's attribute values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookie</code> - the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created |
| by this <code>RememberMeManager</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rememberSerializedIdentity(org.apache.shiro.subject.Subject,byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rememberSerializedIdentity</h4> |
| <pre class="methodSignature">protected void <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.135">rememberSerializedIdentity</a>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject, |
| byte[] serialized)</pre> |
| <div class="block">Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value. |
| <p/> |
| The <code>subject</code> instance is expected to be a <a href="../subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> instance with an HTTP Request/Response pair |
| so an HTTP cookie can be set on the outgoing response. If it is not a <code>WebSubject</code> or that |
| <code>WebSubject</code> does not have an HTTP Request/Response pair, this implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../mgt/AbstractRememberMeManager.html#rememberSerializedIdentity(org.apache.shiro.subject.Subject,byte%5B%5D)">rememberSerializedIdentity</a></code> in class <code><a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the Subject for which the identity is being serialized.</dd> |
| <dd><code>serialized</code> - the serialized bytes to be persisted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRememberedSerializedIdentity</h4> |
| <pre class="methodSignature">protected byte[] <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.185">getRememberedSerializedIdentity</a>​(<a href="../../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</pre> |
| <div class="block">Returns a previously serialized identity byte array or <code>null</code> if the byte array could not be acquired. |
| This implementation retrieves an HTTP cookie, Base64-decodes the cookie value, and returns the resulting byte |
| array. |
| <p/> |
| The <code>SubjectContext</code> instance is expected to be a <a href="../subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><code>WebSubjectContext</code></a> instance with an HTTP |
| Request/Response pair so an HTTP cookie can be retrieved from the incoming request. If it is not a |
| <code>WebSubjectContext</code> or that <code>WebSubjectContext</code> does not have an HTTP Request/Response pair, this |
| implementation returns <code>null</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../mgt/AbstractRememberMeManager.html#getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)">getRememberedSerializedIdentity</a></code> in class <code><a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subjectContext</code> - the contextual data, usually provided by a <a href="../../subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><code>Subject.Builder</code></a> implementation, that |
| is being used to construct a <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance. To be used to assist with data |
| lookup.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a previously serialized identity byte array or <code>null</code> if the byte array could not be acquired.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forgetIdentity(org.apache.shiro.subject.Subject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forgetIdentity</h4> |
| <pre class="methodSignature">protected void <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.268">forgetIdentity</a>​(<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> subject)</pre> |
| <div class="block">Removes the 'rememberMe' cookie from the associated <a href="../subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a>'s request/response pair. |
| <p/> |
| The <code>subject</code> instance is expected to be a <a href="../subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> instance with an HTTP Request/Response pair. |
| If it is not a <code>WebSubject</code> or that <code>WebSubject</code> does not have an HTTP Request/Response pair, this |
| implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../mgt/AbstractRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.Subject)">forgetIdentity</a></code> in class <code><a href="../../mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - the subject instance for which identity data should be forgotten from the underlying persistence</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="forgetIdentity(org.apache.shiro.subject.SubjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>forgetIdentity</h4> |
| <pre class="methodSignature">public void <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.285">forgetIdentity</a>​(<a href="../../subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> subjectContext)</pre> |
| <div class="block">Removes the 'rememberMe' cookie from the associated <a href="../subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><code>WebSubjectContext</code></a>'s request/response pair. |
| <p/> |
| The <code>SubjectContext</code> instance is expected to be a <a href="../subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><code>WebSubjectContext</code></a> instance with an HTTP |
| Request/Response pair. If it is not a <code>WebSubjectContext</code> or that <code>WebSubjectContext</code> does not |
| have an HTTP Request/Response pair, this implementation does nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subjectContext</code> - the contextual data, usually provided by a <a href="../../subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><code>Subject.Builder</code></a> implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CookieRememberMeManager.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
