blob: 51a1409b7192ef9594a4e4f81bf51c588df4b772 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>org.eclipse.jetty.server.session (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<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.eclipse.jetty.server.session (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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.eclipse.jetty.server.session</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Server : Session Management Implementations</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="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a></th>
<td class="colLast">
<div class="block">SessionCache
A working set of <a href="Session.html" title="class in org.eclipse.jetty.server.session"><code>Session</code></a> objects for a context.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionCacheFactory.html" title="interface in org.eclipse.jetty.server.session">SessionCacheFactory</a></th>
<td class="colLast">
<div class="block">SessionCacheFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionDataMap.html" title="interface in org.eclipse.jetty.server.session">SessionDataMap</a></th>
<td class="colLast">
<div class="block">SessionDataMap
A map style access to SessionData keyed by the session id.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionDataMapFactory.html" title="interface in org.eclipse.jetty.server.session">SessionDataMapFactory</a></th>
<td class="colLast">
<div class="block">SessionDataMapFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionDataStore.html" title="interface in org.eclipse.jetty.server.session">SessionDataStore</a></th>
<td class="colLast">
<div class="block">SessionDataStore
A store for the data contained in a Session object.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionDataStoreFactory.html" title="interface in org.eclipse.jetty.server.session">SessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">SessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionHandler.SessionIf.html" title="interface in org.eclipse.jetty.server.session">SessionHandler.SessionIf</a></th>
<td class="colLast">
<div class="block">SessionIf
Interface that any session wrapper should implement so that
SessionManager may access the Jetty session implementation.</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="AbstractSessionCache.html" title="class in org.eclipse.jetty.server.session">AbstractSessionCache</a></th>
<td class="colLast">
<div class="block">AbstractSessionCache
A base implementation of the <a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session"><code>SessionCache</code></a> interface for managing a set of
Session objects pertaining to a context in memory.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractSessionCacheFactory.html" title="class in org.eclipse.jetty.server.session">AbstractSessionCacheFactory</a></th>
<td class="colLast">
<div class="block">AbstractSessionCacheFactory
Base class for SessionCacheFactories.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractSessionDataStore.html" title="class in org.eclipse.jetty.server.session">AbstractSessionDataStore</a></th>
<td class="colLast">
<div class="block">AbstractSessionDataStore</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractSessionDataStoreFactory.html" title="class in org.eclipse.jetty.server.session">AbstractSessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">AbstractSessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CachingSessionDataStore.html" title="class in org.eclipse.jetty.server.session">CachingSessionDataStore</a></th>
<td class="colLast">
<div class="block">CachingSessionDataStore
A SessionDataStore is a mechanism for (persistently) storing data associated with sessions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CachingSessionDataStoreFactory.html" title="class in org.eclipse.jetty.server.session">CachingSessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">CachingSessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DatabaseAdaptor.html" title="class in org.eclipse.jetty.server.session">DatabaseAdaptor</a></th>
<td class="colLast">
<div class="block">DatabaseAdaptor
Handles differences between databases.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultSessionCache.html" title="class in org.eclipse.jetty.server.session">DefaultSessionCache</a></th>
<td class="colLast">
<div class="block">DefaultSessionCache
A session store that keeps its sessions in memory in a hashmap</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultSessionCacheFactory.html" title="class in org.eclipse.jetty.server.session">DefaultSessionCacheFactory</a></th>
<td class="colLast">
<div class="block">DefaultSessionCacheFactory
Factory for creating new DefaultSessionCaches.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultSessionIdManager.html" title="class in org.eclipse.jetty.server.session">DefaultSessionIdManager</a></th>
<td class="colLast">
<div class="block">DefaultSessionIdManager
Manages session ids to ensure each session id within a context is unique, and that
session ids can be shared across contexts (but not session contents).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileSessionDataStore.html" title="class in org.eclipse.jetty.server.session">FileSessionDataStore</a></th>
<td class="colLast">
<div class="block">FileSessionDataStore
A file-based store of session data.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileSessionDataStoreFactory.html" title="class in org.eclipse.jetty.server.session">FileSessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">FileSessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a></th>
<td class="colLast">
<div class="block">HouseKeeper
There is 1 session HouseKeeper per SessionIdManager instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JDBCSessionDataStore.html" title="class in org.eclipse.jetty.server.session">JDBCSessionDataStore</a></th>
<td class="colLast">
<div class="block">JDBCSessionDataStore
Session data stored in database</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="JDBCSessionDataStore.SessionTableSchema.html" title="class in org.eclipse.jetty.server.session">JDBCSessionDataStore.SessionTableSchema</a></th>
<td class="colLast">
<div class="block">SessionTableSchema</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JDBCSessionDataStoreFactory.html" title="class in org.eclipse.jetty.server.session">JDBCSessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">JDBCSessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NullSessionCache.html" title="class in org.eclipse.jetty.server.session">NullSessionCache</a></th>
<td class="colLast">
<div class="block">NullSessionCache
Does not actually cache any Session objects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NullSessionCacheFactory.html" title="class in org.eclipse.jetty.server.session">NullSessionCacheFactory</a></th>
<td class="colLast">
<div class="block">NullSessionCacheFactory
Factory for NullSessionCaches.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NullSessionDataStore.html" title="class in org.eclipse.jetty.server.session">NullSessionDataStore</a></th>
<td class="colLast">
<div class="block">NullSessionDataStore
Does not actually store anything, useful for testing.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NullSessionDataStoreFactory.html" title="class in org.eclipse.jetty.server.session">NullSessionDataStoreFactory</a></th>
<td class="colLast">
<div class="block">NullSessionDataStoreFactory</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a></th>
<td class="colLast">
<div class="block">Session
A heavy-weight Session object representing an HttpSession.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionContext.html" title="class in org.eclipse.jetty.server.session">SessionContext</a></th>
<td class="colLast">
<div class="block">SessionContext
Information about the context to which sessions belong: the Context,
the SessionHandler of the context, and the unique name of the node.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a></th>
<td class="colLast">
<div class="block">SessionData
The data associated with a session.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a></th>
<td class="colLast">
<div class="block">SessionHandler.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Session.IdState.html" title="enum in org.eclipse.jetty.server.session">Session.IdState</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Session.State.html" title="enum in org.eclipse.jetty.server.session">Session.State</a></th>
<td class="colLast">
<div class="block">State
Validity states of a session</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="UnreadableSessionDataException.html" title="class in org.eclipse.jetty.server.session">UnreadableSessionDataException</a></th>
<td class="colLast">
<div class="block">UnreadableSessionDataException</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UnwriteableSessionDataException.html" title="class in org.eclipse.jetty.server.session">UnwriteableSessionDataException</a></th>
<td class="colLast">
<div class="block">UnwriteableSessionDataException</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; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>