| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>NativeSessionManager (Apache Shiro 1.12.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NativeSessionManager (Apache Shiro 1.12.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.session.mgt</a></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><code><a href="SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a></code>, <code><a href="AbstractValidatingSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractValidatingSessionManager</a></code>, <code><a href="DefaultSessionManager.html" title="class in org.apache.shiro.session.mgt">DefaultSessionManager</a></code>, <code><a href="../../web/session/mgt/DefaultWebSessionManager.html" title="class in org.apache.shiro.web.session.mgt">DefaultWebSessionManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.30">NativeSessionManager</a> |
| extends <a href="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="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> instances and their |
| lifecycles.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkValid(org.apache.shiro.session.mgt.SessionKey)">checkValid</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns quietly if the associated session is valid (it exists and is not stopped or expired) or throws |
| an <a href="../InvalidSessionException.html" title="class in org.apache.shiro.session"><code>InvalidSessionException</code></a> indicating that the session id is invalid.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object)">getAttribute</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the object bound to the associated session identified by the specified attribute key.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributeKeys(org.apache.shiro.session.mgt.SessionKey)">getAttributeKeys</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey)</code></th> |
| <td class="colLast"> |
| <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 id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHost(org.apache.shiro.session.mgt.SessionKey)">getHost</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the host name or IP string of the host where the session was started, if known.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastAccessTime(org.apache.shiro.session.mgt.SessionKey)">getLastAccessTime</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the time the associated <code>Session</code> last interacted with the system.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTimestamp(org.apache.shiro.session.mgt.SessionKey)">getStartTimestamp</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the time the associated <code>Session</code> started (was created).</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimeout(org.apache.shiro.session.mgt.SessionKey)">getTimeout</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the time in milliseconds that the associated session may remain idle before expiring.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(org.apache.shiro.session.mgt.SessionKey)">isValid</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <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 id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object)">removeAttribute</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes (unbinds) the object bound to associated <code>Session</code> under the given <code>attributeKey</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object,java.lang.Object)">setAttribute</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Binds the specified <code>value</code> to the associated session uniquely identified by the <code>attributeKey</code>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTimeout(org.apache.shiro.session.mgt.SessionKey,long)">setTimeout</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key, |
| long maxIdleTimeInMillis)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the time in milliseconds that the associated session may remain idle before expiring.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop(org.apache.shiro.session.mgt.SessionKey)">stop</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Explicitly stops the associated session, thereby releasing all of its resources.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#touch(org.apache.shiro.session.mgt.SessionKey)">touch</a></span>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code></th> |
| <td class="colLast"> |
| <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 id="methods.inherited.from.class.org.apache.shiro.session.mgt.SessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.session.mgt.<a href="SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></h3> |
| <code><a href="SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="SessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getStartTimestamp(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartTimestamp</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.39">getStartTimestamp</a>​(<a href="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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time the specified <code>Session</code> started (was created).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#getStartTimestamp()"><code>Session.getStartTimestamp()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLastAccessTime(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastAccessTime</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.49">getLastAccessTime</a>​(<a href="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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>time the session last accessed the system</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#getLastAccessTime()"><code>Session.getLastAccessTime()</code></a>, |
| <a href="../Session.html#touch()"><code>Session.touch()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValid(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre class="methodSignature">boolean <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.58">isValid</a>​(<a href="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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">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 id="checkValid(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkValid</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.70">checkValid</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../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="../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="#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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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 id="getTimeout(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre class="methodSignature">long <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.85">getTimeout</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the time in milliseconds that the associated session may remain idle before expiring.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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 id="setTimeout(org.apache.shiro.session.mgt.SessionKey,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.100">setTimeout</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key, |
| long maxIdleTimeInMillis) |
| throws <a href="../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="paramLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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 id="touch(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>touch</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.111">touch</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#touch()"><code>Session.touch()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHost(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.121">getHost</a>​(<a href="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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">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 id="stop(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.130">stop</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../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="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#stop()"><code>Session.stop()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttributeKeys(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeKeys</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.140">getAttributeKeys</a>​(<a href="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="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionKey</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="returnLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#getAttributeKeys()"><code>Session.getAttributeKeys()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.152">getAttribute</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey) |
| throws <a href="../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="paramLabel">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="returnLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#getAttribute(java.lang.Object)"><code>Session.getAttribute(Object key)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.168">setAttribute</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value) |
| throws <a href="../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="#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="paramLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#setAttribute(java.lang.Object,java.lang.Object)"><code>Session.setAttribute(Object key, Object value)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAttribute(org.apache.shiro.session.mgt.SessionKey,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/NativeSessionManager.html#line.179">removeAttribute</a>​(<a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> sessionKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> attributeKey) |
| throws <a href="../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="paramLabel">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="returnLabel">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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../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="seeLabel">See Also:</span></dt> |
| <dd><a href="../Session.html#removeAttribute(java.lang.Object)"><code>Session.removeAttribute(Object key)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |