blob: ce293823345d2da614825ea509f41745ecf78627 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.shiro.session.mgt (Apache Shiro :: Core 1.10.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.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.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.shiro.session.mgt (Apache Shiro :: Core 1.10.0 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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&nbsp;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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.shiro.session.mgt</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block"><a href="SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> components supporting enterprise session management.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NativeSessionManager.html" title="interface in org.apache.shiro.session.mgt">NativeSessionManager</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a></th>
<td class="colLast">
<div class="block">A <code>SessionContext</code> is a 'bucket' of data presented to a <a href="SessionFactory.html" title="interface in org.apache.shiro.session.mgt"><code>SessionFactory</code></a> which interprets
this data to construct <a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> instances.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionFactory.html" title="interface in org.apache.shiro.session.mgt">SessionFactory</a></th>
<td class="colLast">
<div class="block">A simple factory class that instantiates concrete <a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a></th>
<td class="colLast">
<div class="block">A <code>SessionKey</code> is a key that allows look-up of any particular <a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a>
instance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></th>
<td class="colLast">
<div class="block">A SessionManager manages the creation, maintenance, and clean-up of all application
<a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></th>
<td class="colLast">
<div class="block">Interface that should be implemented by classes that can control validating sessions on a regular
basis.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ValidatingSession.html" title="interface in org.apache.shiro.session.mgt">ValidatingSession</a></th>
<td class="colLast">
<div class="block">A <code>ValidatingSession</code> is a <code>Session</code> that is capable of determining it is valid or not and
is able to validate itself if necessary.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a></th>
<td class="colLast">
<div class="block">A ValidatingSessionManager is a SessionManager that can proactively validate any or all sessions
that may be expired.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a></th>
<td class="colLast">
<div class="block">Abstract implementation supporting the <a href="NativeSessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>NativeSessionManager</code></a> interface, supporting
<a href="../SessionListener.html" title="interface in org.apache.shiro.session"><code>SessionListener</code></a>s and application of the
<a href="AbstractSessionManager.html#getGlobalSessionTimeout()"><code>globalSessionTimeout</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractSessionManager</a></th>
<td class="colLast">
<div class="block">Base abstract class of the <a href="SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> interface, enabling configuration of an
application-wide <a href="AbstractSessionManager.html#getGlobalSessionTimeout()"><code>globalSessionTimeout</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractValidatingSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractValidatingSessionManager</a></th>
<td class="colLast">
<div class="block">Default business-tier implementation of the <a href="ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>ValidatingSessionManager</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultSessionContext.html" title="class in org.apache.shiro.session.mgt">DefaultSessionContext</a></th>
<td class="colLast">
<div class="block">Default implementation of the <a href="SessionContext.html" title="interface in org.apache.shiro.session.mgt"><code>SessionContext</code></a> interface which provides getters and setters that
wrap interaction with the underlying backing context map.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultSessionKey.html" title="class in org.apache.shiro.session.mgt">DefaultSessionKey</a></th>
<td class="colLast">
<div class="block">Default implementation of the <a href="SessionKey.html" title="interface in org.apache.shiro.session.mgt"><code>SessionKey</code></a> interface, which allows setting and retrieval of a concrete
<a href="DefaultSessionKey.html#getSessionId()"><code>sessionId</code></a> that the <code>SessionManager</code> implementation can use to look up a
<code>Session</code> instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultSessionManager.html" title="class in org.apache.shiro.session.mgt">DefaultSessionManager</a></th>
<td class="colLast">
<div class="block">Default business-tier implementation of a <a href="ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>ValidatingSessionManager</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DelegatingSession.html" title="class in org.apache.shiro.session.mgt">DelegatingSession</a></th>
<td class="colLast">
<div class="block">A DelegatingSession is a client-tier representation of a server side
<a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ExecutorServiceSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt">ExecutorServiceSessionValidationScheduler</a></th>
<td class="colLast">
<div class="block">SessionValidationScheduler implementation that uses a
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ScheduledExecutorService</code></a> to call <a href="ValidatingSessionManager.html#validateSessions()"><code>ValidatingSessionManager.validateSessions()</code></a> every
<em><a href="ExecutorServiceSessionValidationScheduler.html#getInterval()"><code>interval</code></a></em> milliseconds.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ImmutableProxiedSession.html" title="class in org.apache.shiro.session.mgt">ImmutableProxiedSession</a></th>
<td class="colLast">
<div class="block">Implementation of the <a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> interface that proxies another <code>Session</code>, but does not
allow any 'write' operations to the underlying session.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SimpleSession.html" title="class in org.apache.shiro.session.mgt">SimpleSession</a></th>
<td class="colLast">
<div class="block">Simple <a href="../Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> JavaBeans-compatible POJO implementation, intended to be used on the
business/server tier.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SimpleSessionFactory.html" title="class in org.apache.shiro.session.mgt">SimpleSessionFactory</a></th>
<td class="colLast">
<div class="block"><code>SessionFactory</code> implementation that generates <a href="SimpleSession.html" title="class in org.apache.shiro.session.mgt"><code>SimpleSession</code></a> instances.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>