| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:38:39 CST 2022 --> |
| <title>SessionHandler (Jetty :: Project 9.4.45.v20220203 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-02-08"> |
| <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="SessionHandler (Jetty :: Project 9.4.45.v20220203 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":10,"i11":10,"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":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":9,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":42,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SessionHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.server.session</a></div> |
| <h2 title="Class SessionHandler" class="title">Class SessionHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandler</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.AbstractHandlerContainer</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.HandlerWrapper</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">org.eclipse.jetty.server.handler.ScopedHandler</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.server.session.SessionHandler</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Handler.html" title="interface in org.eclipse.jetty.server">Handler</a></code>, <code><a href="../HandlerContainer.html" title="interface in org.eclipse.jetty.server">HandlerContainer</a></code>, <code><a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a> |
| public class <span class="typeNameLabel">SessionHandler</span> |
| extends <a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></pre> |
| <div class="block">SessionHandler.</div> |
| </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"> </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>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SessionHandler.CookieConfig.html" title="class in org.eclipse.jetty.server.session">SessionHandler.CookieConfig</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">CookieConfig |
| |
| Implementation of the javax.servlet.SessionCookieConfig.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SessionHandler.SessionIf.html" title="interface in org.eclipse.jetty.server.session">SessionHandler.SessionIf</a></span></code></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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.<a href="../handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3> |
| <code><a href="../handler/AbstractHandler.ErrorDispatchHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler.ErrorDispatchHandler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </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"> </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>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__CheckRemoteSessionEncoding">__CheckRemoteSessionEncoding</a></span></code></th> |
| <td class="colLast"> </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="#__DefaultSessionCookie">__DefaultSessionCookie</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__DefaultSessionDomain">__DefaultSessionDomain</a></span></code></th> |
| <td class="colLast"> </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="#__DefaultSessionIdPathParameterName">__DefaultSessionIdPathParameterName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__MaxAgeProperty">__MaxAgeProperty</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Session Max Age.</div> |
| </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="#__SessionCookieProperty">__SessionCookieProperty</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Session cookie name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__SessionDomainProperty">__SessionDomainProperty</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Session Domain.</div> |
| </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="#__SessionIdPathParameterNameProperty">__SessionIdPathParameterNameProperty</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Session id path parameter name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__SessionPathProperty">__SessionPathProperty</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Session Path.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_candidateSessionIdsForExpiry">_candidateSessionIdsForExpiry</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_checkingRemoteSessionIdEncoding">_checkingRemoteSessionIdEncoding</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../handler/ContextHandler.Context.html" title="class in org.eclipse.jetty.server.handler">ContextHandler.Context</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_context">_context</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_dftMaxIdleSecs">_dftMaxIdleSecs</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Setting of max inactive interval for new sessions |
| -1 means no timeout</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_httpOnly">_httpOnly</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.ClassLoader</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_loader">_loader</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_maxCookieAge">_maxCookieAge</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_nodeIdInSessionId">_nodeIdInSessionId</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_ownScheduler">_ownScheduler</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_refreshCookieAge">_refreshCookieAge</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_scheduler">_scheduler</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_secureCookies">_secureCookies</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_secureRequestOnly">_secureRequestOnly</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<javax.servlet.http.HttpSessionAttributeListener></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionAttributeListeners">_sessionAttributeListeners</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionCache">_sessionCache</a></span></code></th> |
| <td class="colLast"> </td> |
| </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="#_sessionComment">_sessionComment</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="SessionContext.html" title="class in org.eclipse.jetty.server.session">SessionContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionContext">_sessionContext</a></span></code></th> |
| <td class="colLast"> </td> |
| </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="#_sessionCookie">_sessionCookie</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionDomain">_sessionDomain</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<javax.servlet.http.HttpSessionIdListener></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionIdListeners">_sessionIdListeners</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionIdManager">_sessionIdManager</a></span></code></th> |
| <td class="colLast"> </td> |
| </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="#_sessionIdPathParameterName">_sessionIdPathParameterName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionIdPathParameterNamePrefix">_sessionIdPathParameterNamePrefix</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<javax.servlet.http.HttpSessionListener></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionListeners">_sessionListeners</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionPath">_sessionPath</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../util/statistic/CounterStatistic.html" title="class in org.eclipse.jetty.util.statistic">CounterStatistic</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionsCreatedStats">_sessionsCreatedStats</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../util/statistic/SampleStatistic.html" title="class in org.eclipse.jetty.util.statistic">SampleStatistic</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionTimeStats">_sessionTimeStats</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.util.Set<javax.servlet.SessionTrackingMode></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_sessionTrackingModes">_sessionTrackingModes</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_usingCookies">_usingCookies</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_usingURLs">_usingURLs</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.util.Set<javax.servlet.SessionTrackingMode></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_SESSION_TRACKING_MODES">DEFAULT_SESSION_TRACKING_MODES</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.util.EnumSet<javax.servlet.SessionTrackingMode></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_TRACKING">DEFAULT_TRACKING</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.math.BigDecimal</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MAX_INACTIVE_MINUTES">MAX_INACTIVE_MINUTES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Web.xml session-timeout is set in minutes, but is stored as an int in seconds by HttpSession and |
| the sessionmanager.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.Class<? extends java.util.EventListener>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SESSION_LISTENER_TYPES">SESSION_LISTENER_TYPES</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.server.handler.ScopedHandler"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.server.handler.<a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></h3> |
| <code><a href="../handler/ScopedHandler.html#_nextScope">_nextScope</a>, <a href="../handler/ScopedHandler.html#_outerScope">_outerScope</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.server.handler.<a href="../handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../handler/HandlerWrapper.html#_handler">_handler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.html#KEY">KEY</a></code></li> |
| </ul> |
| </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"> </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()">SessionHandler</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../http/HttpCookie.html" title="class in org.eclipse.jetty.http">HttpCookie</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#access(javax.servlet.http.HttpSession,boolean)">access</a></span>​(javax.servlet.http.HttpSession session, |
| boolean secure)</code></th> |
| <td class="colLast"> |
| <div class="block">Called by the <a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session"><code>SessionHandler</code></a> when a session is first accessed by a request.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addEventListener(java.util.EventListener)">addEventListener</a></span>​(java.util.EventListener listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an event listener for session-related events.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callSessionCreatedListeners(org.eclipse.jetty.server.session.Session)">callSessionCreatedListeners</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</code></th> |
| <td class="colLast"> |
| <div class="block">Call the session lifecycle listeners</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callSessionDestroyedListeners(org.eclipse.jetty.server.session.Session)">callSessionDestroyedListeners</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</code></th> |
| <td class="colLast"> |
| <div class="block">Call the session lifecycle listeners</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="#callSessionIdListeners(org.eclipse.jetty.server.session.Session,java.lang.String)">callSessionIdListeners</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| java.lang.String oldId)</code></th> |
| <td class="colLast"> </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="#checkRequestedSessionId(org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest)">checkRequestedSessionId</a></span>​(<a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request)</code></th> |
| <td class="colLast"> |
| <div class="block">Look for a requested session ID in cookies and URI parameters</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearEventListeners()">clearEventListeners</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Removes all event listeners for session-related events.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commit(javax.servlet.http.HttpSession)">commit</a></span>​(javax.servlet.http.HttpSession session)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a response is about to be committed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete(javax.servlet.http.HttpSession)">complete</a></span>​(javax.servlet.http.HttpSession session)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a request is finally leaving a session.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete(org.eclipse.jetty.server.session.Session,org.eclipse.jetty.server.Request)">complete</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doHandle</a></span>​(java.lang.String target, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code></th> |
| <td class="colLast"> |
| <div class="block">Do the handler work within the scope.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doScope</a></span>​(java.lang.String target, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code></th> |
| <td class="colLast"> |
| <div class="block">Scope the handler</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doSessionAttributeListeners(org.eclipse.jetty.server.session.Session,java.lang.String,java.lang.Object,java.lang.Object)">doSessionAttributeListeners</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| java.lang.String name, |
| java.lang.Object old, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<javax.servlet.SessionTrackingMode></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultSessionTrackingModes()">getDefaultSessionTrackingModes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<javax.servlet.SessionTrackingMode></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectiveSessionTrackingModes()">getEffectiveSessionTrackingModes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtendedId(javax.servlet.http.HttpSession)">getExtendedId</a></span>​(javax.servlet.http.HttpSession session)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpOnly()">getHttpOnly</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected javax.servlet.http.HttpSession</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpSession(java.lang.String)">getHttpSession</a></span>​(java.lang.String extendedId)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>HttpSession</code> with the given session id</div> |
| </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(javax.servlet.http.HttpSession)">getId</a></span>​(javax.servlet.http.HttpSession session)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxCookieAge()">getMaxCookieAge</a></span>()</code></th> |
| <td class="colLast"> </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"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRefreshCookieAge()">getRefreshCookieAge</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../http/HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSameSite()">getSameSite</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheduler()">getScheduler</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecureCookies()">getSecureCookies</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <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(java.lang.String)">getSession</a></span>​(java.lang.String id)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a known existing session</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionCache()">getSessionCache</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionCookie()">getSessionCookie</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../http/HttpCookie.html" title="class in org.eclipse.jetty.http">HttpCookie</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionCookie(javax.servlet.http.HttpSession,java.lang.String,boolean)">getSessionCookie</a></span>​(javax.servlet.http.HttpSession session, |
| java.lang.String contextPath, |
| boolean requestIsSecure)</code></th> |
| <td class="colLast"> |
| <div class="block">A session cookie is marked as secure IFF any of the following conditions are true: |
| |
| SessionCookieConfig.setSecure == true |
| SessionCookieConfig.setSecure == false && _secureRequestOnly==true && request is HTTPS |
| |
| According to SessionCookieConfig javadoc, case 1 can be used when: |
| "...</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>javax.servlet.SessionCookieConfig</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionCookieConfig()">getSessionCookieConfig</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionCookieName(javax.servlet.SessionCookieConfig)">getSessionCookieName</a></span>​(javax.servlet.SessionCookieConfig config)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionDomain()">getSessionDomain</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionIdManager()">getSessionIdManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the cross context session id manager</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionIdPathParameterName()">getSessionIdPathParameterName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionIdPathParameterNamePrefix()">getSessionIdPathParameterNamePrefix</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionPath()">getSessionPath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionsCreated()">getSessionsCreated</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionTimeMax()">getSessionTimeMax</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionTimeMean()">getSessionTimeMean</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionTimeStdDev()">getSessionTimeStdDev</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionTimeTotal()">getSessionTimeTotal</a></span>()</code></th> |
| <td class="colLast"> </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="#invalidate(java.lang.String)">invalidate</a></span>​(java.lang.String id)</code></th> |
| <td class="colLast"> |
| <div class="block">Called by SessionIdManager to remove a session that has been invalidated, |
| either by this context or another context.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCheckingRemoteSessionIdEncoding()">isCheckingRemoteSessionIdEncoding</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIdInUse(java.lang.String)">isIdInUse</a></span>​(java.lang.String id)</code></th> |
| <td class="colLast"> |
| <div class="block">Check if id is in use by this context</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNodeIdInSessionId()">isNodeIdInSessionId</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecureRequestOnly()">isSecureRequestOnly</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUsingCookies()">isUsingCookies</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUsingURLs()">isUsingURLs</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(javax.servlet.http.HttpSession)">isValid</a></span>​(javax.servlet.http.HttpSession session)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>javax.servlet.http.HttpSession</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newHttpSession(javax.servlet.http.HttpServletRequest)">newHttpSession</a></span>​(javax.servlet.http.HttpServletRequest request)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>HttpSession</code>.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recordSessionTime(org.eclipse.jetty.server.session.Session)">recordSessionTime</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</code></th> |
| <td class="colLast"> |
| <div class="block">Record length of time session has been active.</div> |
| </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="#removeEventListener(java.util.EventListener)">removeEventListener</a></span>​(java.util.EventListener listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes an event listener for for session-related events.</div> |
| </td> |
| </tr> |
| <tr id="i54" 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="#removeSession(java.lang.String,boolean)">removeSession</a></span>​(java.lang.String id, |
| boolean invalidate)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove session from manager</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renewSessionId(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">renewSessionId</a></span>​(java.lang.String oldId, |
| java.lang.String oldExtendedId, |
| java.lang.String newId, |
| java.lang.String newExtendedId)</code></th> |
| <td class="colLast"> |
| <div class="block">Change the existing session id.</div> |
| </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="#scavenge()">scavenge</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called periodically by the HouseKeeper to handle the list of |
| sessions that have expired since the last call to scavenge.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sessionInactivityTimerExpired(org.eclipse.jetty.server.session.Session)">sessionInactivityTimerExpired</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sessionInactivityTimerExpired(org.eclipse.jetty.server.session.Session,long)">sessionInactivityTimerExpired</a></span>​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| long now)</code></th> |
| <td class="colLast"> |
| <div class="block">Each session has a timer that is configured to go off |
| when either the session has not been accessed for a |
| configurable amount of time, or the session itself |
| has passed its expiry.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCheckingRemoteSessionIdEncoding(boolean)">setCheckingRemoteSessionIdEncoding</a></span>​(boolean remote)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHttpOnly(boolean)">setHttpOnly</a></span>​(boolean httpOnly)</code></th> |
| <td class="colLast"> |
| <div class="block">Set if Session cookies should use HTTP Only</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxInactiveInterval(int)">setMaxInactiveInterval</a></span>​(int seconds)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the max period of inactivity, after which the session is invalidated, in seconds.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNodeIdInSessionId(boolean)">setNodeIdInSessionId</a></span>​(boolean nodeIdInSessionId)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRefreshCookieAge(int)">setRefreshCookieAge</a></span>​(int ageInSeconds)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSameSite(org.eclipse.jetty.http.HttpCookie.SameSite)">setSameSite</a></span>​(<a href="../../http/HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a> sameSite)</code></th> |
| <td class="colLast"> |
| <div class="block">Set Session cookie sameSite mode.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecureRequestOnly(boolean)">setSecureRequestOnly</a></span>​(boolean secureRequestOnly)</code></th> |
| <td class="colLast"> |
| <div class="block">HTTPS request.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionCache(org.eclipse.jetty.server.session.SessionCache)">setSessionCache</a></span>​(<a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a> cache)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionCookie(java.lang.String)">setSessionCookie</a></span>​(java.lang.String cookieName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionIdManager(org.eclipse.jetty.server.SessionIdManager)">setSessionIdManager</a></span>​(<a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a> metaManager)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionIdPathParameterName(java.lang.String)">setSessionIdPathParameterName</a></span>​(java.lang.String param)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the session id URL path parameter name.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionTrackingModes(java.util.Set)">setSessionTrackingModes</a></span>​(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUsingCookies(boolean)">setUsingCookies</a></span>​(boolean usingCookies)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shutdownSessions()">shutdownSessions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Prepare sessions for session manager shutdown</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#statsReset()">statsReset</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reset statistics values</div> |
| </td> |
| </tr> |
| <tr id="i74" 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"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.ScopedHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></h3> |
| <code><a href="../handler/ScopedHandler.html#handle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">handle</a>, <a href="../handler/ScopedHandler.html#nextHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">nextHandle</a>, <a href="../handler/ScopedHandler.html#nextScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">nextScope</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.HandlerWrapper"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../handler/HandlerWrapper.html" title="class in org.eclipse.jetty.server.handler">HandlerWrapper</a></h3> |
| <code><a href="../handler/HandlerWrapper.html#destroy()">destroy</a>, <a href="../handler/HandlerWrapper.html#expandChildren(java.util.List,java.lang.Class)">expandChildren</a>, <a href="../handler/HandlerWrapper.html#getHandler()">getHandler</a>, <a href="../handler/HandlerWrapper.html#getHandlers()">getHandlers</a>, <a href="../handler/HandlerWrapper.html#insertHandler(org.eclipse.jetty.server.handler.HandlerWrapper)">insertHandler</a>, <a href="../handler/HandlerWrapper.html#setHandler(org.eclipse.jetty.server.Handler)">setHandler</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandlerContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../handler/AbstractHandlerContainer.html" title="class in org.eclipse.jetty.server.handler">AbstractHandlerContainer</a></h3> |
| <code><a href="../handler/AbstractHandlerContainer.html#doShutdown(java.util.List)">doShutdown</a>, <a href="../handler/AbstractHandlerContainer.html#expandHandler(org.eclipse.jetty.server.Handler,java.util.List,java.lang.Class)">expandHandler</a>, <a href="../handler/AbstractHandlerContainer.html#findContainerOf(org.eclipse.jetty.server.HandlerContainer,java.lang.Class,org.eclipse.jetty.server.Handler)">findContainerOf</a>, <a href="../handler/AbstractHandlerContainer.html#getChildHandlerByClass(java.lang.Class)">getChildHandlerByClass</a>, <a href="../handler/AbstractHandlerContainer.html#getChildHandlers()">getChildHandlers</a>, <a href="../handler/AbstractHandlerContainer.html#getChildHandlersByClass(java.lang.Class)">getChildHandlersByClass</a>, <a href="../handler/AbstractHandlerContainer.html#setServer(org.eclipse.jetty.server.Server)">setServer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.server.handler.AbstractHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.server.handler.<a href="../handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></h3> |
| <code><a href="../handler/AbstractHandler.html#doError(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doError</a>, <a href="../handler/AbstractHandler.html#getServer()">getServer</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addEventListener(org.eclipse.jetty.util.component.Container.Listener)">addEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String,java.util.Collection...)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(org.eclipse.jetty.util.component.Dumpable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpBeans(java.lang.Appendable,java.lang.String,java.util.Collection...)">dumpBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObject(java.lang.Appendable,java.lang.Object)">dumpObject</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpThis(java.lang.Appendable)">dumpThis</a>, <a href="../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#removeEventListener(org.eclipse.jetty.util.component.Container.Listener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable.DumpableContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../util/component/LifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../util/component/LifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/LifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/LifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/LifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/LifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/LifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/LifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../util/component/LifeCycle.html#start()">start</a>, <a href="../../util/component/LifeCycle.html#stop()">stop</a></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="DEFAULT_TRACKING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_TRACKING</h4> |
| <pre>public static final java.util.EnumSet<javax.servlet.SessionTrackingMode> DEFAULT_TRACKING</pre> |
| </li> |
| </ul> |
| <a id="__SessionCookieProperty"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__SessionCookieProperty</h4> |
| <pre>public static final java.lang.String __SessionCookieProperty</pre> |
| <div class="block">Session cookie name. |
| Defaults to <code>JSESSIONID</code>, but can be set with the |
| <code>org.eclipse.jetty.servlet.SessionCookie</code> context init parameter.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__SessionCookieProperty">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__DefaultSessionCookie"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__DefaultSessionCookie</h4> |
| <pre>public static final java.lang.String __DefaultSessionCookie</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__DefaultSessionCookie">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__SessionIdPathParameterNameProperty"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__SessionIdPathParameterNameProperty</h4> |
| <pre>public static final java.lang.String __SessionIdPathParameterNameProperty</pre> |
| <div class="block">Session id path parameter name. |
| Defaults to <code>jsessionid</code>, but can be set with the |
| <code>org.eclipse.jetty.servlet.SessionIdPathParameterName</code> context init parameter. |
| If context init param is "none", or setSessionIdPathParameterName is called with null or "none", |
| no URL rewriting will be done.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__SessionIdPathParameterNameProperty">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__DefaultSessionIdPathParameterName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__DefaultSessionIdPathParameterName</h4> |
| <pre>public static final java.lang.String __DefaultSessionIdPathParameterName</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__DefaultSessionIdPathParameterName">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__CheckRemoteSessionEncoding"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__CheckRemoteSessionEncoding</h4> |
| <pre>public static final java.lang.String __CheckRemoteSessionEncoding</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__CheckRemoteSessionEncoding">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__SessionDomainProperty"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__SessionDomainProperty</h4> |
| <pre>public static final java.lang.String __SessionDomainProperty</pre> |
| <div class="block">Session Domain. |
| If this property is set as a ServletContext InitParam, then it is |
| used as the domain for session cookies. If it is not set, then |
| no domain is specified for the session cookie.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__SessionDomainProperty">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__DefaultSessionDomain"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__DefaultSessionDomain</h4> |
| <pre>public static final java.lang.String __DefaultSessionDomain</pre> |
| </li> |
| </ul> |
| <a id="__SessionPathProperty"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__SessionPathProperty</h4> |
| <pre>public static final java.lang.String __SessionPathProperty</pre> |
| <div class="block">Session Path. |
| If this property is set as a ServletContext InitParam, then it is |
| used as the path for the session cookie. If it is not set, then |
| the context path is used as the path for the cookie.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__SessionPathProperty">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="__MaxAgeProperty"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>__MaxAgeProperty</h4> |
| <pre>public static final java.lang.String __MaxAgeProperty</pre> |
| <div class="block">Session Max Age. |
| If this property is set as a ServletContext InitParam, then it is |
| used as the max age for the session cookie. If it is not set, then |
| a max age of -1 is used.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.SessionHandler.__MaxAgeProperty">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFAULT_SESSION_TRACKING_MODES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SESSION_TRACKING_MODES</h4> |
| <pre>public static final java.util.Set<javax.servlet.SessionTrackingMode> DEFAULT_SESSION_TRACKING_MODES</pre> |
| </li> |
| </ul> |
| <a id="SESSION_LISTENER_TYPES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SESSION_LISTENER_TYPES</h4> |
| <pre>public static final java.lang.Class<? extends java.util.EventListener>[] SESSION_LISTENER_TYPES</pre> |
| </li> |
| </ul> |
| <a id="MAX_INACTIVE_MINUTES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAX_INACTIVE_MINUTES</h4> |
| <pre>public static final java.math.BigDecimal MAX_INACTIVE_MINUTES</pre> |
| <div class="block">Web.xml session-timeout is set in minutes, but is stored as an int in seconds by HttpSession and |
| the sessionmanager. Thus MAX_INT is the max number of seconds that can be set, and MAX_INT/60 is the |
| max number of minutes that you can set.</div> |
| </li> |
| </ul> |
| <a id="_dftMaxIdleSecs"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_dftMaxIdleSecs</h4> |
| <pre>protected int _dftMaxIdleSecs</pre> |
| <div class="block">Setting of max inactive interval for new sessions |
| -1 means no timeout</div> |
| </li> |
| </ul> |
| <a id="_httpOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_httpOnly</h4> |
| <pre>protected boolean _httpOnly</pre> |
| </li> |
| </ul> |
| <a id="_sessionIdManager"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionIdManager</h4> |
| <pre>protected <a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a> _sessionIdManager</pre> |
| </li> |
| </ul> |
| <a id="_secureCookies"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_secureCookies</h4> |
| <pre>protected boolean _secureCookies</pre> |
| </li> |
| </ul> |
| <a id="_secureRequestOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_secureRequestOnly</h4> |
| <pre>protected boolean _secureRequestOnly</pre> |
| </li> |
| </ul> |
| <a id="_sessionAttributeListeners"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionAttributeListeners</h4> |
| <pre>protected final java.util.List<javax.servlet.http.HttpSessionAttributeListener> _sessionAttributeListeners</pre> |
| </li> |
| </ul> |
| <a id="_sessionListeners"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionListeners</h4> |
| <pre>protected final java.util.List<javax.servlet.http.HttpSessionListener> _sessionListeners</pre> |
| </li> |
| </ul> |
| <a id="_sessionIdListeners"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionIdListeners</h4> |
| <pre>protected final java.util.List<javax.servlet.http.HttpSessionIdListener> _sessionIdListeners</pre> |
| </li> |
| </ul> |
| <a id="_loader"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_loader</h4> |
| <pre>protected java.lang.ClassLoader _loader</pre> |
| </li> |
| </ul> |
| <a id="_context"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_context</h4> |
| <pre>protected <a href="../handler/ContextHandler.Context.html" title="class in org.eclipse.jetty.server.handler">ContextHandler.Context</a> _context</pre> |
| </li> |
| </ul> |
| <a id="_sessionContext"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionContext</h4> |
| <pre>protected <a href="SessionContext.html" title="class in org.eclipse.jetty.server.session">SessionContext</a> _sessionContext</pre> |
| </li> |
| </ul> |
| <a id="_sessionCookie"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionCookie</h4> |
| <pre>protected java.lang.String _sessionCookie</pre> |
| </li> |
| </ul> |
| <a id="_sessionIdPathParameterName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionIdPathParameterName</h4> |
| <pre>protected java.lang.String _sessionIdPathParameterName</pre> |
| </li> |
| </ul> |
| <a id="_sessionIdPathParameterNamePrefix"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionIdPathParameterNamePrefix</h4> |
| <pre>protected java.lang.String _sessionIdPathParameterNamePrefix</pre> |
| </li> |
| </ul> |
| <a id="_sessionDomain"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionDomain</h4> |
| <pre>protected java.lang.String _sessionDomain</pre> |
| </li> |
| </ul> |
| <a id="_sessionPath"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionPath</h4> |
| <pre>protected java.lang.String _sessionPath</pre> |
| </li> |
| </ul> |
| <a id="_maxCookieAge"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_maxCookieAge</h4> |
| <pre>protected int _maxCookieAge</pre> |
| </li> |
| </ul> |
| <a id="_refreshCookieAge"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_refreshCookieAge</h4> |
| <pre>protected int _refreshCookieAge</pre> |
| </li> |
| </ul> |
| <a id="_nodeIdInSessionId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_nodeIdInSessionId</h4> |
| <pre>protected boolean _nodeIdInSessionId</pre> |
| </li> |
| </ul> |
| <a id="_checkingRemoteSessionIdEncoding"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_checkingRemoteSessionIdEncoding</h4> |
| <pre>protected boolean _checkingRemoteSessionIdEncoding</pre> |
| </li> |
| </ul> |
| <a id="_sessionComment"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionComment</h4> |
| <pre>protected java.lang.String _sessionComment</pre> |
| </li> |
| </ul> |
| <a id="_sessionCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionCache</h4> |
| <pre>protected <a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a> _sessionCache</pre> |
| </li> |
| </ul> |
| <a id="_sessionTimeStats"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionTimeStats</h4> |
| <pre>protected final <a href="../../util/statistic/SampleStatistic.html" title="class in org.eclipse.jetty.util.statistic">SampleStatistic</a> _sessionTimeStats</pre> |
| </li> |
| </ul> |
| <a id="_sessionsCreatedStats"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionsCreatedStats</h4> |
| <pre>protected final <a href="../../util/statistic/CounterStatistic.html" title="class in org.eclipse.jetty.util.statistic">CounterStatistic</a> _sessionsCreatedStats</pre> |
| </li> |
| </ul> |
| <a id="_sessionTrackingModes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_sessionTrackingModes</h4> |
| <pre>public java.util.Set<javax.servlet.SessionTrackingMode> _sessionTrackingModes</pre> |
| </li> |
| </ul> |
| <a id="_usingURLs"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_usingURLs</h4> |
| <pre>protected boolean _usingURLs</pre> |
| </li> |
| </ul> |
| <a id="_usingCookies"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_usingCookies</h4> |
| <pre>protected boolean _usingCookies</pre> |
| </li> |
| </ul> |
| <a id="_candidateSessionIdsForExpiry"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_candidateSessionIdsForExpiry</h4> |
| <pre>protected java.util.Set<java.lang.String> _candidateSessionIdsForExpiry</pre> |
| </li> |
| </ul> |
| <a id="_scheduler"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_scheduler</h4> |
| <pre>protected <a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a> _scheduler</pre> |
| </li> |
| </ul> |
| <a id="_ownScheduler"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>_ownScheduler</h4> |
| <pre>protected boolean _ownScheduler</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="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SessionHandler</h4> |
| <pre>public SessionHandler()</pre> |
| <div class="block">Constructor.</div> |
| </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="getSessionPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionPath</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("path of the session cookie, or null for default") |
| public java.lang.String getSessionPath()</pre> |
| </li> |
| </ul> |
| <a id="getMaxCookieAge()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxCookieAge</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("if greater the zero, the time in seconds a session cookie will last for") |
| public int getMaxCookieAge()</pre> |
| </li> |
| </ul> |
| <a id="access(javax.servlet.http.HttpSession,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>access</h4> |
| <pre class="methodSignature">public <a href="../../http/HttpCookie.html" title="class in org.eclipse.jetty.http">HttpCookie</a> access​(javax.servlet.http.HttpSession session, |
| boolean secure)</pre> |
| <div class="block">Called by the <a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session"><code>SessionHandler</code></a> when a session is first accessed by a request.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session object</dd> |
| <dd><code>secure</code> - whether the request is secure or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session cookie. If not null, this cookie should be set on the response to either migrate |
| the session or to refresh a session cookie that may expire.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#complete(javax.servlet.http.HttpSession)"><code>complete(HttpSession)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addEventListener(java.util.EventListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEventListener</h4> |
| <pre class="methodSignature">public void addEventListener​(java.util.EventListener listener)</pre> |
| <div class="block">Adds an event listener for session-related events.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the session event listener to add |
| Individual SessionManagers implementations may accept arbitrary listener types, |
| but they are expected to at least handle HttpSessionActivationListener, |
| HttpSessionAttributeListener, HttpSessionBindingListener and HttpSessionListener.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#removeEventListener(java.util.EventListener)"><code>removeEventListener(EventListener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearEventListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearEventListeners</h4> |
| <pre class="methodSignature">public void clearEventListeners()</pre> |
| <div class="block">Removes all event listeners for session-related events.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#removeEventListener(java.util.EventListener)"><code>removeEventListener(EventListener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callSessionDestroyedListeners(org.eclipse.jetty.server.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callSessionDestroyedListeners</h4> |
| <pre class="methodSignature">protected void callSessionDestroyedListeners​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</pre> |
| <div class="block">Call the session lifecycle listeners</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session on which to call the lifecycle listeners</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callSessionCreatedListeners(org.eclipse.jetty.server.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callSessionCreatedListeners</h4> |
| <pre class="methodSignature">protected void callSessionCreatedListeners​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</pre> |
| <div class="block">Call the session lifecycle listeners</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session on which to call the lifecycle listeners</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callSessionIdListeners(org.eclipse.jetty.server.session.Session,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callSessionIdListeners</h4> |
| <pre class="methodSignature">protected void callSessionIdListeners​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| java.lang.String oldId)</pre> |
| </li> |
| </ul> |
| <a id="complete(javax.servlet.http.HttpSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>complete</h4> |
| <pre class="methodSignature">public void complete​(javax.servlet.http.HttpSession session)</pre> |
| <div class="block">Called when a request is finally leaving a session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commit(javax.servlet.http.HttpSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre class="methodSignature">public void commit​(javax.servlet.http.HttpSession session)</pre> |
| <div class="block">Called when a response is about to be committed. |
| We might take this opportunity to persist the session |
| so that any subsequent requests to other servers |
| will see the modifications.</div> |
| </li> |
| </ul> |
| <a id="complete(org.eclipse.jetty.server.session.Session,org.eclipse.jetty.server.Request)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>complete</h4> |
| <pre class="methodSignature">@Deprecated |
| public void complete​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="doStart()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre class="methodSignature">protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../handler/ScopedHandler.html#doStart()">doStart</a></code> in class <code><a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../handler/AbstractHandler.html#doStart()"><code>AbstractHandler.doStart()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre class="methodSignature">protected void doStop() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../util/component/ContainerLifeCycle.html#doStop()">ContainerLifeCycle</a></code></span></div> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../handler/AbstractHandler.html#doStop()">doStop</a></code> in class <code><a href="../handler/AbstractHandler.html" title="class in org.eclipse.jetty.server.handler">AbstractHandler</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHttpOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpOnly</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("true if cookies use the http only flag") |
| public boolean getHttpOnly()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if session cookies should be HTTP-only (Microsoft extension)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../http/HttpCookie.html#isHttpOnly()"><code>HttpCookie.isHttpOnly()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSameSite()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSameSite</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("SameSite setting for session cookies") |
| public <a href="../../http/HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a> getSameSite()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The sameSite setting for session cookies or null for no setting</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../http/HttpCookie.html#getSameSite()"><code>HttpCookie.getSameSite()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHttpSession(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpSession</h4> |
| <pre class="methodSignature">protected javax.servlet.http.HttpSession getHttpSession​(java.lang.String extendedId)</pre> |
| <div class="block">Returns the <code>HttpSession</code> with the given session id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extendedId</code> - the session id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>HttpSession</code> with the corresponding id or null if no session with the given id exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionIdManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionIdManager</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("Session ID Manager") |
| public <a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a> getSessionIdManager()</pre> |
| <div class="block">Gets the cross context session id manager</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session id manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxInactiveInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxInactiveInterval</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("default maximum time a session may be idle for (in s)") |
| public int getMaxInactiveInterval()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the max period of inactivity, after which the session is invalidated, in seconds.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setMaxInactiveInterval(int)"><code>setMaxInactiveInterval(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRefreshCookieAge()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRefreshCookieAge</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("time before a session cookie is re-set (in s)") |
| public int getRefreshCookieAge()</pre> |
| </li> |
| </ul> |
| <a id="getSecureCookies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecureCookies</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("if true, secure cookie flag is set on session cookies") |
| public boolean getSecureCookies()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>same as SessionCookieConfig.getSecure(). If true, session |
| cookies are ALWAYS marked as secure. If false, a session cookie is |
| ONLY marked as secure if _secureRequestOnly == true and it is an HTTPS request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSecureRequestOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecureRequestOnly</h4> |
| <pre class="methodSignature">public boolean isSecureRequestOnly()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if session cookie is to be marked as secure only on HTTPS requests</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSecureRequestOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecureRequestOnly</h4> |
| <pre class="methodSignature">public void setSecureRequestOnly​(boolean secureRequestOnly)</pre> |
| <div class="block">HTTPS request. Can be overridden by setting SessionCookieConfig.setSecure(true), |
| in which case the session cookie will be marked as secure on both HTTPS and HTTP.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>secureRequestOnly</code> - true to set Session Cookie Config as secure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionCookie()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionCookie</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("the set session cookie") |
| public java.lang.String getSessionCookie()</pre> |
| </li> |
| </ul> |
| <a id="getSessionCookie(javax.servlet.http.HttpSession,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionCookie</h4> |
| <pre class="methodSignature">public <a href="../../http/HttpCookie.html" title="class in org.eclipse.jetty.http">HttpCookie</a> getSessionCookie​(javax.servlet.http.HttpSession session, |
| java.lang.String contextPath, |
| boolean requestIsSecure)</pre> |
| <div class="block">A session cookie is marked as secure IFF any of the following conditions are true: |
| <ol> |
| <li>SessionCookieConfig.setSecure == true</li> |
| <li>SessionCookieConfig.setSecure == false && _secureRequestOnly==true && request is HTTPS</li> |
| </ol> |
| According to SessionCookieConfig javadoc, case 1 can be used when: |
| "... even though the request that initiated the session came over HTTP, |
| is to support a topology where the web container is front-ended by an |
| SSL offloading load balancer. In this case, the traffic between the client |
| and the load balancer will be over HTTPS, whereas the traffic between the |
| load balancer and the web container will be over HTTP." |
| <p> |
| For case 2, you can use _secureRequestOnly to determine if you want the |
| Servlet Spec 3.0 default behavior when SessionCookieConfig.setSecure==false, |
| which is: |
| <cite> |
| "they shall be marked as secure only if the request that initiated the |
| corresponding session was also secure" |
| </cite> |
| <p> |
| The default for _secureRequestOnly is true, which gives the above behavior. If |
| you set it to false, then a session cookie is NEVER marked as secure, even if |
| the initiating request was secure.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to which the cookie should refer.</dd> |
| <dd><code>contextPath</code> - the context to which the cookie should be linked. |
| The client will only send the cookie value when requesting resources under this path.</dd> |
| <dd><code>requestIsSecure</code> - whether the client is accessing the server over a secure protocol (i.e. HTTPS).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if this <code>SessionManager</code> uses cookies, then this method will return a new |
| <code>cookie object</code> that should be set on the client in order to link future HTTP requests |
| with the <code>session</code>. If cookies are not in use, this method returns <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionDomain()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionDomain</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("domain of the session cookie, or null for the default") |
| public java.lang.String getSessionDomain()</pre> |
| </li> |
| </ul> |
| <a id="getSessionsCreated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionsCreated</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("number of sessions created by this node") |
| public int getSessionsCreated()</pre> |
| </li> |
| </ul> |
| <a id="getSessionIdPathParameterName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionIdPathParameterName</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("name of use for URL session tracking") |
| public java.lang.String getSessionIdPathParameterName()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URL path parameter name for session id URL rewriting, by default "jsessionid".</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setSessionIdPathParameterName(java.lang.String)"><code>setSessionIdPathParameterName(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionIdPathParameterNamePrefix()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionIdPathParameterNamePrefix</h4> |
| <pre class="methodSignature">public java.lang.String getSessionIdPathParameterNamePrefix()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a formatted version of <a href="#getSessionIdPathParameterName()"><code>getSessionIdPathParameterName()</code></a>, by default |
| ";" + sessionIdParameterName + "=", for easier lookup in URL strings.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getSessionIdPathParameterName()"><code>getSessionIdPathParameterName()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isUsingCookies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUsingCookies</h4> |
| <pre class="methodSignature">public boolean isUsingCookies()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the session management is handled via cookies.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValid(javax.servlet.http.HttpSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre class="methodSignature">public boolean isValid​(javax.servlet.http.HttpSession session)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to test for validity</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the given session is valid, that is, it has not been invalidated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getId(javax.servlet.http.HttpSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature">public java.lang.String getId​(javax.servlet.http.HttpSession session)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unique id of the session within the cluster (without a node id extension)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExtendedId(javax.servlet.http.HttpSession)"><code>getExtendedId(HttpSession)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExtendedId(javax.servlet.http.HttpSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtendedId</h4> |
| <pre class="methodSignature">public java.lang.String getExtendedId​(javax.servlet.http.HttpSession session)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the unique id of the session within the cluster, extended with an optional node id.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getId(javax.servlet.http.HttpSession)"><code>getId(HttpSession)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newHttpSession(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newHttpSession</h4> |
| <pre class="methodSignature">public javax.servlet.http.HttpSession newHttpSession​(javax.servlet.http.HttpServletRequest request)</pre> |
| <div class="block">Creates a new <code>HttpSession</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the HttpServletRequest containing the requested session id</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new <code>HttpSession</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeEventListener(java.util.EventListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeEventListener</h4> |
| <pre class="methodSignature">public void removeEventListener​(java.util.EventListener listener)</pre> |
| <div class="block">Removes an event listener for for session-related events.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the session event listener to remove</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addEventListener(java.util.EventListener)"><code>addEventListener(EventListener)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="statsReset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>statsReset</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedOperation.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedOperation</a>(<a href="../../util/annotation/ManagedOperation.html#value()">value</a>="reset statistics", |
| <a href="../../util/annotation/ManagedOperation.html#impact()">impact</a>="ACTION") |
| public void statsReset()</pre> |
| <div class="block">Reset statistics values</div> |
| </li> |
| </ul> |
| <a id="setHttpOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHttpOnly</h4> |
| <pre class="methodSignature">public void setHttpOnly​(boolean httpOnly)</pre> |
| <div class="block">Set if Session cookies should use HTTP Only</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpOnly</code> - True if cookies should be HttpOnly.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../http/HttpCookie.html" title="class in org.eclipse.jetty.http"><code>HttpCookie</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSameSite(org.eclipse.jetty.http.HttpCookie.SameSite)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSameSite</h4> |
| <pre class="methodSignature">public void setSameSite​(<a href="../../http/HttpCookie.SameSite.html" title="enum in org.eclipse.jetty.http">HttpCookie.SameSite</a> sameSite)</pre> |
| <div class="block">Set Session cookie sameSite mode. |
| Currently this is encoded in the session comment until sameSite is supported by <code>SessionCookieConfig</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sameSite</code> - The sameSite setting for Session cookies (or null for no sameSite setting)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSessionIdManager(org.eclipse.jetty.server.SessionIdManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionIdManager</h4> |
| <pre class="methodSignature">public void setSessionIdManager​(<a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a> metaManager)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metaManager</code> - The metaManager used for cross context session management.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMaxInactiveInterval(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxInactiveInterval</h4> |
| <pre class="methodSignature">public void setMaxInactiveInterval​(int seconds)</pre> |
| <div class="block">Sets the max period of inactivity, after which the session is invalidated, in seconds.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>seconds</code> - the max inactivity period, in seconds.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getMaxInactiveInterval()"><code>getMaxInactiveInterval()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRefreshCookieAge(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRefreshCookieAge</h4> |
| <pre class="methodSignature">public void setRefreshCookieAge​(int ageInSeconds)</pre> |
| </li> |
| </ul> |
| <a id="setSessionCookie(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionCookie</h4> |
| <pre class="methodSignature">public void setSessionCookie​(java.lang.String cookieName)</pre> |
| </li> |
| </ul> |
| <a id="setSessionIdPathParameterName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionIdPathParameterName</h4> |
| <pre class="methodSignature">public void setSessionIdPathParameterName​(java.lang.String param)</pre> |
| <div class="block">Sets the session id URL path parameter name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>param</code> - the URL path parameter name for session id URL rewriting (null or "none" for no rewriting).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getSessionIdPathParameterName()"><code>getSessionIdPathParameterName()</code></a>, |
| <a href="#getSessionIdPathParameterNamePrefix()"><code>getSessionIdPathParameterNamePrefix()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUsingCookies(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsingCookies</h4> |
| <pre class="methodSignature">public void setUsingCookies​(boolean usingCookies)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>usingCookies</code> - The usingCookies to set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature">public <a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> getSession​(java.lang.String id)</pre> |
| <div class="block">Get a known existing session</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - The session ID stripped of any worker name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Session or null if none exists.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="shutdownSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdownSessions</h4> |
| <pre class="methodSignature">protected void shutdownSessions() |
| throws java.lang.Exception</pre> |
| <div class="block">Prepare sessions for session manager shutdown</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to shutdown sesssions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionCache</h4> |
| <pre class="methodSignature">public <a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a> getSessionCache()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the session store</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSessionCache(org.eclipse.jetty.server.session.SessionCache)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionCache</h4> |
| <pre class="methodSignature">public void setSessionCache​(<a href="SessionCache.html" title="interface in org.eclipse.jetty.server.session">SessionCache</a> cache)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cache</code> - the session store to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isNodeIdInSessionId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNodeIdInSessionId</h4> |
| <pre class="methodSignature">public boolean isNodeIdInSessionId()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the cluster node id (worker id) is returned as part of the session id by <code>HttpSession.getId()</code>. Default is false.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNodeIdInSessionId(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNodeIdInSessionId</h4> |
| <pre class="methodSignature">public void setNodeIdInSessionId​(boolean nodeIdInSessionId)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeIdInSessionId</code> - true if the cluster node id (worker id) will be returned as part of the session id by <code>HttpSession.getId()</code>. Default is false.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeSession(java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSession</h4> |
| <pre class="methodSignature">public <a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> removeSession​(java.lang.String id, |
| boolean invalidate)</pre> |
| <div class="block">Remove session from manager</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - The session to remove</dd> |
| <dd><code>invalidate</code> - True if <code>HttpSessionListener.sessionDestroyed(HttpSessionEvent)</code> and |
| <a href="../SessionIdManager.html#expireAll(java.lang.String)"><code>SessionIdManager.expireAll(String)</code></a> should be called.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>if the session was removed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionTimeMax()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionTimeMax</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("maximum amount of time sessions have remained active (in s)") |
| public long getSessionTimeMax()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum amount of time session remained valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefaultSessionTrackingModes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultSessionTrackingModes</h4> |
| <pre class="methodSignature">public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()</pre> |
| </li> |
| </ul> |
| <a id="getEffectiveSessionTrackingModes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEffectiveSessionTrackingModes</h4> |
| <pre class="methodSignature">public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()</pre> |
| </li> |
| </ul> |
| <a id="setSessionTrackingModes(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionTrackingModes</h4> |
| <pre class="methodSignature">public void setSessionTrackingModes​(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)</pre> |
| </li> |
| </ul> |
| <a id="isUsingURLs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUsingURLs</h4> |
| <pre class="methodSignature">public boolean isUsingURLs()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the session management is handled via URLs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionCookieConfig()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionCookieConfig</h4> |
| <pre class="methodSignature">public javax.servlet.SessionCookieConfig getSessionCookieConfig()</pre> |
| </li> |
| </ul> |
| <a id="getSessionTimeTotal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionTimeTotal</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("total time sessions have remained valid") |
| public long getSessionTimeTotal()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>total amount of time all sessions remained valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionTimeMean()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionTimeMean</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("mean time sessions remain valid (in s)") |
| public double getSessionTimeMean()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>mean amount of time session remained valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSessionTimeStdDev()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionTimeStdDev</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("standard deviation a session remained valid (in s)") |
| public double getSessionTimeStdDev()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>standard deviation of amount of time session remained valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCheckingRemoteSessionIdEncoding()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCheckingRemoteSessionIdEncoding</h4> |
| <pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>("check remote session id encoding") |
| public boolean isCheckingRemoteSessionIdEncoding()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if absolute URLs are check for remoteness before being session encoded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCheckingRemoteSessionIdEncoding(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCheckingRemoteSessionIdEncoding</h4> |
| <pre class="methodSignature">public void setCheckingRemoteSessionIdEncoding​(boolean remote)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remote</code> - True if absolute URLs are check for remoteness before being session encoded.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="renewSessionId(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renewSessionId</h4> |
| <pre class="methodSignature">public void renewSessionId​(java.lang.String oldId, |
| java.lang.String oldExtendedId, |
| java.lang.String newId, |
| java.lang.String newExtendedId)</pre> |
| <div class="block">Change the existing session id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oldId</code> - the old session id</dd> |
| <dd><code>oldExtendedId</code> - the session id including worker suffix</dd> |
| <dd><code>newId</code> - the new session id</dd> |
| <dd><code>newExtendedId</code> - the new session id including worker suffix</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="recordSessionTime(org.eclipse.jetty.server.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recordSessionTime</h4> |
| <pre class="methodSignature">protected void recordSessionTime​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</pre> |
| <div class="block">Record length of time session has been active. Called when the |
| session is about to be invalidated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session whose time to record</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invalidate(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidate</h4> |
| <pre class="methodSignature">public void invalidate​(java.lang.String id)</pre> |
| <div class="block">Called by SessionIdManager to remove a session that has been invalidated, |
| either by this context or another context. Also called by |
| SessionIdManager when a session has expired in either this context or |
| another context.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - the session id to invalidate</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="scavenge()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scavenge</h4> |
| <pre class="methodSignature">public void scavenge()</pre> |
| <div class="block">Called periodically by the HouseKeeper to handle the list of |
| sessions that have expired since the last call to scavenge.</div> |
| </li> |
| </ul> |
| <a id="sessionInactivityTimerExpired(org.eclipse.jetty.server.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessionInactivityTimerExpired</h4> |
| <pre class="methodSignature">@Deprecated |
| public void sessionInactivityTimerExpired​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#sessionInactivityTimerExpired(org.eclipse.jetty.server.session.Session,long)"><code>sessionInactivityTimerExpired(Session, long)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sessionInactivityTimerExpired(org.eclipse.jetty.server.session.Session,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessionInactivityTimerExpired</h4> |
| <pre class="methodSignature">public void sessionInactivityTimerExpired​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| long now)</pre> |
| <div class="block">Each session has a timer that is configured to go off |
| when either the session has not been accessed for a |
| configurable amount of time, or the session itself |
| has passed its expiry. |
| |
| If it has passed its expiry, then we will mark it for |
| scavenging by next run of the HouseKeeper; if it has |
| been idle longer than the configured eviction period, |
| we evict from the cache. |
| |
| If none of the above are true, then the System timer |
| is inconsistent and the caller of this method will |
| need to reset the timer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session</dd> |
| <dd><code>now</code> - the time at which to check for expiry</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isIdInUse(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIdInUse</h4> |
| <pre class="methodSignature">public boolean isIdInUse​(java.lang.String id) |
| throws java.lang.Exception</pre> |
| <div class="block">Check if id is in use by this context</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - identity of session to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this manager knows about this id</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if any error occurred</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getScheduler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduler</h4> |
| <pre class="methodSignature">public <a href="../../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a> getScheduler()</pre> |
| </li> |
| </ul> |
| <a id="getSessionCookieName(javax.servlet.SessionCookieConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionCookieName</h4> |
| <pre class="methodSignature">public static java.lang.String getSessionCookieName​(javax.servlet.SessionCookieConfig config)</pre> |
| </li> |
| </ul> |
| <a id="doSessionAttributeListeners(org.eclipse.jetty.server.session.Session,java.lang.String,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doSessionAttributeListeners</h4> |
| <pre class="methodSignature">public void doSessionAttributeListeners​(<a href="Session.html" title="class in org.eclipse.jetty.server.session">Session</a> session, |
| java.lang.String name, |
| java.lang.Object old, |
| java.lang.Object value)</pre> |
| </li> |
| </ul> |
| <a id="doScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doScope</h4> |
| <pre class="methodSignature">public void doScope​(java.lang.String target, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../handler/ScopedHandler.html#doScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">ScopedHandler</a></code></span></div> |
| <div class="block">Scope the handler |
| <p>Derived implementations should call <a href="../handler/ScopedHandler.html#nextScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"><code>ScopedHandler.nextScope(String, Request, HttpServletRequest, HttpServletResponse)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../handler/ScopedHandler.html#doScope(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doScope</a></code> in class <code><a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The target of the request - either a URI or a name.</dd> |
| <dd><code>baseRequest</code> - The original unwrapped request object.</dd> |
| <dd><code>request</code> - The request either as the <a href="../Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object or a wrapper of that request. The |
| <code><a href="../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../HttpChannel.html#getRequest()"><code>getRequest()</code></a></code> |
| method can be used access the Request object if required.</dd> |
| <dd><code>response</code> - The response as the <a href="../Response.html" title="class in org.eclipse.jetty.server"><code>Response</code></a> object or a wrapper of that request. The |
| <code><a href="../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../HttpChannel.html#getResponse()"><code>getResponse()</code></a></code> |
| method can be used access the Response object if required.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to handle the request or response processing</dd> |
| <dd><code>javax.servlet.ServletException</code> - if unable to handle the request or response due to underlying servlet issue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doHandle</h4> |
| <pre class="methodSignature">public void doHandle​(java.lang.String target, |
| <a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException, |
| javax.servlet.ServletException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../handler/ScopedHandler.html#doHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">ScopedHandler</a></code></span></div> |
| <div class="block">Do the handler work within the scope. |
| <p>Derived implementations should call <a href="../handler/ScopedHandler.html#nextHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"><code>ScopedHandler.nextHandle(String, Request, HttpServletRequest, HttpServletResponse)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../handler/ScopedHandler.html#doHandle(java.lang.String,org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">doHandle</a></code> in class <code><a href="../handler/ScopedHandler.html" title="class in org.eclipse.jetty.server.handler">ScopedHandler</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The target of the request - either a URI or a name.</dd> |
| <dd><code>baseRequest</code> - The original unwrapped request object.</dd> |
| <dd><code>request</code> - The request either as the <a href="../Request.html" title="class in org.eclipse.jetty.server"><code>Request</code></a> object or a wrapper of that request. The |
| <code><a href="../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../HttpChannel.html#getRequest()"><code>getRequest()</code></a></code> |
| method can be used access the Request object if required.</dd> |
| <dd><code>response</code> - The response as the <a href="../Response.html" title="class in org.eclipse.jetty.server"><code>Response</code></a> object or a wrapper of that request. The |
| <code><a href="../HttpConnection.html#getCurrentConnection()"><code>HttpConnection.getCurrentConnection()</code></a>.<a href="../HttpConnection.html#getHttpChannel()"><code>getHttpChannel()</code></a>.<a href="../HttpChannel.html#getResponse()"><code>getResponse()</code></a></code> |
| method can be used access the Response object if required.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to handle the request or response processing</dd> |
| <dd><code>javax.servlet.ServletException</code> - if unable to handle the request or response due to underlying servlet issue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkRequestedSessionId(org.eclipse.jetty.server.Request,javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRequestedSessionId</h4> |
| <pre class="methodSignature">protected void checkRequestedSessionId​(<a href="../Request.html" title="class in org.eclipse.jetty.server">Request</a> baseRequest, |
| javax.servlet.http.HttpServletRequest request)</pre> |
| <div class="block">Look for a requested session ID in cookies and URI parameters</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>baseRequest</code> - the request to check</dd> |
| <dd><code>request</code> - the request to check</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code> in class <code><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>Object.toString()</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/SessionHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |