| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:26 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>NativeSessionManager (Apache Shiro 1.2.1 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NativeSessionManager (Apache Shiro 1.2.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NativeSessionManager.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/ImmutableProxiedSession.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/session/mgt/NativeSessionManager.html" target="_top">Frames</a></li> |
| <li><a href="NativeSessionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.session.mgt</div> |
| <h2 title="Interface NativeSessionManager" class="title">Interface NativeSessionManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractValidatingSessionManager</a>, <a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionManager.html" title="class in org.apache.shiro.session.mgt">DefaultSessionManager</a>, <a href="../../../../../org/apache/shiro/web/session/mgt/DefaultWebSessionManager.html" title="class in org.apache.shiro.web.session.mgt">DefaultWebSessionManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.30">NativeSessionManager</a> |
| extends <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></pre> |
| <div class="block">A <code>Native</code> session manager is one that manages sessions natively - that is, it is directly responsible |
| for the creation, persistence and removal of <a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> instances and their |
| lifecycles.</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"> |
| <!-- ========== 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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#checkValid(org.apache.shiro.session.mgt.SessionKey)">checkValid</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns quietly if the associated session is valid (it exists and is not stopped or expired) or throws |
| an <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session"><code>InvalidSessionException</code></a> indicating that the session id is invalid.</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/session/mgt/NativeSessionManager.html#getAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)">getAttribute</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey)</code> |
| <div class="block">Returns the object bound to the associated session identified by the specified attribute key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/session/mgt/NativeSessionManager.html#getAttributeKeys(org.apache.shiro.session.mgt.SessionKey)">getAttributeKeys</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey)</code> |
| <div class="block">Returns all attribute keys maintained by the target session or an empty collection if there are no attributes.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#getHost(org.apache.shiro.session.mgt.SessionKey)">getHost</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns the host name or IP string of the host where the session was started, if known.</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/session/mgt/NativeSessionManager.html#getLastAccessTime(org.apache.shiro.session.mgt.SessionKey)">getLastAccessTime</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns the time the associated <code>Session</code> last interacted with the system.</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/session/mgt/NativeSessionManager.html#getStartTimestamp(org.apache.shiro.session.mgt.SessionKey)">getStartTimestamp</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns the time the associated <code>Session</code> started (was created).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#getTimeout(org.apache.shiro.session.mgt.SessionKey)">getTimeout</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns the time in milliseconds that the associated session may remain idle before expiring.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#isValid(org.apache.shiro.session.mgt.SessionKey)">isValid</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Returns <code>true</code> if the associated session is valid (it exists and is not stopped nor expired), |
| <code>false</code> otherwise.</div> |
| </td> |
| </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/session/mgt/NativeSessionManager.html#removeAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)">removeAttribute</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey)</code> |
| <div class="block">Removes (unbinds) the object bound to associated <code>Session</code> under the given <code>attributeKey</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#setAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object, java.lang.Object)">setAttribute</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey, |
| <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 the associated session uniquely identified by the <code>attributeKey</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#setTimeout(org.apache.shiro.session.mgt.SessionKey, long)">setTimeout</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key, |
| long maxIdleTimeInMillis)</code> |
| <div class="block">Sets the time in milliseconds that the associated 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/session/mgt/NativeSessionManager.html#stop(org.apache.shiro.session.mgt.SessionKey)">stop</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Explicitly stops the associated session, thereby releasing all of its resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#touch(org.apache.shiro.session.mgt.SessionKey)">touch</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Updates the last accessed time of the session identified by <code>sessionId</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.session.mgt.SessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.session.mgt.<a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></h3> |
| <code><a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getStartTimestamp(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartTimestamp</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.39">getStartTimestamp</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| <div class="block">Returns the time the associated <code>Session</code> started (was created).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the time the specified <code>Session</code> started (was created).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#getStartTimestamp()"><code>Session.getStartTimestamp()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getLastAccessTime(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastAccessTime</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.49">getLastAccessTime</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| <div class="block">Returns the time the associated <code>Session</code> last interacted with the system.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>time the session last accessed the system</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#getLastAccessTime()"><code>Session.getLastAccessTime()</code></a>, |
| <a href="../../../../../org/apache/shiro/session/Session.html#touch()"><code>Session.touch()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isValid(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.58">isValid</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| <div class="block">Returns <code>true</code> if the associated session is valid (it exists and is not stopped nor expired), |
| <code>false</code> otherwise.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the session is valid (exists and is not stopped or expired), <code>false</code> otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="checkValid(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkValid</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.70">checkValid</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Returns quietly if the associated session is valid (it exists and is not stopped or expired) or throws |
| an <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session"><code>InvalidSessionException</code></a> indicating that the session id is invalid. This |
| might be preferred to be used instead of <a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#isValid(org.apache.shiro.session.mgt.SessionKey)"><code>isValid(org.apache.shiro.session.mgt.SessionKey)</code></a> since any exception thrown will definitively explain |
| the reason for invalidation.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target 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 the session id is invalid (it does not exist or it is stopped or expired).</dd></dl> |
| </li> |
| </ul> |
| <a name="getTimeout(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre>long <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.85">getTimeout</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Returns the time in milliseconds that the associated 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></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the time in milliseconds that the associated 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(org.apache.shiro.session.mgt.SessionKey, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.100">setTimeout</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key, |
| long maxIdleTimeInMillis) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Sets the time in milliseconds that the associated 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></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd><dd><code>maxIdleTimeInMillis</code> - the time in milliseconds that the associated 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="touch(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>touch</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.111">touch</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Updates the last accessed time of the session identified by <code>sessionId</code>. This |
| can be used to explicitly ensure that a session does not time out.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target 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 the session has been stopped or expired prior to calling this method.</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="getHost(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.121">getHost</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| <div class="block">Returns the host name or IP string of the host where the session was started, if known. If |
| no host name or IP was specified when starting the session, this method returns <code>null</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the host name or ip address of the host where the session originated, if known. If unknown, |
| this method returns <code>null</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="stop(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.130">stop</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Explicitly stops the associated session, thereby releasing all of its resources.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target 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 the session has stopped or expired prior to calling this method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#stop()"><code>Session.stop()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getAttributeKeys(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeKeys</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.140">getAttributeKeys</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey)</pre> |
| <div class="block">Returns all attribute keys maintained by the target session or an empty collection if there are no attributes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionKey</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>all attribute keys maintained by the target session or an empty collection if there are no 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 the associated session has stopped or expired prior to calling this method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#getAttributeKeys()"><code>Session.getAttributeKeys()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.152">getAttribute</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Returns the object bound to the associated session identified by the specified attribute key. If there |
| is no object bound under the attribute key for the given session, <code>null</code> is returned.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionKey</code> - session key to use to look up the target session.</dd><dd><code>attributeKey</code> - the unique name of the object bound to the associated session</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the object bound under the <code>attributeKey</code> or <code>null</code> if there is no object bound.</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 specified session has stopped or expired prior to calling this method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#getAttribute(java.lang.Object)"><code>Session.getAttribute(Object key)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.168">setAttribute</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey, |
| <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">Binds the specified <code>value</code> to the associated session uniquely identified by the <code>attributeKey</code>. |
| If there is already a session attribute bound under the <code>attributeKey</code>, 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 the |
| <a href="../../../../../org/apache/shiro/session/mgt/NativeSessionManager.html#removeAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)"><code>removeAttribute(SessionKey sessionKey, Object attributeKey)</code></a> method was called.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionKey</code> - the session key to use to look up the target session.</dd><dd><code>attributeKey</code> - the key 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 the specified session has stopped or expired prior to calling this method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#setAttribute(java.lang.Object, java.lang.Object)"><code>Session.setAttribute(Object key, Object value)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="removeAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre><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/session/mgt/NativeSessionManager.html#line.179">removeAttribute</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <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> attributeKey) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <div class="block">Removes (unbinds) the object bound to associated <code>Session</code> under the given <code>attributeKey</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionKey</code> - session key to use to look up the target session.</dd><dd><code>attributeKey</code> - the key 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 specified <code>attributeKey</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 the specified session has stopped or expired prior to calling this method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/Session.html#removeAttribute(java.lang.Object)"><code>Session.removeAttribute(Object key)</code></a></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/NativeSessionManager.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/ImmutableProxiedSession.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/session/mgt/NativeSessionManager.html" target="_top">Frames</a></li> |
| <li><a href="NativeSessionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <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> |
| |