| <html><head> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <title>Using Persistent Sessions</title><link rel="stylesheet" type="text/css" href="css/docbook.css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"><meta name="keywords" content="jetty, servlet, servlet-api, cometd, http, spdy, websocket, eclipse, maven, java, server, software"><link rel="home" href="index.html" title="Jetty : The Definitive Reference"><link rel="up" href="session-management.html" title="Chapter 10. Session Management"><link rel="prev" href="session-management.html" title="Chapter 10. Session Management"><link rel="next" href="session-clustering-jdbc.html" title="Session Clustering with a Database"><link xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" rel="shortcut icon" href="images/favicon.ico"><script type="text/javascript" src="js/shCore.js"></script><script type="text/javascript" src="js/shBrushJava.js"></script><script type="text/javascript" src="js/shBrushXml.js"></script><script type="text/javascript" src="js/shBrushBash.js"></script><script type="text/javascript" src="js/shBrushJScript.js"></script><script type="text/javascript" src="js/shBrushSql.js"></script><script type="text/javascript" src="js/shBrushProperties.js"></script><script type="text/javascript" src="js/shBrushPlain.js"></script><link type="text/css" rel="stylesheet" href="css/shCore.css"><link type="text/css" rel="stylesheet" href="css/shThemeEclipse.css"><link type="text/css" rel="stylesheet" href="css/font-awesome.min.css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><tr><td style="width: 25%"><a href="http://www.eclipse.org/jetty"><img src="images/jetty-header-logo.png" alt="Jetty Logo"></a><br><span style="font-size: small"> |
| Version: 9.2.21.v20170120</span></td><td style="width: 50%"><script type="text/javascript"> (function() { |
| var cx = '016459005284625897022:obd4lsai2ds'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//www.google.com/cse/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script><gcse:search></gcse:search></td></tr></table><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Using Persistent Sessions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="session-management.html"><i class="icon-chevron-left"></i> Previous</a> </td><th width="60%" align="center">Chapter 10. Session Management<br><a accesskey="p" href="index.html"><i class="icon-home"></i> Home</a></th><td width="20%" align="right"> <a accesskey="n" href="session-clustering-jdbc.html">Next <i class="icon-chevron-right"></i></a></td></tr></table><hr></div><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="jetty-callout"><h5 class="callout"><a href="http://www.webtide.com/">Contact the core Jetty developers at |
| <span class="website">www.webtide.com</span></a></h5><p> |
| private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... |
| scalability guidance for your apps and Ajax/Comet projects ... development services from 1 day to full product delivery |
| </p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="using-persistent-sessions"></a>Using Persistent Sessions</h2></div></div></div><div class="toc"><dl><dt><span class="section"><a href="using-persistent-sessions.html#enabling-persistence">Enabling Persistence</a></span></dt><dt><span class="section"><a href="using-persistent-sessions.html#delaying-session-load">Delaying Session Load</a></span></dt><dt><span class="section"><a href="using-persistent-sessions.html#enabling-persistence-for-jetty-maven-plugin">Enabling Persistence for the Jetty Maven Plugin</a></span></dt></dl></div><p>It is sometimes useful to preserve existing Sessions across restarts |
| of Jetty. The <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/server/session/HashSessionManager.html" target="_top"> |
| <code class="code">HashSessionManager</code> </a> supports this feature. If you enable |
| persistence, the <code class="code">HashSessionManager</code> saves all existing, valid |
| Sessions to disk before shutdown completes. On restart, Jetty restores the |
| saved Sessions.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="enabling-persistence"></a>Enabling Persistence</h3></div></div></div><p>A SessionManager does just what its name suggests–it manages the |
| lifecycle and state of sessions on behalf of a webapp. Each webapp must |
| have its own unique SessionManager instance. Enabling persistence is as |
| simple as configuring the <code class="code">HashSessionManager</code> as the |
| SessionManager for a webapp and telling it where on disk to store the |
| sessions:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[ |
| |
| <Configure class="org.eclipse.jetty.webapp.WebAppContext"> |
| . |
| . |
| . |
| <Set name="sessionHandler"> |
| <New class="org.eclipse.jetty.server.session.SessionHandler"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.session.HashSessionManager"> |
| <Set name="storeDirectory">your/chosen/directory/goes/here</Set> |
| </New> |
| </Arg> |
| </New> |
| </Set> |
| . |
| . |
| . |
| </Configure> |
| |
| ]]> |
| </script></div><div xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><i class="icon-lightbulb"></i> Tip</h3><p>If you want to persist the sessions from multiple webapps: |
| </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>Configure a separate HashSessionManager for each.</p></li><li class="listitem"><p>Assign to each a different value for 'storeDirectory'.</p></li></ol></div></div><p>The above example uses a configuration file suitable for the <a class="link" href="http://download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/deploy/providers/ContextProvider.html" target="_top">ContextProvider</a>, |
| thus you might want to check out <a class="xref" href="">???</a>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="delaying-session-load"></a>Delaying Session Load</h3></div></div></div><p>You might need to ensure that the sessions are loaded AFTER the |
| servlet environment starts up (by default, Jetty eagerly loads sessions as |
| part of the container startup, but before it initializes the servlet |
| environment). For example, the Wicket web framework requires the servlet |
| environment to be available when sessions are activated.</p><p>Using <code class="code">SessionManager.setLazyLoad(true)</code>, Jetty loads |
| sessions lazily either when it receives the first request for a session, |
| or the session scavenger runs for the first time, whichever happens first. |
| Here's how the configuration looks in XML:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<Set name="sessionHandler"> |
| <New class="org.eclipse.jetty.server.session.SessionHandler"> |
| <Arg> |
| <New class="org.eclipse.jetty.server.session.HashSessionManager"> |
| <Set name="lazyLoad">true</Set> |
| </New> |
| </Arg> |
| </New> |
| </Set> ]]> |
| </script></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="enabling-persistence-for-jetty-maven-plugin"></a>Enabling Persistence for the Jetty Maven Plugin</h3></div></div></div><p>To enable session persistence for the Jetty Maven plugin, set up the |
| HashSessionManager in the configuration section like so:</p><div class="informalexample"><script type="syntaxhighlighter" class="brush: xml;toolbar: false"> |
| <![CDATA[<plugin> |
| <groupId>org.eclipse.jetty</groupId> |
| <artifactId>jetty-maven-plugin</artifactId> |
| <version>9.0.0.RC2 (or current version)</version> |
| <configuration> |
| <!-- ... --> |
| <webAppConfig implementation="org.eclipse.jetty.maven.plugin.JettyWebAppContext"> |
| <defaultsDescriptor>${project.build.outputDirectory}/META-INF/webdefault.xml</defaultsDescriptor> |
| <contextPath>${jetty.contextRoot}</contextPath> |
| <sessionHandler implementation="org.eclipse.jetty.server.session.SessionHandler"> |
| <sessionManager implementation="org.eclipse.jetty.server.session.HashSessionManager"> |
| <storeDirectory>${project.basedir}/target/jetty-sessions</storeDirectory> |
| <idleSavePeriod>1</idleSavePeriod> |
| </sessionManager> |
| </sessionHandler> |
| </webAppConfig> |
| <!-- ... --> |
| </configuration> |
| </plugin> ]]> |
| </script></div></div></div><script type="text/javascript"> |
| SyntaxHighlighter.all() |
| </script><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="session-management.html"><i class="icon-chevron-left"></i> Previous</a> </td><td width="20%" align="center"><a accesskey="u" href="session-management.html"><i class="icon-chevron-up"></i> Top</a></td><td width="40%" align="right"> <a accesskey="n" href="session-clustering-jdbc.html">Next <i class="icon-chevron-right"></i></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 10. Session Management </td><td width="20%" align="center"><a accesskey="h" href="index.html"><i class="icon-home"></i> Home</a></td><td width="40%" align="right" valign="top"> Session Clustering with a Database</td></tr></table></div><p xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times"><div class="jetty-callout"> |
| See an error or something missing? |
| <span class="callout"><a href="http://github.com/jetty-project/jetty-documentation">Contribute to this documentation at |
| <span class="website"><i class="icon-github"></i> Github!</span></a></span><span style="float: right"><i>(Generated: 2015-03-13T11:47:51-05:00)</i></span></div></p><script xmlns:jfetch="java:org.eclipse.jetty.xslt.tools.JavaSourceFetchExtension" xmlns:fetch="java:org.eclipse.jetty.xslt.tools.SourceFetchExtension" xmlns:d="http://docbook.org/ns/docbook" xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" xmlns:xslthl="http://xslthl.sf.net" xmlns:gcse="http://www.google.com" xmlns:date="http://exslt.org/dates-and-times" type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-1149868-7']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script></body></html> |
