blob: 0a08d8a8d4698e6a6e25e7ebb5ac5bb0ee265b85 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Fri Oct 01 11:33:56 CDT 2021 -->
<title>Session (Jetty :: Project 9.4.44.v20210927 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-10-01">
<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="Session (Jetty :: Project 9.4.44.v20210927 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":42,"i28":10,"i29":10,"i30":42,"i31":42,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":42,"i44":10,"i45":42,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":42,"i55":10,"i56":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Session.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.server.session</a></div>
<h2 title="Class Session" class="title">Class Session</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.server.session.Session</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.http.HttpSession</code>, <code><a href="SessionHandler.SessionIf.html" title="interface in org.eclipse.jetty.server.session">SessionHandler.SessionIf</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Session</span>
extends java.lang.Object
implements <a href="SessionHandler.SessionIf.html" title="interface in org.eclipse.jetty.server.session">SessionHandler.SessionIf</a></pre>
<div class="block">Session
A heavy-weight Session object representing an HttpSession. Session objects
relating to a context are kept in a <a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session"><code>SessionCache</code></a>. The purpose of the
SessionCache is to keep the working set of Session objects in memory so that
they may be accessed quickly, and facilitate the sharing of a Session object
amongst multiple simultaneous requests referring to the same session id.
The <a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session"><code>SessionHandler</code></a> coordinates the lifecycle of Session objects with
the help of the SessionCache.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session"><code>SessionHandler</code></a>,
<a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server"><code>SessionIdManager</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Session.IdState.html" title="enum in org.eclipse.jetty.server.session">Session.IdState</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Session.SessionInactivityTimer.html" title="class in org.eclipse.jetty.server.session">Session.SessionInactivityTimer</a></span></code></th>
<td class="colLast">
<div class="block">SessionInactivityTimer
Each Session has a timer associated with it that fires whenever it has
been idle (ie not accessed by a request) for a configurable amount of
time, or the Session expires.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Session.State.html" title="enum in org.eclipse.jetty.server.session">Session.State</a></span></code></th>
<td class="colLast">
<div class="block">State
Validity states of a session</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_extendedId">_extendedId</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_handler">_handler</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_idChanged">_idChanged</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../util/thread/Locker.html" title="class in org.eclipse.jetty.util.thread">Locker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_lock">_lock</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_newSession">_newSession</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_requests">_requests</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_resident">_resident</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionData">_sessionData</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="Session.SessionInactivityTimer.html" title="class in org.eclipse.jetty.server.session">Session.SessionInactivityTimer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionInactivityTimer">_sessionInactivityTimer</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="Session.State.html" title="enum in org.eclipse.jetty.server.session">Session.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_state">_state</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.locks.Condition</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_stateChangeCompleted">_stateChangeCompleted</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SESSION_CREATED_SECURE">SESSION_CREATED_SECURE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.server.session.SessionHandler,javax.servlet.http.HttpServletRequest,org.eclipse.jetty.server.session.SessionData)">Session</a></span>&#8203;(<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>&nbsp;handler,
javax.servlet.http.HttpServletRequest&nbsp;request,
<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Create a new session</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.server.session.SessionHandler,org.eclipse.jetty.server.session.SessionData)">Session</a></span>&#8203;(<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>&nbsp;handler,
<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Re-inflate an existing session from some eg persistent store.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#access(long)">access</a></span>&#8203;(long&nbsp;time)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beginInvalidate()">beginInvalidate</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindValue(java.lang.String,java.lang.Object)">bindValue</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Bind value if value implements <code>HttpSessionBindingListener</code> (calls
<code>HttpSessionBindingListener.valueBound(HttpSessionBindingEvent)</code>)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#calculateInactivityTimeout(long)">calculateInactivityTimeout</a></span>&#8203;(long&nbsp;now)</code></th>
<td class="colLast">
<div class="block">Calculate what the session timer setting should be based on:
the time remaining before the session expires
and any idle eviction time configured.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callSessionAttributeListeners(java.lang.String,java.lang.Object,java.lang.Object)">callSessionAttributeListeners</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;newValue,
java.lang.Object&nbsp;oldValue)</code></th>
<td class="colLast">
<div class="block">Call binding and attribute listeners based on the new and old values of
the attribute.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkLocked()">checkLocked</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkValidForRead()">checkValidForRead</a></span>()</code></th>
<td class="colLast">
<div class="block">Chech that the session data can be read.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkValidForWrite()">checkValidForWrite</a></span>()</code></th>
<td class="colLast">
<div class="block">Check that the session can be modified.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete()">complete</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cookieSet()">cookieSet</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#didActivate()">didActivate</a></span>()</code></th>
<td class="colLast">
<div class="block">Call the activation listeners.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doInvalidate()">doInvalidate</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finishInvalidate()">finishInvalidate</a></span>()</code></th>
<td class="colLast">
<div class="block">Call HttpSessionAttributeListeners as part of invalidating a Session.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(java.lang.String)">getAttribute</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.Enumeration&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributeNames()">getAttributeNames</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributes()">getAttributes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContextPath()">getContextPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookieSetTime()">getCookieSetTime</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreationTime()">getCreationTime</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtendedId()">getExtendedId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastAccessedTime()">getLastAccessedTime</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxInactiveInterval()">getMaxInactiveInterval</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNames()">getNames</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequests()">getRequests</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current number of requests that are active in the Session.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>javax.servlet.ServletContext</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletContext()">getServletContext</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>javax.servlet.http.HttpSessionContext</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionContext()">getSessionContext</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>protected <a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionData()">getSessionData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionHandler()">getSessionHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(java.lang.String)">getValue</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueNames()">getValueNames</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">As of Version 2.2, this method is replaced by
<a href="#getAttributeNames()"><code>getAttributeNames()</code></a></div>
</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVHost()">getVHost</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidate()">invalidate</a></span>()</code></th>
<td class="colLast">
<div class="block">Called by users to invalidate a session, or called by the access method
as a request enters the session if the session has expired, or called by
manager as a result of scavenger expiring session</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isChanging()">isChanging</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExpiredAt(long)">isExpiredAt</a></span>&#8203;(long&nbsp;time)</code></th>
<td class="colLast">
<div class="block">Check to see if session has expired as at the time given.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIdChanged()">isIdChanged</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIdleLongerThan(int)">isIdleLongerThan</a></span>&#8203;(int&nbsp;sec)</code></th>
<td class="colLast">
<div class="block">Check if the Session has been idle longer than a number of seconds.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInvalid()">isInvalid</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNew()">isNew</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isResident()">isResident</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid()">isValid</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="../../util/thread/Locker.Lock.html" title="class in org.eclipse.jetty.util.thread">Locker.Lock</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lock()">lock</a></span>()</code></th>
<td class="colLast">
<div class="block">Grab the lock on the session</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putValue(java.lang.String,java.lang.Object)">putValue</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttribute(java.lang.String)">removeAttribute</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeValue(java.lang.String)">removeValue</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renewId(javax.servlet.http.HttpServletRequest)">renewId</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Force a change to the id of a session.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtendedId(java.lang.String)">setExtendedId</a></span>&#8203;(java.lang.String&nbsp;extendedId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdChanged(boolean)">setIdChanged</a></span>&#8203;(boolean&nbsp;changed)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxInactiveInterval(int)">setMaxInactiveInterval</a></span>&#8203;(int&nbsp;secs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResident(boolean)">setResident</a></span>&#8203;(boolean&nbsp;resident)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unbindValue(java.lang.String,java.lang.Object)">unbindValue</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Unbind value if value implements <code>HttpSessionBindingListener</code>
(calls
<code>HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent)</code>)</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateInactivityTimer()">updateInactivityTimer</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#use()">use</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#willPassivate()">willPassivate</a></span>()</code></th>
<td class="colLast">
<div class="block">Call the passivation listeners.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="SESSION_CREATED_SECURE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SESSION_CREATED_SECURE</h4>
<pre>public static final&nbsp;java.lang.String SESSION_CREATED_SECURE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.Session.SESSION_CREATED_SECURE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="_sessionData">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_sessionData</h4>
<pre>protected final&nbsp;<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a> _sessionData</pre>
</li>
</ul>
<a id="_handler">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_handler</h4>
<pre>protected final&nbsp;<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a> _handler</pre>
</li>
</ul>
<a id="_extendedId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_extendedId</h4>
<pre>protected&nbsp;java.lang.String _extendedId</pre>
</li>
</ul>
<a id="_requests">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_requests</h4>
<pre>protected&nbsp;long _requests</pre>
</li>
</ul>
<a id="_idChanged">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_idChanged</h4>
<pre>protected&nbsp;boolean _idChanged</pre>
</li>
</ul>
<a id="_newSession">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_newSession</h4>
<pre>protected&nbsp;boolean _newSession</pre>
</li>
</ul>
<a id="_state">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_state</h4>
<pre>protected&nbsp;<a href="Session.State.html" title="enum in org.eclipse.jetty.server.session">Session.State</a> _state</pre>
</li>
</ul>
<a id="_lock">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_lock</h4>
<pre>protected&nbsp;<a href="../../util/thread/Locker.html" title="class in org.eclipse.jetty.util.thread">Locker</a> _lock</pre>
</li>
</ul>
<a id="_stateChangeCompleted">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_stateChangeCompleted</h4>
<pre>protected&nbsp;java.util.concurrent.locks.Condition _stateChangeCompleted</pre>
</li>
</ul>
<a id="_resident">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_resident</h4>
<pre>protected&nbsp;boolean _resident</pre>
</li>
</ul>
<a id="_sessionInactivityTimer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_sessionInactivityTimer</h4>
<pre>protected final&nbsp;<a href="Session.SessionInactivityTimer.html" title="class in org.eclipse.jetty.server.session">Session.SessionInactivityTimer</a> _sessionInactivityTimer</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.eclipse.jetty.server.session.SessionHandler,javax.servlet.http.HttpServletRequest,org.eclipse.jetty.server.session.SessionData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Session</h4>
<pre>public&nbsp;Session&#8203;(<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>&nbsp;handler,
javax.servlet.http.HttpServletRequest&nbsp;request,
<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a>&nbsp;data)</pre>
<div class="block">Create a new session</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the SessionHandler that manages this session</dd>
<dd><code>request</code> - the request the session should be based on</dd>
<dd><code>data</code> - the session data</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.server.session.SessionHandler,org.eclipse.jetty.server.session.SessionData)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Session</h4>
<pre>public&nbsp;Session&#8203;(<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>&nbsp;handler,
<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a>&nbsp;data)</pre>
<div class="block">Re-inflate an existing session from some eg persistent store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the SessionHandler managing the session</dd>
<dd><code>data</code> - the session data</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getRequests()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequests</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getRequests()</pre>
<div class="block">Returns the current number of requests that are active in the Session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of active requests for this session</dd>
</dl>
</li>
</ul>
<a id="setExtendedId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExtendedId</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExtendedId&#8203;(java.lang.String&nbsp;extendedId)</pre>
</li>
</ul>
<a id="cookieSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cookieSet</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;cookieSet()</pre>
</li>
</ul>
<a id="use()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>use</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;use()</pre>
</li>
</ul>
<a id="access(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>access</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;access&#8203;(long&nbsp;time)</pre>
</li>
</ul>
<a id="complete()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>complete</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;complete()</pre>
</li>
</ul>
<a id="isExpiredAt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExpiredAt</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isExpiredAt&#8203;(long&nbsp;time)</pre>
<div class="block">Check to see if session has expired as at the time given.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>time</code> - the time since the epoch in ms</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if expired</dd>
</dl>
</li>
</ul>
<a id="isIdleLongerThan(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIdleLongerThan</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isIdleLongerThan&#8203;(int&nbsp;sec)</pre>
<div class="block">Check if the Session has been idle longer than a number of seconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sec</code> - the number of seconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the session has been idle longer than the interval</dd>
</dl>
</li>
</ul>
<a id="callSessionAttributeListeners(java.lang.String,java.lang.Object,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callSessionAttributeListeners</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;callSessionAttributeListeners&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;newValue,
java.lang.Object&nbsp;oldValue)</pre>
<div class="block">Call binding and attribute listeners based on the new and old values of
the attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the attribute</dd>
<dd><code>newValue</code> - new value of the attribute</dd>
<dd><code>oldValue</code> - previous value of the attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no session manager can be find</dd>
</dl>
</li>
</ul>
<a id="unbindValue(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unbindValue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unbindValue&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="block">Unbind value if value implements <code>HttpSessionBindingListener</code>
(calls
<code>HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent)</code>)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name with which the object is bound or unbound</dd>
<dd><code>value</code> - the bound value</dd>
</dl>
</li>
</ul>
<a id="bindValue(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindValue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;bindValue&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="block">Bind value if value implements <code>HttpSessionBindingListener</code> (calls
<code>HttpSessionBindingListener.valueBound(HttpSessionBindingEvent)</code>)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name with which the object is bound or unbound</dd>
<dd><code>value</code> - the bound value</dd>
</dl>
</li>
</ul>
<a id="didActivate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>didActivate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;didActivate()</pre>
<div class="block">Call the activation listeners. This must be called holding the lock.</div>
</li>
</ul>
<a id="willPassivate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>willPassivate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;willPassivate()</pre>
<div class="block">Call the passivation listeners. This must be called holding the lock</div>
</li>
</ul>
<a id="isValid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isValid()</pre>
</li>
</ul>
<a id="isInvalid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInvalid</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isInvalid()</pre>
</li>
</ul>
<a id="isChanging()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isChanging</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isChanging()</pre>
</li>
</ul>
<a id="getCookieSetTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCookieSetTime</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCookieSetTime()</pre>
</li>
</ul>
<a id="getCreationTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTime</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCreationTime()
throws java.lang.IllegalStateException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getCreationTime</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a id="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getId()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getId</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getId()</code></dd>
</dl>
</li>
</ul>
<a id="getExtendedId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtendedId</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getExtendedId()</pre>
</li>
</ul>
<a id="getContextPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextPath</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getContextPath()</pre>
</li>
</ul>
<a id="getVHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVHost</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getVHost()</pre>
</li>
</ul>
<a id="getLastAccessedTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastAccessedTime</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getLastAccessedTime()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getLastAccessedTime</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getLastAccessedTime()</code></dd>
</dl>
</li>
</ul>
<a id="getServletContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletContext</h4>
<pre class="methodSignature">public&nbsp;javax.servlet.ServletContext&nbsp;getServletContext()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getServletContext</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getServletContext()</code></dd>
</dl>
</li>
</ul>
<a id="setMaxInactiveInterval(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxInactiveInterval</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxInactiveInterval&#8203;(int&nbsp;secs)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setMaxInactiveInterval</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.setMaxInactiveInterval(int)</code></dd>
</dl>
</li>
</ul>
<a id="updateInactivityTimer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateInactivityTimer</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;updateInactivityTimer()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="calculateInactivityTimeout(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateInactivityTimeout</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;calculateInactivityTimeout&#8203;(long&nbsp;now)</pre>
<div class="block">Calculate what the session timer setting should be based on:
the time remaining before the session expires
and any idle eviction time configured.
The timer value will be the lesser of the above.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>now</code> - the time at which to calculate remaining expiry</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time remaining before expiry or inactivity timeout</dd>
</dl>
</li>
</ul>
<a id="getMaxInactiveInterval()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxInactiveInterval</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxInactiveInterval()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getMaxInactiveInterval</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getMaxInactiveInterval()</code></dd>
</dl>
</li>
</ul>
<a id="getSessionContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionContext</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;javax.servlet.http.HttpSessionContext&nbsp;getSessionContext()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSessionContext</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getSessionContext()</code></dd>
</dl>
</li>
</ul>
<a id="getSessionHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>&nbsp;getSessionHandler()</pre>
</li>
</ul>
<a id="checkValidForWrite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkValidForWrite</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkValidForWrite()
throws java.lang.IllegalStateException</pre>
<div class="block">Check that the session can be modified.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the session is invalid</dd>
</dl>
</li>
</ul>
<a id="checkValidForRead()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkValidForRead</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkValidForRead()
throws java.lang.IllegalStateException</pre>
<div class="block">Chech that the session data can be read.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the session is invalid</dd>
</dl>
</li>
</ul>
<a id="checkLocked()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkLocked</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkLocked()
throws java.lang.IllegalStateException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a id="getAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttribute</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;getAttribute&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAttribute</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getAttribute(java.lang.String)</code></dd>
</dl>
</li>
</ul>
<a id="getValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.Object&nbsp;getValue&#8203;(java.lang.String&nbsp;name)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getValue</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getValue(java.lang.String)</code></dd>
</dl>
</li>
</ul>
<a id="getAttributeNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Enumeration&lt;java.lang.String&gt;&nbsp;getAttributeNames()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAttributeNames</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.getAttributeNames()</code></dd>
</dl>
</li>
</ul>
<a id="getAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getAttributes()</pre>
</li>
</ul>
<a id="getNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getNames()</pre>
</li>
</ul>
<a id="getValueNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueNames</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String[]&nbsp;getValueNames()
throws java.lang.IllegalStateException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">As of Version 2.2, this method is replaced by
<a href="#getAttributeNames()"><code>getAttributeNames()</code></a></div>
</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getValueNames</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a id="setAttribute(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAttribute&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setAttribute</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.setAttribute(java.lang.String,
java.lang.Object)</code></dd>
</dl>
</li>
</ul>
<a id="putValue(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putValue</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;putValue&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>putValue</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.putValue(java.lang.String,
java.lang.Object)</code></dd>
</dl>
</li>
</ul>
<a id="removeAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeAttribute&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>removeAttribute</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.removeAttribute(java.lang.String)</code></dd>
</dl>
</li>
</ul>
<a id="removeValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeValue</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;removeValue&#8203;(java.lang.String&nbsp;name)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>removeValue</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.removeValue(java.lang.String)</code></dd>
</dl>
</li>
</ul>
<a id="renewId(javax.servlet.http.HttpServletRequest)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>renewId</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;renewId&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Force a change to the id of a session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the Request associated with the call to change id.</dd>
</dl>
</li>
</ul>
<a id="invalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;invalidate()</pre>
<div class="block">Called by users to invalidate a session, or called by the access method
as a request enters the session if the session has expired, or called by
manager as a result of scavenger expiring session</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>invalidate</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpSession.invalidate()</code></dd>
</dl>
</li>
</ul>
<a id="lock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lock</h4>
<pre class="methodSignature">public&nbsp;<a href="../../util/thread/Locker.Lock.html" title="class in org.eclipse.jetty.util.thread">Locker.Lock</a>&nbsp;lock()</pre>
<div class="block">Grab the lock on the session</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lock</dd>
</dl>
</li>
</ul>
<a id="beginInvalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginInvalidate</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;beginInvalidate()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the session is not already invalid or being invalidated.</dd>
</dl>
</li>
</ul>
<a id="doInvalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doInvalidate</h4>
<pre class="methodSignature">@Deprecated
protected&nbsp;void&nbsp;doInvalidate()
throws java.lang.IllegalStateException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Call HttpSessionAttributeListeners as part of invalidating a Session.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no session manager can be find</dd>
</dl>
</li>
</ul>
<a id="finishInvalidate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finishInvalidate</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;finishInvalidate()
throws java.lang.IllegalStateException</pre>
<div class="block">Call HttpSessionAttributeListeners as part of invalidating a Session.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no session manager can be find</dd>
</dl>
</li>
</ul>
<a id="isNew()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNew</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isNew()
throws java.lang.IllegalStateException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isNew</code>&nbsp;in interface&nbsp;<code>javax.servlet.http.HttpSession</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a id="setIdChanged(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdChanged</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIdChanged&#8203;(boolean&nbsp;changed)</pre>
</li>
</ul>
<a id="isIdChanged()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIdChanged</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isIdChanged()</pre>
</li>
</ul>
<a id="getSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre class="methodSignature">public&nbsp;<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a>&nbsp;getSession()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SessionHandler.SessionIf.html#getSession()">getSession</a></code>&nbsp;in interface&nbsp;<code><a href="SessionHandler.SessionIf.html" title="interface in org.eclipse.jetty.server.session">SessionHandler.SessionIf</a></code></dd>
</dl>
</li>
</ul>
<a id="getSessionData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionData</h4>
<pre class="methodSignature">protected&nbsp;<a href="SessionData.html" title="class in org.eclipse.jetty.server.session">SessionData</a>&nbsp;getSessionData()</pre>
</li>
</ul>
<a id="setResident(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResident</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setResident&#8203;(boolean&nbsp;resident)</pre>
</li>
</ul>
<a id="isResident()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isResident</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isResident()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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/Session.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>