blob: 136be116eab211cc10a83dcba0f730f3d4de48c3 [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 (1.8.0_92) on Mon Jul 25 12:22:03 EDT 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleSession (Apache Shiro 1.3.0 API)</title>
<meta name="date" content="2016-07-25">
<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="SimpleSession (Apache Shiro 1.3.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":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";
</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="class-use/SimpleSession.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/shiro/session/mgt/SimpleSessionFactory.html" title="class in org.apache.shiro.session.mgt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/session/mgt/SimpleSession.html" target="_top">Frames</a></li>
<li><a href="SimpleSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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.session.mgt</div>
<h2 title="Class SimpleSession" class="title">Class SimpleSession</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>org.apache.shiro.session.mgt.SimpleSession</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html" title="interface in org.apache.shiro.session.mgt">ValidatingSession</a>, <a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.42">SimpleSession</a>
extends <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>
implements <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html" title="interface in org.apache.shiro.session.mgt">ValidatingSession</a>, <a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">Simple <a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> JavaBeans-compatible POJO implementation, intended to be used on the
business/server tier.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.shiro.session.mgt.SimpleSession">Serialized Form</a></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="memberSummary" 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>protected static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#MILLIS_PER_HOUR">MILLIS_PER_HOUR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#MILLIS_PER_MINUTE">MILLIS_PER_MINUTE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#MILLIS_PER_SECOND">MILLIS_PER_SECOND</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#SimpleSession--">SimpleSession</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#SimpleSession-java.lang.String-">SimpleSession</a></span>(<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>&nbsp;host)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#equals-java.lang.Object-">equals</a></span>(<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>&nbsp;obj)</code>
<div class="block">Returns <code>true</code> if the specified argument is an <code>instanceof</code> <code>SimpleSession</code> and both
<a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getId--"><code>id</code></a>s are equal.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#expire--">expire</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getAttribute-java.lang.Object-">getAttribute</a></span>(<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>&nbsp;key)</code>
<div class="block">Returns the object bound to this session identified by the specified key.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getAttributeKeys--">getAttributeKeys</a></span>()</code>
<div class="block">Returns the keys of all the attributes stored under this session.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getAttributes--">getAttributes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><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><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getHost--">getHost</a></span>()</code>
<div class="block">Returns the host name or IP string of the host that originated this session, or <code>null</code>
if the host is unknown.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getId--">getId</a></span>()</code>
<div class="block">Returns the unique identifier assigned by the system upon session creation.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getLastAccessTime--">getLastAccessTime</a></span>()</code>
<div class="block">Returns the last time the application received a request or method invocation from the user associated
with this session.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getStartTimestamp--">getStartTimestamp</a></span>()</code>
<div class="block">Returns the time the session was started; that is, the time the system created the instance.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getStopTimestamp--">getStopTimestamp</a></span>()</code>
<div class="block">Returns the time the session was stopped, or <tt>null</tt> if the session is still active.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getTimeout--">getTimeout</a></span>()</code>
<div class="block">Returns the time in milliseconds that the session session may remain idle before expiring.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Returns the hashCode.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#isExpired--">isExpired</a></span>()</code>
<div class="block">Returns true if this session has expired, false otherwise.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#isStopped--">isStopped</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#isTimedOut--">isTimedOut</a></span>()</code>
<div class="block">Determines if this session is expired.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#isValid--">isValid</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#onEquals-org.apache.shiro.session.mgt.SimpleSession-">onEquals</a></span>(<a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html" title="class in org.apache.shiro.session.mgt">SimpleSession</a>&nbsp;ss)</code>
<div class="block">Provides an attribute-based comparison (no ID comparison) - incurred <em>only</em> when 'this' or the
session object being compared for equality do not have a session id.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#removeAttribute-java.lang.Object-">removeAttribute</a></span>(<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>&nbsp;key)</code>
<div class="block">Removes (unbinds) the object bound to this session under the specified <code>key</code> name.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setAttribute-java.lang.Object-java.lang.Object-">setAttribute</a></span>(<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>&nbsp;key,
<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>&nbsp;value)</code>
<div class="block">Binds the specified <code>value</code> to this session, uniquely identified by the specifed
<code>key</code> name.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setAttributes-java.util.Map-">setAttributes</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;attributes)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setExpired-boolean-">setExpired</a></span>(boolean&nbsp;expired)</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setHost-java.lang.String-">setHost</a></span>(<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>&nbsp;host)</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setId-java.io.Serializable-">setId</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setLastAccessTime-java.util.Date-">setLastAccessTime</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;lastAccessTime)</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setStartTimestamp-java.util.Date-">setStartTimestamp</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startTimestamp)</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setStopTimestamp-java.util.Date-">setStopTimestamp</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;stopTimestamp)</code>&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#setTimeout-long-">setTimeout</a></span>(long&nbsp;timeout)</code>
<div class="block">Sets the time in milliseconds that the session may remain idle before expiring.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#stop--">stop</a></span>()</code>
<div class="block">Explicitly stops (invalidates) this session and releases all associated resources.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><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><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#toString--">toString</a></span>()</code>
<div class="block">Returns the string representation of this SimpleSession, equal to
<code>getClass().getName() + &quot;,id=&quot; + getId()</code>.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#touch--">touch</a></span>()</code>
<div class="block">Explicitly updates the <a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime--"><code>lastAccessTime</code></a> of this session to the current time when
this method is invoked.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#validate--">validate</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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#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#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#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="MILLIS_PER_SECOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MILLIS_PER_SECOND</h4>
<pre>protected static final&nbsp;long <a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.54">MILLIS_PER_SECOND</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.shiro.session.mgt.SimpleSession.MILLIS_PER_SECOND">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MILLIS_PER_MINUTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MILLIS_PER_MINUTE</h4>
<pre>protected static final&nbsp;long <a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.55">MILLIS_PER_MINUTE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.shiro.session.mgt.SimpleSession.MILLIS_PER_MINUTE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MILLIS_PER_HOUR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MILLIS_PER_HOUR</h4>
<pre>protected static final&nbsp;long <a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.56">MILLIS_PER_HOUR</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.shiro.session.mgt.SimpleSession.MILLIS_PER_HOUR">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="SimpleSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SimpleSession</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.95">SimpleSession</a>()</pre>
</li>
</ul>
<a name="SimpleSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleSession</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.101">SimpleSession</a>(<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>&nbsp;host)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.106">getId</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getId--">Session</a></code></span></div>
<div class="block">Returns the unique identifier assigned by the system upon session creation.
<p/>
All return values from this method are expected to have proper <code>toString()</code>,
<code>equals()</code>, and <code>hashCode()</code> implementations. Good candidates for such
an identifier are <a href="http://java.sun.com/javase/6/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang"><code>Integer</code></a>s, and
<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getId--">getId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The unique identifier assigned to the session upon creation.</dd>
</dl>
</li>
</ul>
<a name="setId-java.io.Serializable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.110">setId</a>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;id)</pre>
</li>
</ul>
<a name="getStartTimestamp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTimestamp</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.114">getStartTimestamp</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getStartTimestamp--">Session</a></code></span></div>
<div class="block">Returns the time the session was started; that is, the time the system created the instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getStartTimestamp--">getStartTimestamp</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time the system created the session.</dd>
</dl>
</li>
</ul>
<a name="setStartTimestamp-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartTimestamp</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.118">setStartTimestamp</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startTimestamp)</pre>
</li>
</ul>
<a name="getStopTimestamp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStopTimestamp</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.139">getStopTimestamp</a>()</pre>
<div class="block">Returns the time the session was stopped, or <tt>null</tt> if the session is still active.
<p/>
A session may become stopped under a number of conditions:
<ul>
<li>If the user logs out of the system, their current session is terminated (released).</li>
<li>If the session expires</li>
<li>The application explicitly calls <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#stop--"><code>stop()</code></a></li>
<li>If there is an internal system error and the session state can no longer accurately
reflect the user's behavior, such in the case of a system crash</li>
</ul>
<p/>
Once stopped, a session may no longer be used. It is locked from all further activity.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time the session was stopped, or <tt>null</tt> if the session is still
active.</dd>
</dl>
</li>
</ul>
<a name="setStopTimestamp-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStopTimestamp</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.143">setStopTimestamp</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;stopTimestamp)</pre>
</li>
</ul>
<a name="getLastAccessTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastAccessTime</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.147">getLastAccessTime</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime--">Session</a></code></span></div>
<div class="block">Returns the last time the application received a request or method invocation from the user associated
with this session. Application calls to this method do not affect this access time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime--">getLastAccessTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The time the user last interacted with the system.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/shiro/session/Session.html#touch--"><code>Session.touch()</code></a></dd>
</dl>
</li>
</ul>
<a name="setLastAccessTime-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLastAccessTime</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.151">setLastAccessTime</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;lastAccessTime)</pre>
</li>
</ul>
<a name="isExpired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExpired</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.161">isExpired</a>()</pre>
<div class="block">Returns true if this session has expired, false otherwise. If the session has
expired, no further user interaction with the system may be done under this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this session has expired, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setExpired-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpired</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.165">setExpired</a>(boolean&nbsp;expired)</pre>
</li>
</ul>
<a name="getTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeout</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.169">getTimeout</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getTimeout--">Session</a></code></span></div>
<div class="block">Returns the time in milliseconds that the session session may remain idle before expiring.
<ul>
<li>A negative return value means the session will never expire.</li>
<li>A non-negative return value (0 or greater) means the session expiration will occur if idle for that
length of time.</li>
</ul>
<b>*Note:</b> if you are used to the <code>HttpSession</code>'s <code>getMaxInactiveInterval()</code> method, the scale on
this method is different: Shiro Sessions use millisecond values for timeout whereas
<code>HttpSession.getMaxInactiveInterval</code> uses seconds. Always use millisecond values with Shiro sessions.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getTimeout--">getTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time in milliseconds the session may remain idle before expiring.</dd>
</dl>
</li>
</ul>
<a name="setTimeout-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeout</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.173">setTimeout</a>(long&nbsp;timeout)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#setTimeout-long-">Session</a></code></span></div>
<div class="block">Sets the time in milliseconds that the session may remain idle before expiring.
<ul>
<li>A negative value means the session will never expire.</li>
<li>A non-negative value (0 or greater) means the session expiration will occur if idle for that
length of time.</li>
</ul>
<p/>
<b>*Note:</b> if you are used to the <code>HttpSession</code>'s <code>getMaxInactiveInterval()</code> method, the scale on
this method is different: Shiro Sessions use millisecond values for timeout whereas
<code>HttpSession.getMaxInactiveInterval</code> uses seconds. Always use millisecond values with Shiro sessions.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#setTimeout-long-">setTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the time in milliseconds that the session may remain idle before expiring.</dd>
</dl>
</li>
</ul>
<a name="getHost--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHost</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.177">getHost</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getHost--">Session</a></code></span></div>
<div class="block">Returns the host name or IP string of the host that originated this session, or <code>null</code>
if the host is unknown.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getHost--">getHost</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the host name or IP string of the host that originated this session, or <code>null</code>
if the host address is unknown.</dd>
</dl>
</li>
</ul>
<a name="setHost-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHost</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.181">setHost</a>(<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>&nbsp;host)</pre>
</li>
</ul>
<a name="getAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.185">getAttributes</a>()</pre>
</li>
</ul>
<a name="setAttributes-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttributes</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.189">setAttributes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<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>&gt;&nbsp;attributes)</pre>
</li>
</ul>
<a name="touch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>touch</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.193">touch</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#touch--">Session</a></code></span></div>
<div class="block">Explicitly updates the <a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime--"><code>lastAccessTime</code></a> of this session to the current time when
this method is invoked. This method can be used to ensure a session does not time out.
<p/>
Most programmers won't use this method directly and will instead rely on the last access time to be updated
automatically as a result of an incoming web request or remote procedure call/method invocation.
<p/>
However, this method is particularly useful when supporting rich-client applications such as
Java Web Start appp, Java or Flash applets, etc. Although rare, it is possible in a rich-client
environment that a user continuously interacts with the client-side application without a
server-side method call ever being invoked. If this happens over a long enough period of
time, the user's server-side session could time-out. Again, such cases are rare since most
rich-clients frequently require server-side method invocations.
<p/>
In this example though, the user's session might still be considered valid because
the user is actively &quot;using&quot; the application, just not communicating with the
server. But because no server-side method calls are invoked, there is no way for the server
to know if the user is sitting idle or not, so it must assume so to maintain session
integrity. This <code>touch()</code> method could be invoked by the rich-client application code during those
times to ensure that the next time a server-side method is invoked, the invocation will not
throw an <a href="../../../../../org/apache/shiro/session/ExpiredSessionException.html" title="class in org.apache.shiro.session"><code>ExpiredSessionException</code></a>. In short terms, it could be used periodically
to ensure a session does not time out.
<p/>
How often this rich-client &quot;maintenance&quot; might occur is entirely dependent upon
the application and would be based on variables such as session timeout configuration,
usage characteristics of the client application, network utilization and application server
performance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#touch--">touch</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
</dl>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.197">stop</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#stop--">Session</a></code></span></div>
<div class="block">Explicitly stops (invalidates) this session and releases all associated resources.
<p/>
If this session has already been authenticated (i.e. the <code>Subject</code> that
owns this session has logged-in), calling this method explicitly might have undesired side effects:
<p/>
It is common for a <code>Subject</code> implementation to retain authentication state in the
<code>Session</code>. If the session
is explicitly stopped by application code by calling this method directly, it could clear out any
authentication state that might exist, thereby effectively &quot;unauthenticating&quot; the <code>Subject</code>.
<p/>
As such, you might consider <a href="../../../../../org/apache/shiro/subject/Subject.html#logout--"><code>logging-out</code></a> the 'owning'
<code>Subject</code> instead of manually calling this method, as a log out is expected to stop the
corresponding session automatically, and also allows framework code to execute additional cleanup logic.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#stop--">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
</dl>
</li>
</ul>
<a name="isStopped--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStopped</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.203">isStopped</a>()</pre>
</li>
</ul>
<a name="expire--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expire</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.207">expire</a>()</pre>
</li>
</ul>
<a name="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.215">isValid</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html#isValid--">isValid</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html" title="interface in org.apache.shiro.session.mgt">ValidatingSession</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.9</dd>
</dl>
</li>
</ul>
<a name="isTimedOut--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTimedOut</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.224">isTimedOut</a>()</pre>
<div class="block">Determines if this session is expired.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the specified session has expired, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="validate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.263">validate</a>()
throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html#validate--">validate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSession.html" title="interface in org.apache.shiro.session.mgt">ValidatingSession</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAttributeKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeKeys</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<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>&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.305">getAttributeKeys</a>()
throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getAttributeKeys--">Session</a></code></span></div>
<div class="block">Returns the keys of all the attributes stored under this session. If there are no
attributes, this returns an empty collection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getAttributeKeys--">getAttributeKeys</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keys of all attributes stored under this session, or an empty collection if
there are no session attributes.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code> - if this session has stopped or expired prior to calling this method.</dd>
</dl>
</li>
</ul>
<a name="getAttribute-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.313">getAttribute</a>(<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>&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#getAttribute-java.lang.Object-">Session</a></code></span></div>
<div class="block">Returns the object bound to this session identified by the specified key. If there is no
object bound under the key, <code>null</code> is returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getAttribute-java.lang.Object-">getAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the unique name of the object bound to this session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object bound under the specified <code>key</code> name or <code>null</code> if there is
no object bound under that name.</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.321">setAttribute</a>(<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>&nbsp;key,
<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>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#setAttribute-java.lang.Object-java.lang.Object-">Session</a></code></span></div>
<div class="block">Binds the specified <code>value</code> to this session, uniquely identified by the specifed
<code>key</code> name. If there is already an object bound under the <code>key</code> name, that
existing object will be replaced by the new <code>value</code>.
<p/>
If the <code>value</code> parameter is null, it has the same effect as if
<a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute-java.lang.Object-"><code>removeAttribute</code></a> was called.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#setAttribute-java.lang.Object-java.lang.Object-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the name under which the <code>value</code> object will be bound in this session</dd>
<dd><code>value</code> - the object to bind in this session.</dd>
</dl>
</li>
</ul>
<a name="removeAttribute-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttribute</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.329">removeAttribute</a>(<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>&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute-java.lang.Object-">Session</a></code></span></div>
<div class="block">Removes (unbinds) the object bound to this session under the specified <code>key</code> name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute-java.lang.Object-">removeAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the name uniquely identifying the object to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the object removed or <code>null</code> if there was no object bound under the name
<code>key</code>.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.351">equals</a>(<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>&nbsp;obj)</pre>
<div class="block">Returns <code>true</code> if the specified argument is an <code>instanceof</code> <code>SimpleSession</code> and both
<a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getId--"><code>id</code></a>s are equal. If the argument is a <code>SimpleSession</code> and either 'this' or the argument
does not yet have an ID assigned, the value of <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#onEquals-org.apache.shiro.session.mgt.SimpleSession-"><code>onEquals</code></a> is returned, which
does a necessary attribute-based comparison when IDs are not available.
<p/>
Do your best to ensure <code>SimpleSession</code> instances receive an ID very early in their lifecycle to
avoid the more expensive attributes-based comparison.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the object to compare with this one for equality.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this object is equivalent to the specified argument, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="onEquals-org.apache.shiro.session.mgt.SimpleSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEquals</h4>
<pre>protected&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.377">onEquals</a>(<a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html" title="class in org.apache.shiro.session.mgt">SimpleSession</a>&nbsp;ss)</pre>
<div class="block">Provides an attribute-based comparison (no ID comparison) - incurred <em>only</em> when 'this' or the
session object being compared for equality do not have a session id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ss</code> - the SimpleSession instance to compare for equality.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if all the attributes, except the id, are equal to this object's attributes.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.398">hashCode</a>()</pre>
<div class="block">Returns the hashCode. If the <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html#getId--"><code>id</code></a> is not <code>null</code>, its hashcode is returned immediately.
If it is <code>null</code>, an attributes-based hashCode will be calculated and returned.
<p/>
Do your best to ensure <code>SimpleSession</code> instances receive an ID very early in their lifecycle to
avoid the more expensive attributes-based calculation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object's hashCode</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&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>&nbsp;<a href="../../../../../src-html/org/apache/shiro/session/mgt/SimpleSession.html#line.422">toString</a>()</pre>
<div class="block">Returns the string representation of this SimpleSession, equal to
<code>getClass().getName() + &quot;,id=&quot; + getId()</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string representation of this SimpleSession, equal to
<code>getClass().getName() + &quot;,id=&quot; + getId()</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</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="class-use/SimpleSession.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/shiro/session/mgt/SimpleSessionFactory.html" title="class in org.apache.shiro.session.mgt"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/session/mgt/SimpleSession.html" target="_top">Frames</a></li>
<li><a href="SimpleSession.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>