2 // ========================================================================
3 // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
19 package org.eclipse.jetty.server.session;
21 import java.io.IOException;
22 import java.util.EnumSet;
23 import java.util.EventListener;
25 import javax.servlet.DispatcherType;
26 import javax.servlet.ServletException;
27 import javax.servlet.SessionTrackingMode;
28 import javax.servlet.http.Cookie;
29 import javax.servlet.http.HttpServletRequest;
30 import javax.servlet.http.HttpServletResponse;
31 import javax.servlet.http.HttpSession;
32 import javax.servlet.http.HttpSessionAttributeListener;
33 import javax.servlet.http.HttpSessionIdListener;
34 import javax.servlet.http.HttpSessionListener;
36 import org.eclipse.jetty.http.HttpCookie;
37 import org.eclipse.jetty.server.Request;
38 import org.eclipse.jetty.server.SessionManager;
39 import org.eclipse.jetty.server.handler.ScopedHandler;
40 import org.eclipse.jetty.util.log.Log;
41 import org.eclipse.jetty.util.log.Logger;
43 /* ------------------------------------------------------------ */
47 public class SessionHandler extends ScopedHandler
49 final static Logger LOG = Log.getLogger("org.eclipse.jetty.server.session");
51 public final static EnumSet<SessionTrackingMode> DEFAULT_TRACKING = EnumSet.of(SessionTrackingMode.COOKIE,SessionTrackingMode.URL);
53 public static final Class[] SESSION_LISTENER_TYPES = new Class[] {HttpSessionAttributeListener.class,
54 HttpSessionIdListener.class,
55 HttpSessionListener.class};
59 /* -------------------------------------------------------------- */
60 private SessionManager _sessionManager;
62 /* ------------------------------------------------------------ */
64 * Constructor. Construct a SessionHandler witha a HashSessionManager with a standard java.util.Random generator is created.
66 public SessionHandler()
68 this(new HashSessionManager());
71 /* ------------------------------------------------------------ */
76 public SessionHandler(SessionManager manager)
78 setSessionManager(manager);
81 /* ------------------------------------------------------------ */
83 * @return Returns the sessionManager.
85 public SessionManager getSessionManager()
87 return _sessionManager;
90 /* ------------------------------------------------------------ */
92 * @param sessionManager
93 * The sessionManager to set.
95 public void setSessionManager(SessionManager sessionManager)
98 throw new IllegalStateException();
99 if (sessionManager != null)
100 sessionManager.setSessionHandler(this);
101 updateBean(_sessionManager,sessionManager);
102 _sessionManager=sessionManager;
105 /* ------------------------------------------------------------ */
107 * @see org.eclipse.thread.AbstractLifeCycle#doStart()
110 protected void doStart() throws Exception
112 if (_sessionManager==null)
113 setSessionManager(new HashSessionManager());
117 /* ------------------------------------------------------------ */
119 * @see org.eclipse.thread.AbstractLifeCycle#doStop()
122 protected void doStop() throws Exception
124 // Destroy sessions before destroying servlets/filters see JETTY-1266
129 /* ------------------------------------------------------------ */
131 * @see org.eclipse.jetty.server.Handler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)
134 public void doScope(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
136 SessionManager old_session_manager = null;
137 HttpSession old_session = null;
138 HttpSession access = null;
141 old_session_manager = baseRequest.getSessionManager();
142 old_session = baseRequest.getSession(false);
144 if (old_session_manager != _sessionManager)
146 // new session context
147 baseRequest.setSessionManager(_sessionManager);
148 baseRequest.setSession(null);
149 checkRequestedSessionId(baseRequest,request);
152 // access any existing session
153 HttpSession session = null;
154 if (_sessionManager != null)
156 session = baseRequest.getSession(false);
159 if (session != old_session)
162 HttpCookie cookie = _sessionManager.access(session,request.isSecure());
163 if (cookie != null) // Handle changed ID or max-age refresh
164 baseRequest.getResponse().addCookie(cookie);
169 session = baseRequest.recoverNewSession(_sessionManager);
171 baseRequest.setSession(session);
175 if (LOG.isDebugEnabled())
177 LOG.debug("sessionManager=" + _sessionManager);
178 LOG.debug("session=" + session);
181 // start manual inline of nextScope(target,baseRequest,request,response);
182 if (_nextScope != null)
183 _nextScope.doScope(target,baseRequest,request,response);
184 else if (_outerScope != null)
185 _outerScope.doHandle(target,baseRequest,request,response);
187 doHandle(target,baseRequest,request,response);
188 // end manual inline (pathentic attempt to reduce stack depth)
194 _sessionManager.complete(access);
196 HttpSession session = baseRequest.getSession(false);
197 if (session != null && old_session == null && session != access)
198 _sessionManager.complete(session);
200 if (old_session_manager != null && old_session_manager != _sessionManager)
202 baseRequest.setSessionManager(old_session_manager);
203 baseRequest.setSession(old_session);
208 /* ------------------------------------------------------------ */
210 * @see org.eclipse.jetty.server.Handler#handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)
213 public void doHandle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
215 // start manual inline of nextHandle(target,baseRequest,request,response);
217 nextHandle(target,baseRequest,request,response);
218 else if (_nextScope != null && _nextScope == _handler)
219 _nextScope.doHandle(target,baseRequest,request,response);
220 else if (_handler != null)
221 _handler.handle(target,baseRequest,request,response);
225 /* ------------------------------------------------------------ */
227 * Look for a requested session ID in cookies and URI parameters
232 protected void checkRequestedSessionId(Request baseRequest, HttpServletRequest request)
234 String requested_session_id = request.getRequestedSessionId();
236 SessionManager sessionManager = getSessionManager();
238 if (requested_session_id != null && sessionManager != null)
240 HttpSession session = sessionManager.getHttpSession(requested_session_id);
241 if (session != null && sessionManager.isValid(session))
242 baseRequest.setSession(session);
245 else if (!DispatcherType.REQUEST.equals(baseRequest.getDispatcherType()))
248 boolean requested_session_id_from_cookie = false;
249 HttpSession session = null;
251 // Look for session id cookie
252 if (_sessionManager.isUsingCookies())
254 Cookie[] cookies = request.getCookies();
255 if (cookies != null && cookies.length > 0)
257 final String sessionCookie=sessionManager.getSessionCookieConfig().getName();
258 for (int i = 0; i < cookies.length; i++)
260 if (sessionCookie.equalsIgnoreCase(cookies[i].getName()))
262 requested_session_id = cookies[i].getValue();
263 requested_session_id_from_cookie = true;
265 LOG.debug("Got Session ID {} from cookie",requested_session_id);
267 if (requested_session_id != null)
269 session = sessionManager.getHttpSession(requested_session_id);
271 if (session != null && sessionManager.isValid(session))
278 LOG.warn("null session id from cookie");
285 if (requested_session_id == null || session == null)
287 String uri = request.getRequestURI();
289 String prefix = sessionManager.getSessionIdPathParameterNamePrefix();
292 int s = uri.indexOf(prefix);
295 s += prefix.length();
297 while (i < uri.length())
299 char c = uri.charAt(i);
300 if (c == ';' || c == '#' || c == '?' || c == '/')
305 requested_session_id = uri.substring(s,i);
306 requested_session_id_from_cookie = false;
307 session = sessionManager.getHttpSession(requested_session_id);
308 if (LOG.isDebugEnabled())
309 LOG.debug("Got Session ID {} from URL",requested_session_id);
314 baseRequest.setRequestedSessionId(requested_session_id);
315 baseRequest.setRequestedSessionIdFromCookie(requested_session_id!=null && requested_session_id_from_cookie);
316 if (session != null && sessionManager.isValid(session))
317 baseRequest.setSession(session);
320 /* ------------------------------------------------------------ */
324 public void addEventListener(EventListener listener)
326 if (_sessionManager != null)
327 _sessionManager.addEventListener(listener);
330 /* ------------------------------------------------------------ */
334 public void removeEventListener(EventListener listener)
336 if (_sessionManager != null)
337 _sessionManager.removeEventListener(listener);
340 /* ------------------------------------------------------------ */
341 public void clearEventListeners()
343 if (_sessionManager != null)
344 _sessionManager.clearEventListeners();