| <!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 15:02:20 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>HttpServletSession (Apache Shiro 1.2.2 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="HttpServletSession (Apache Shiro 1.2.2 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/HttpServletSession.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>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/session/HttpServletSession.html" target="_top">Frames</a></li> |
| <li><a href="HttpServletSession.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.session</div> |
| <h2 title="Class HttpServletSession" class="title">Class HttpServletSession</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.web.session.HttpServletSession</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/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/web/session/HttpServletSession.html#line.41">HttpServletSession</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/Session.html" title="interface in org.apache.shiro.session">Session</a></pre> |
| <div class="block"><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> implementation that is backed entirely by a standard servlet container |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpSession</code></a> instance. It does not interact with any of Shiro's session-related components |
| <code>SessionManager</code>, <code>SecurityManager</code>, etc, and instead satisfies all method implementations by interacting |
| with a servlet container provided <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpSession</code></a> instance.</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"> |
| <!-- ======== 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"> </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/session/HttpServletSession.html#HttpServletSession(javax.servlet.http.HttpSession, java.lang.String)">HttpServletSession</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a> httpSession, |
| <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> host)</code> </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"> </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><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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getAttribute(java.lang.Object)">getAttribute</a></strong>(<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> key)</code> |
| <div class="block">Returns the object bound to this session identified by the specified key.</div> |
| </td> |
| </tr> |
| <tr 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><<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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getAttributeKeys()">getAttributeKeys</a></strong>()</code> |
| <div class="block">Returns the keys of all the attributes stored under this session.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getHost()">getHost</a></strong>()</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 class="rowColor"> |
| <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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getId()">getId</a></strong>()</code> |
| <div class="block">Returns the unique identifier assigned by the system upon session creation.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getLastAccessTime()">getLastAccessTime</a></strong>()</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 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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getStartTimestamp()">getStartTimestamp</a></strong>()</code> |
| <div class="block">Returns the time the session was started; that is, the time the system created the instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#getTimeout()">getTimeout</a></strong>()</code> |
| <div class="block">Returns the time in milliseconds that the session session may remain idle before expiring.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#removeAttribute(java.lang.Object)">removeAttribute</a></strong>(<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> key)</code> |
| <div class="block">Removes (unbinds) the object bound to this session under the specified <code>key</code> name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#setAttribute(java.lang.Object, java.lang.Object)">setAttribute</a></strong>(<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> 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> 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 class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#setHost(java.lang.String)">setHost</a></strong>(<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> host)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#setTimeout(long)">setTimeout</a></strong>(long maxIdleTimeInMillis)</code> |
| <div class="block">Sets the time in milliseconds that the session may remain idle before expiring.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#stop()">stop</a></strong>()</code> |
| <div class="block">Explicitly stops (invalidates) this session and releases all associated resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/session/HttpServletSession.html#touch()">touch</a></strong>()</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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HttpServletSession(javax.servlet.http.HttpSession, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpServletSession</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.48">HttpServletSession</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a> httpSession, |
| <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> 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 <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="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.64">getId</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getId()">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getId()">getId</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The unique identifier assigned to the session upon creation.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStartTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartTimestamp</h4> |
| <pre>public <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> <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.68">getStartTimestamp</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getStartTimestamp()">Session</a></code></strong></div> |
| <div class="block">Returns the time the session was started; that is, the time the system created the instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getStartTimestamp()">getStartTimestamp</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The time the system created the session.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLastAccessTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastAccessTime</h4> |
| <pre>public <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> <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.72">getLastAccessTime</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime()">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime()">getLastAccessTime</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The time the user last interacted with the system.</dd><dt><span class="strong">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="getTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre>public long <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.76">getTimeout</a>() |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getTimeout()">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getTimeout()">getTimeout</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the time in milliseconds the session may remain idle before expiring.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code> - if the session has been stopped or expired prior to calling this method.</dd></dl> |
| </li> |
| </ul> |
| <a name="setTimeout(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.84">setTimeout</a>(long maxIdleTimeInMillis) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#setTimeout(long)">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#setTimeout(long)">setTimeout</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>maxIdleTimeInMillis</code> - the time in milliseconds that the session may remain idle before expiring.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code> - if the session has been stopped or expired prior to calling this method.</dd></dl> |
| </li> |
| </ul> |
| <a name="setHost(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHost</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.93">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> host)</pre> |
| </li> |
| </ul> |
| <a name="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre>public <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/session/HttpServletSession.html#line.97">getHost</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getHost()">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getHost()">getHost</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">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="touch()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>touch</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.101">touch</a>() |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#touch()">Session</a></code></strong></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 "using" 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 "maintenance" 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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#touch()">touch</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">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="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.111">stop</a>() |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#stop()">Session</a></code></strong></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 "unauthenticating" 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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#stop()">stop</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">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="getAttributeKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeKeys</h4> |
| <pre>public <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><<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="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.119">getAttributeKeys</a>() |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getAttributeKeys()">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getAttributeKeys()">getAttributeKeys</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">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="strong">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 <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="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.144">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> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#getAttribute(java.lang.Object)">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#getAttribute(java.lang.Object)">getAttribute</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the unique name of the object bound to this session</dd> |
| <dt><span class="strong">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> |
| <dt><span class="strong">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="setAttribute(java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.152">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> 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> value) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#setAttribute(java.lang.Object, java.lang.Object)">Session</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#setAttribute(java.lang.Object, java.lang.Object)">setAttribute</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">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> |
| <dt><span class="strong">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="removeAttribute(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre>public <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="../../../../../src-html/org/apache/shiro/web/session/HttpServletSession.html#line.160">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> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute(java.lang.Object)">Session</a></code></strong></div> |
| <div class="block">Removes (unbinds) the object bound to this session under the specified <code>key</code> name.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute(java.lang.Object)">removeAttribute</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the name uniquely identifying the object to remove</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the object removed or <code>null</code> if there was no object bound under the name |
| <code>key</code>.</dd> |
| <dt><span class="strong">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> |
| </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/HttpServletSession.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>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/session/HttpServletSession.html" target="_top">Frames</a></li> |
| <li><a href="HttpServletSession.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |