/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* SessionLockingStandardPipeline.java
*
* Created on January 21, 2003, 4:14 PM
*/
package com.sun.enterprise.ee.web.sessmgmt;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.ServletRequest;
import javax.servlet.ServletRequestWrapper;
import javax.servlet.http.HttpSession;
import java.util.Enumeration;
import java.util.logging.Logger;
import java.util.logging.Level;
import com.sun.logging.LogDomains;
import org.apache.catalina.Context;
import org.apache.catalina.Manager;
import org.apache.catalina.Container;
import org.apache.catalina.Request;
import org.apache.catalina.Response;
import org.apache.catalina.Valve;
import org.apache.catalina.Manager;
import org.apache.catalina.session.PersistentManagerBase;
import org.apache.catalina.session.StandardManager;
import org.apache.catalina.Session;
import org.apache.catalina.session.StandardSession;
import org.apache.catalina.core.StandardPipeline;
import org.apache.coyote.tomcat5.CoyoteRequest;
import org.apache.coyote.tomcat5.CoyoteRequestFacade;
import com.sun.enterprise.web.PESessionLockingStandardPipeline;
import com.sun.enterprise.ee.web.initialization.ServerConfigReader;
import com.sun.enterprise.ee.web.sessmgmt.HASession;
import com.sun.enterprise.ee.web.sessmgmt.ReplicationManagerBase;
import com.sun.enterprise.ee.web.sessmgmt.WebModuleStatistics;
/**
*
* @author lwhite
*/
public class SessionLockingStandardPipeline extends PESessionLockingStandardPipeline {
static final String PROXY_JROUTE_NAME = "proxy-jroute";
static final String JROUTE_NAME = "JROUTE";
/**
* creates an instance of SessionLockingStandardPipeline
* @param container
*/
public SessionLockingStandardPipeline(Container container) {
super(container);
}
/**
* Cause the specified request and response to be processed by the Valves
* associated with this pipeline, until one of these valves causes the
* response to be created and returned. The implementation must ensure
* that multiple simultaneous requests (on different threads) can be
* processed through the same Pipeline without interfering with each
* other's control flow.
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception is thrown
*/
public void invoke(Request request, Response response)
throws IOException, ServletException {
boolean isMonitoringEnabled = ServerConfigReader.isMonitoringEnabled();
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("entering NEW SessionLockingStandardPipeline>>invoke");
}
long startTime = 0L;
if (isMonitoringEnabled) {
startTime = System.currentTimeMillis();
}
//locking and unlocking occurs in the superclass invoke now, not here
//this.lockSession(request);
try {
super.invoke(request, response);
} finally {
//locking and unlocking occurs in the superclass invoke now, not here
//this.unlockSession(request);
if (isMonitoringEnabled) {
long endTime = System.currentTimeMillis();
long elapsedTime = (endTime - startTime);
WebModuleStatistics stats = this.getWebModuleStatistics();
if(stats != null) {
stats.processPipeline(elapsedTime);
}
}
}
}
/**
* get the WebModuleStatistics
*/
WebModuleStatistics getWebModuleStatistics() {
WebModuleStatistics stats = null;
Context ctx = (Context) this.getContainer();
Manager mgr = ctx.getManager();
if( !(mgr instanceof StandardManager) ) {
PersistentManagerBase haMgr = (PersistentManagerBase) mgr;
stats = (WebModuleStatistics)haMgr.getWebModuleStatistics();
}
return stats;
}
/**
* lock the session associated with this request
* this will be a foreground lock
* checks for background lock to clear
* and does a decay poll loop to wait until
* it is clear; after 5 times it takes control for
* the foreground
*
* @param request
*
* @return the session that's been locked
*/
protected Session lockSession(Request request) throws ServletException {
Session sess = this.getSession(request, true);
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("IN LOCK_SESSION: sess =" + sess);
}
if(sess != null) {
StandardSession haSess = (StandardSession) sess;
haSess.lockForegroundWithRetry();
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("finished locking session: sess =" + haSess);
_logger.finest("LOCK = " + haSess.getSessionLock());
}
}
return sess;
}
/**
* get the session associated with this request
* @param request
* @param forLock true if locking false otherwise
*/
private Session getSession(Request request, boolean forLock) {
ServletRequest servletReq = request.getRequest();
HttpServletRequest httpReq =
(HttpServletRequest) servletReq;
HttpSession httpSess = httpReq.getSession(false);
if(httpSess == null)
//need to null out session
//httpReq.setSession(null);
return null;
String id = httpSess.getId();
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("SESSION_ID=" + id);
}
Manager mgr = this.getContainer().getManager();
PersistentManagerBase pmb = (PersistentManagerBase)mgr;
Session sess = null;
try {
//if failover occurred - cached session will be removed
//and session retrieved from store (if it exists)
if(forLock) {
//for lock if failover, purge cache and force re-load
sess = pmb.findSession(id, hasFailoverOccurred(request));
resetSession((HttpServletRequest)servletReq, sess);
} else {
//for unlock do not purge cache and force re-load
sess = pmb.findSession(id, false);
}
} catch (java.io.IOException ex) {}
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("RETRIEVED_SESSION=" + sess);
}
return sess;
}
private void resetSession(HttpServletRequest servletReq,
Session sess) {
CoyoteRequest coyoteRequest = this.getCoyoteRequest(servletReq);
coyoteRequest.setSession(sess);
}
/**
* Finds and returns the underlying/original request object.
*
* (Doing instanceof in a loop will impact performance)
*/
private CoyoteRequest getCoyoteRequest(ServletRequest request) {
CoyoteRequest coyoteRequest = null;
Object current = request;
while (current != null) {
// When we run into the original request object, return it
if (current instanceof CoyoteRequestFacade) {
coyoteRequest = ((CoyoteRequestFacade)current).getUnwrappedCoyoteRequest();
break;
} else if (current instanceof ServletRequestWrapper) {
current = ((ServletRequestWrapper) current).getRequest();
} else
break;
}
return coyoteRequest;
}
/**
* return true if this is the first request to a new
* instance after a fail-over
*/
private boolean hasFailoverOccurred(Request request) {
String jrouteId = request.getJrouteId();
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("in hasFailoverOccurred: jrouteId = " + jrouteId);
}
if(jrouteId == null) {
return false;
}
HttpServletRequest httpReq = (HttpServletRequest) request.getRequest();
Enumeration headers = httpReq.getHeaders(PROXY_JROUTE_NAME);
String proxyJRouteValue = null;
while(headers.hasMoreElements()) {
proxyJRouteValue = (String) headers.nextElement();
break;
}
if(_logger.isLoggable(Level.FINEST)) {
_logger.finest("in hasFailoverOccurred: proxyJRouteValue = " + proxyJRouteValue);
}
if(proxyJRouteValue == null) {
return false;
}
return !proxyJRouteValue.equalsIgnoreCase(jrouteId);
}
}