| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>DefaultSessionIdManager (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.server.session, class: DefaultSessionIdManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/DefaultSessionIdManager.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.server.session</a></div> |
| <h1 title="Class DefaultSessionIdManager" class="title">Class DefaultSessionIdManager</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a> |
| <div class="inheritance"><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a> |
| <div class="inheritance">org.eclipse.jetty.server.session.DefaultSessionIdManager</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</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> |
| <div class="type-signature"><span class="annotations"><a href="../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a> |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultSessionIdManager</span> |
| <span class="extends-implements">extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></span></div> |
| <div class="block">DefaultSessionIdManager |
| |
| Manages session ids to ensure each session id within a context is unique, and that |
| session ids can be shared across contexts (but not session contents). |
| |
| There is only 1 session id manager per Server instance. |
| |
| Runs a HouseKeeper thread to periodically check for expired Sessions.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session"><code>HouseKeeper</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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></h2> |
| <code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Container">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></h2> |
| <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></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></h2> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.LifeCycle">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></h2> |
| <code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#__NEW_SESSION_ID" class="member-name-link">__NEW_SESSION_ID</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_houseKeeper" class="member-name-link">_houseKeeper</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#_ownHouseKeeper" class="member-name-link">_ownHouseKeeper</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_random" class="member-name-link">_random</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#_reseed" class="member-name-link">_reseed</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_server" class="member-name-link">_server</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#_weakRandom" class="member-name-link">_weakRandom</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#_workerAttr" class="member-name-link">_workerAttr</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#_workerName" class="member-name-link">_workerName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#COUNTER" class="member-name-link">COUNTER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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#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></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.server.Server)" class="member-name-link">DefaultSessionIdManager</a><wbr>(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.server.Server,java.util.Random)" class="member-name-link">DefaultSessionIdManager</a><wbr>(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doStart()" class="member-name-link">doStart</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts the managed lifecycle beans in the order they were added.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doStop()" class="member-name-link">doStop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expireAll(java.lang.String)" class="member-name-link">expireAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove an id from use by telling all contexts to remove a session with this id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExtendedId(java.lang.String,javax.servlet.http.HttpServletRequest)" class="member-name-link">getExtendedId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> clusterId, |
| javax.servlet.http.HttpServletRequest request)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the session ID with any worker ID.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId(java.lang.String)" class="member-name-link">getId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> extendedId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the session ID without any worker ID.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRandom()" class="member-name-link">getRandom</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReseed()" class="member-name-link">getReseed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServer()" class="member-name-link">getServer</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSessionHandlers()" class="member-name-link">getSessionHandlers</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get SessionHandler for every context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSessionHouseKeeper()" class="member-name-link">getSessionHouseKeeper</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWorkerName()" class="member-name-link">getWorkerName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the workname.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initRandom()" class="member-name-link">initRandom</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set up a random number generator for the sessionids.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#invalidateAll(java.lang.String)" class="member-name-link">invalidateAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invalidate all sessions on all contexts that share the same id.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIdInUse(java.lang.String)" class="member-name-link">isIdInUse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newSessionId(long)" class="member-name-link">newSessionId</a><wbr>(long seedTerm)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newSessionId(javax.servlet.http.HttpServletRequest,long)" class="member-name-link">newSessionId</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| long created)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a new session id if necessary.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#renewSessionId(java.lang.String,java.lang.String,javax.servlet.http.HttpServletRequest)" class="member-name-link">renewSessionId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> oldClusterId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> oldNodeId, |
| javax.servlet.http.HttpServletRequest request)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Generate a new id for a session and update across |
| all SessionManagers.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRandom(java.util.Random)" class="member-name-link">setRandom</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReseed(long)" class="member-name-link">setReseed</a><wbr>(long reseed)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the reseed probability.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setServer(org.eclipse.jetty.server.Server)" class="member-name-link">setServer</a><wbr>(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSessionHouseKeeper(org.eclipse.jetty.server.session.HouseKeeper)" class="member-name-link">setSessionHouseKeeper</a><wbr>(<a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a> houseKeeper)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setWorkerName(java.lang.String)" class="member-name-link">setWorkerName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the workername.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.ContainerLifeCycle">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(java.util.EventListener)">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#destroy()">destroy</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#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#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(java.util.EventListener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</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>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.util.Collection,java.util.Collection)">updateBeans</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.AbstractLifeCycle">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#getEventListeners()">getEventListeners</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#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#setEventListeners(java.util.Collection)">setEventListeners</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Container">Methods 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.html#getCachedBeans(java.lang.Class)">getCachedBeans</a>, <a href="../../util/component/Container.html#getEventListeners()">getEventListeners</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable.DumpableContainer">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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.LifeCycle">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#addEventListener(java.util.EventListener)">addEventListener</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#removeEventListener(java.util.EventListener)">removeEventListener</a>, <a href="../../util/component/LifeCycle.html#start()">start</a>, <a href="../../util/component/LifeCycle.html#stop()">stop</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="__NEW_SESSION_ID"> |
| <h3>__NEW_SESSION_ID</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">__NEW_SESSION_ID</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.eclipse.jetty.server.session.DefaultSessionIdManager.__NEW_SESSION_ID">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COUNTER"> |
| <h3>COUNTER</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a></span> <span class="element-name">COUNTER</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_random"> |
| <h3>_random</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></span> <span class="element-name">_random</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_weakRandom"> |
| <h3>_weakRandom</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">_weakRandom</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_workerName"> |
| <h3>_workerName</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">_workerName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_workerAttr"> |
| <h3>_workerAttr</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">_workerAttr</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_reseed"> |
| <h3>_reseed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">_reseed</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_server"> |
| <h3>_server</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a></span> <span class="element-name">_server</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_houseKeeper"> |
| <h3>_houseKeeper</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a></span> <span class="element-name">_houseKeeper</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="_ownHouseKeeper"> |
| <h3>_ownHouseKeeper</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">_ownHouseKeeper</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.server.Server)"> |
| <h3>DefaultSessionIdManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultSessionIdManager</span><wbr><span class="parameters">(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>server</code> - the server associated with the id manager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.server.Server,java.util.Random)"> |
| <h3>DefaultSessionIdManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultSessionIdManager</span><wbr><span class="parameters">(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>server</code> - the server associated with the id manager</dd> |
| <dd><code>random</code> - a random number generator to use for ids</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setServer(org.eclipse.jetty.server.Server)"> |
| <h3>setServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setServer</span><wbr><span class="parameters">(<a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a> server)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>server</code> - the server associated with this id manager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServer()"> |
| <h3>getServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Server.html" title="class in org.eclipse.jetty.server">Server</a></span> <span class="element-name">getServer</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the server associated with this id manager</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSessionHouseKeeper(org.eclipse.jetty.server.session.HouseKeeper)"> |
| <h3>setSessionHouseKeeper</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSessionHouseKeeper</span><wbr><span class="parameters">(<a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a> houseKeeper)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#setSessionHouseKeeper(org.eclipse.jetty.server.session.HouseKeeper)">setSessionHouseKeeper</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>houseKeeper</code> - the housekeeper</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSessionHouseKeeper()"> |
| <h3>getSessionHouseKeeper</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HouseKeeper.html" title="class in org.eclipse.jetty.server.session">HouseKeeper</a></span> <span class="element-name">getSessionHouseKeeper</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#getSessionHouseKeeper()">getSessionHouseKeeper</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the housekeeper</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerName()"> |
| <h3>getWorkerName</h3> |
| <div class="member-signature"><span class="annotations"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../util/annotation/ManagedAttribute.html#value()">value</a>="unique name for this node", |
| <a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true) |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getWorkerName</span>()</div> |
| <div class="block">Get the workname. If set, the workername is dot appended to the session |
| ID and can be used to assist session affinity in a load balancer.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#getWorkerName()">getWorkerName</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>name or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setWorkerName(java.lang.String)"> |
| <h3>setWorkerName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWorkerName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerName)</span></div> |
| <div class="block">Set the workername. If set, the workername is dot appended to the session |
| ID and can be used to assist session affinity in a load balancer. |
| A worker name starting with $ is used as a request attribute name to |
| lookup the worker name that can be dynamically set by a request |
| Customizer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workerName</code> - the name of the worker, if null it is coerced to empty string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRandom()"> |
| <h3>getRandom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></span> <span class="element-name">getRandom</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the random number generator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRandom(java.util.Random)"> |
| <h3>setRandom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRandom</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a> random)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>random</code> - a random number generator for generating ids</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReseed()"> |
| <h3>getReseed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getReseed</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the reseed probability</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReseed(long)"> |
| <h3>setReseed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReseed</span><wbr><span class="parameters">(long reseed)</span></div> |
| <div class="block">Set the reseed probability.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>reseed</code> - If non zero then when a random long modulo the reseed value == 1, the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/SecureRandom.html" title="class or interface in java.security" class="external-link"><code>SecureRandom</code></a> will be reseeded.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newSessionId(javax.servlet.http.HttpServletRequest,long)"> |
| <h3>newSessionId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">newSessionId</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| long created)</span></div> |
| <div class="block">Create a new session id if necessary.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#newSessionId(javax.servlet.http.HttpServletRequest,long)">newSessionId</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the request with the sesion</dd> |
| <dd><code>created</code> - the timestamp for when the session was created</dd> |
| <dt>Returns:</dt> |
| <dd>the new session id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newSessionId(long)"> |
| <h3>newSessionId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">newSessionId</span><wbr><span class="parameters">(long seedTerm)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>seedTerm</code> - the seed for RNG</dd> |
| <dt>Returns:</dt> |
| <dd>a new unique session id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIdInUse(java.lang.String)"> |
| <h3>isIdInUse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isIdInUse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#isIdInUse(java.lang.String)">isIdInUse</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The plain session ID (ie no workername extension)</dd> |
| <dt>Returns:</dt> |
| <dd>True if the session ID is in use by at least one context.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doStart()"> |
| <h3>doStart</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doStart</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStart()">doStart</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../../util/component/AbstractLifeCycle.StopException.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.StopException</a></code> - If thrown, the lifecycle will immediately be stopped.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - If there was a problem starting. Will cause a transition to FAILED state</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doStop()"> |
| <h3>doStop</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doStop</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../util/component/ContainerLifeCycle.html#doStop()">doStop</a></code> in class <code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - If there was a problem stopping. Will cause a transition to FAILED state</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initRandom()"> |
| <h3>initRandom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initRandom</span>()</div> |
| <div class="block">Set up a random number generator for the sessionids. |
| |
| By preference, use a SecureRandom but allow to be injected.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExtendedId(java.lang.String,javax.servlet.http.HttpServletRequest)"> |
| <h3>getExtendedId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getExtendedId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> clusterId, |
| javax.servlet.http.HttpServletRequest request)</span></div> |
| <div class="block">Get the session ID with any worker ID.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#getExtendedId(java.lang.String,javax.servlet.http.HttpServletRequest)">getExtendedId</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>clusterId</code> - the cluster id</dd> |
| <dd><code>request</code> - the request</dd> |
| <dt>Returns:</dt> |
| <dd>sessionId plus any worker ID.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getId(java.lang.String)"> |
| <h3>getId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> extendedId)</span></div> |
| <div class="block">Get the session ID without any worker ID.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#getId(java.lang.String)">getId</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>extendedId</code> - the session id with the worker extension</dd> |
| <dt>Returns:</dt> |
| <dd>sessionId without any worker ID.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="expireAll(java.lang.String)"> |
| <h3>expireAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">expireAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</span></div> |
| <div class="block">Remove an id from use by telling all contexts to remove a session with this id.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#expireAll(java.lang.String)">expireAll</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - The session ID without any cluster node extension</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../SessionIdManager.html#expireAll(java.lang.String)"><code>SessionIdManager.expireAll(java.lang.String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="invalidateAll(java.lang.String)"> |
| <h3>invalidateAll</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">invalidateAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> id)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SessionIdManager.html#invalidateAll(java.lang.String)">SessionIdManager</a></code></span></div> |
| <div class="block">Invalidate all sessions on all contexts that share the same id.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#invalidateAll(java.lang.String)">invalidateAll</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - the session id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="renewSessionId(java.lang.String,java.lang.String,javax.servlet.http.HttpServletRequest)"> |
| <h3>renewSessionId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">renewSessionId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> oldClusterId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> oldNodeId, |
| javax.servlet.http.HttpServletRequest request)</span></div> |
| <div class="block">Generate a new id for a session and update across |
| all SessionManagers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#renewSessionId(java.lang.String,java.lang.String,javax.servlet.http.HttpServletRequest)">renewSessionId</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>oldClusterId</code> - the old plain session id</dd> |
| <dd><code>oldNodeId</code> - the old fully qualified id</dd> |
| <dd><code>request</code> - the request containing the session</dd> |
| <dt>Returns:</dt> |
| <dd>the new session id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSessionHandlers()"> |
| <h3>getSessionHandlers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="SessionHandler.html" title="class in org.eclipse.jetty.server.session">SessionHandler</a>></span> <span class="element-name">getSessionHandlers</span>()</div> |
| <div class="block">Get SessionHandler for every context.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SessionIdManager.html#getSessionHandlers()">getSessionHandlers</a></code> in interface <code><a href="../SessionIdManager.html" title="interface in org.eclipse.jetty.server">SessionIdManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>all SessionHandlers that are running</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</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> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |