Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / org / apache / shiro / web / mgt / CookieRememberMeManager.html
blob: 9bdb307318bd7d97672db510c543afb89f93b151 [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>
<!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:27 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CookieRememberMeManager (Apache Shiro 1.2.1 API)</title>
<meta name="date" content="2013-05-30">
<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="CookieRememberMeManager (Apache Shiro 1.2.1 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/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">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/shiro/web/mgt/DefaultWebSecurityManager.html" title="class in org.apache.shiro.web.mgt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/web/mgt/CookieRememberMeManager.html" target="_top">Frames</a></li>
<li><a href="CookieRememberMeManager.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.shiro.web.mgt</div>
<h2 title="Class CookieRememberMeManager" class="title">Class CookieRememberMeManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/shiro/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><a href="../../../../../org/apache/shiro/mgt/RememberMeManager.html" title="interface in org.apache.shiro.mgt">RememberMeManager</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.71">CookieRememberMeManager</a>
extends <a href="../../../../../org/apache/shiro/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="../../../../../org/apache/shiro/subject/Subject.html#getPrincipals()"><code>principals</code></a> to a <a href="../../../../../org/apache/shiro/web/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="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#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="../../../../../org/apache/shiro/web/servlet/Cookie.html#getName()"><code>name</code></a></td>
<td><code>rememberMe</code></td>
</tr>
<tr>
<td><a href="../../../../../org/apache/shiro/web/servlet/Cookie.html#getPath()"><code>path</code></a></td>
<td><code>/</code></td>
</tr>
<tr>
<td><a href="../../../../../org/apache/shiro/web/servlet/Cookie.html#getMaxAge()"><code>maxAge</code></a></td>
<td><a href="../../../../../org/apache/shiro/web/servlet/Cookie.html#ONE_YEAR"><code>Cookie.ONE_YEAR</code></a></td>
</tr>
</table>
<p/>
Note that because this class subclasses the <a href="../../../../../org/apache/shiro/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="strong">Since:</span></dt>
<dd>1.0</dd></dl>
</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://java.sun.com/javase/6/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/shiro/web/mgt/CookieRememberMeManager.html#DEFAULT_REMEMBER_ME_COOKIE_NAME">DEFAULT_REMEMBER_ME_COOKIE_NAME</a></strong></code>
<div class="block">The default name of the underlying rememberMe cookie which is <code>rememberMe</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#CookieRememberMeManager()">CookieRememberMeManager</a></strong>()</code>
<div class="block">Constructs a new <code>CookieRememberMeManager</code> with a default <code>rememberMe</code> cookie template.</div>
</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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.Subject)">forgetIdentity</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject)</code>
<div class="block">Removes the 'rememberMe' cookie from the associated <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a>'s request/response pair.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.SubjectContext)">forgetIdentity</a></strong>(<a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a>&nbsp;subjectContext)</code>
<div class="block">Removes the 'rememberMe' cookie from the associated <a href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><code>WebSubjectContext</code></a>'s request/response pair.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#getCookie()">getCookie</a></strong>()</code>
<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 class="rowColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)">getRememberedSerializedIdentity</a></strong>(<a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a>&nbsp;subjectContext)</code>
<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 class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#rememberSerializedIdentity(org.apache.shiro.subject.Subject, byte[])">rememberSerializedIdentity</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
byte[]&nbsp;serialized)</code>
<div class="block">Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/mgt/CookieRememberMeManager.html#setCookie(org.apache.shiro.web.servlet.Cookie)">setCookie</a></strong>(<a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a>&nbsp;cookie)</code>
<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 name="methods_inherited_from_class_org.apache.shiro.mgt.AbstractRememberMeManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.mgt.<a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></h3>
<code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#convertBytesToPrincipals(byte[], org.apache.shiro.subject.SubjectContext)">convertBytesToPrincipals</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#convertPrincipalsToBytes(org.apache.shiro.subject.PrincipalCollection)">convertPrincipalsToBytes</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#decrypt(byte[])">decrypt</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#deserialize(byte[])">deserialize</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#encrypt(byte[])">encrypt</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getCipherKey()">getCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getCipherService()">getCipherService</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getDecryptionCipherKey()">getDecryptionCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getEncryptionCipherKey()">getEncryptionCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getIdentityToRemember(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationInfo)">getIdentityToRemember</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getRememberedPrincipals(org.apache.shiro.subject.SubjectContext)">getRememberedPrincipals</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getSerializer()">getSerializer</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#isRememberMe(org.apache.shiro.authc.AuthenticationToken)">isRememberMe</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onFailedLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationException)">onFailedLogin</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onLogout(org.apache.shiro.subject.Subject)">onLogout</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onRememberedPrincipalFailure(java.lang.RuntimeException, org.apache.shiro.subject.SubjectContext)">onRememberedPrincipalFailure</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#onSuccessfulLogin(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">onSuccessfulLogin</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.authc.AuthenticationToken, org.apache.shiro.authc.AuthenticationInfo)">rememberIdentity</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#rememberIdentity(org.apache.shiro.subject.Subject, org.apache.shiro.subject.PrincipalCollection)">rememberIdentity</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#serialize(org.apache.shiro.subject.PrincipalCollection)">serialize</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#setCipherKey(byte[])">setCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#setCipherService(org.apache.shiro.crypto.CipherService)">setCipherService</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#setDecryptionCipherKey(byte[])">setDecryptionCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#setEncryptionCipherKey(byte[])">setEncryptionCipherKey</a>, <a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#setSerializer(org.apache.shiro.io.Serializer)">setSerializer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</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="DEFAULT_REMEMBER_ME_COOKIE_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_REMEMBER_ME_COOKIE_NAME</h4>
<pre>public static final&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">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>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CookieRememberMeManager()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CookieRememberMeManager</h4>
<pre>public&nbsp;<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>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCookie()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCookie</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a>&nbsp;<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="../../../../../org/apache/shiro/web/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="strong">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 name="setCookie(org.apache.shiro.web.servlet.Cookie)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCookie</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.121">setCookie</a>(<a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a>&nbsp;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="../../../../../org/apache/shiro/web/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="strong">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 name="rememberSerializedIdentity(org.apache.shiro.subject.Subject, byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rememberSerializedIdentity</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.135">rememberSerializedIdentity</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
byte[]&nbsp;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="../../../../../org/apache/shiro/web/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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#rememberSerializedIdentity(org.apache.shiro.subject.Subject, byte[])">rememberSerializedIdentity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd>
<dt><span class="strong">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 name="getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRememberedSerializedIdentity</h4>
<pre>protected&nbsp;byte[]&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.185">getRememberedSerializedIdentity</a>(<a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a>&nbsp;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="../../../../../org/apache/shiro/web/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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#getRememberedSerializedIdentity(org.apache.shiro.subject.SubjectContext)">getRememberedSerializedIdentity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>subjectContext</code> - the contextual data, usually provided by a <code>Subject.Builder</code> implementation, that
is being used to construct a <a href="../../../../../org/apache/shiro/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="strong">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 name="forgetIdentity(org.apache.shiro.subject.Subject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forgetIdentity</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.256">forgetIdentity</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject)</pre>
<div class="block">Removes the 'rememberMe' cookie from the associated <a href="../../../../../org/apache/shiro/web/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="../../../../../org/apache/shiro/web/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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html#forgetIdentity(org.apache.shiro.subject.Subject)">forgetIdentity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/shiro/mgt/AbstractRememberMeManager.html" title="class in org.apache.shiro.mgt">AbstractRememberMeManager</a></code></dd>
<dt><span class="strong">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 name="forgetIdentity(org.apache.shiro.subject.SubjectContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>forgetIdentity</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/mgt/CookieRememberMeManager.html#line.273">forgetIdentity</a>(<a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a>&nbsp;subjectContext)</pre>
<div class="block">Removes the 'rememberMe' cookie from the associated <a href="../../../../../org/apache/shiro/web/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="../../../../../org/apache/shiro/web/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="strong">Parameters:</span></dt><dd><code>subjectContext</code> - the contextual data, usually provided by a <code>Subject.Builder</code> implementation</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/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">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/shiro/web/mgt/DefaultWebSecurityManager.html" title="class in org.apache.shiro.web.mgt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/web/mgt/CookieRememberMeManager.html" target="_top">Frames</a></li>
<li><a href="CookieRememberMeManager.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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 &#169; 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>