framework/webapp/src/org/ofbiz/webapp/control/ControlServlet.java - ofbiz - Git at Google

 /*******************************************************************************
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  *******************************************************************************/
 package org.ofbiz.webapp.control;

 import javax.servlet.RequestDispatcher;
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpSession;
 import java.io.IOException;
 import java.util.Enumeration;

 import org.apache.bsf.BSFManager;

 import org.ofbiz.service.ThreadContext;
 import org.ofbiz.base.util.Debug;
 import org.ofbiz.base.util.UtilHttp;
 import org.ofbiz.base.util.UtilJ2eeCompat;
 import org.ofbiz.base.util.UtilTimer;
 import org.ofbiz.base.util.UtilValidate;
 import org.ofbiz.entity.DelegatorFactory;
 import org.ofbiz.entity.GenericDelegator;
 import org.ofbiz.entity.GenericValue;
 import org.ofbiz.entity.transaction.GenericTransactionException;
 import org.ofbiz.entity.transaction.TransactionUtil;
 import org.ofbiz.api.authorization.AuthorizationManager;
 import org.ofbiz.security.authz.Authorization;
 import org.ofbiz.service.LocalDispatcher;
 import org.ofbiz.webapp.stats.ServerHitBin;
 import org.ofbiz.webapp.stats.VisitHandler;

 /**
  * ControlServlet.java - Master servlet for the web application.
  */
 @SuppressWarnings("serial")
 public class ControlServlet extends HttpServlet {

     public static final String module = ControlServlet.class.getName();

     public ControlServlet() {
         super();
     }

     /**
      * @see javax.servlet.Servlet#init(javax.servlet.ServletConfig)
      */
     @Override
     public void init(ServletConfig config) throws ServletException {
         super.init(config);
         if (Debug.infoOn()) Debug.logInfo("LOADING WEBAPP [" + config.getServletContext().getContextPath().substring(1) + "] " + config.getServletContext().getServletContextName() + ", located at " + config.getServletContext().getRealPath("/"), module);

         // configure custom BSF engines
         configureBsf();
         // initialize the request handler
         getRequestHandler();
     }

     /**
      * @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
      */
     @Override
     public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         doGet(request, response);
     }

     /**
      * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
      */
     @Override
     public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         long requestStartTime = System.currentTimeMillis();
         RequestHandler requestHandler = this.getRequestHandler();
         HttpSession session = request.getSession();

         // setup DEFAULT chararcter encoding and content type, this will be overridden in the RequestHandler for view rendering
         String charset = getServletContext().getInitParameter("charset");
         if (charset == null || charset.length() == 0) charset = request.getCharacterEncoding();
         if (charset == null || charset.length() == 0) charset = "UTF-8";
         if (Debug.verboseOn()) Debug.logVerbose("The character encoding of the request is: [" + request.getCharacterEncoding() + "]. The character encoding we will use for the request and response is: [" + charset + "]", module);

         if (!"none".equals(charset)) {
             request.setCharacterEncoding(charset);
         }

         // setup content type
         String contentType = "text/html";
         if (charset.length() > 0 && !"none".equals(charset)) {
             response.setContentType(contentType + "; charset=" + charset);
             response.setCharacterEncoding(charset);
         } else {
             response.setContentType(contentType);
         }

         GenericValue userLogin = (GenericValue) session.getAttribute("userLogin");
         //Debug.log("Cert Chain: " + request.getAttribute("javax.servlet.request.X509Certificate"), module);

         // workaraound if we are in the root webapp
         String webappName = UtilHttp.getApplicationName(request);

         String rname = "";
         if (request.getPathInfo() != null) {
             rname = request.getPathInfo().substring(1);
         }
         if (rname.indexOf('/') > 0) {
             rname = rname.substring(0, rname.indexOf('/'));
         }

         UtilTimer timer = null;
         if (Debug.timingOn()) {
             timer = new UtilTimer();
             timer.setLog(true);
             timer.timerString("[" + rname + "] Request Begun, encoding=[" + charset + "]", module);
         }

         // Setup the CONTROL_PATH for JSP dispatching.
         String contextPath = request.getContextPath();
         if (contextPath == null || "/".equals(contextPath)) {
             contextPath = "";
         }
         request.setAttribute("_CONTROL_PATH_", contextPath + request.getServletPath());
         if (Debug.verboseOn())
             Debug.logVerbose("Control Path: " + request.getAttribute("_CONTROL_PATH_"), module);

         ThreadContext.reset();
         ThreadContext.setLocale(UtilHttp.getLocale(request));
         ThreadContext.setUserLogin(userLogin);

         // for convenience, and necessity with event handlers, make security and delegator available in the request:
         // try to get it from the session first so that we can have a delegator/dispatcher/security for a certain user if desired
         GenericDelegator delegator = null;
         String delegatorName = (String) session.getAttribute("delegatorName");
         if (UtilValidate.isNotEmpty(delegatorName)) {
             delegator = DelegatorFactory.getGenericDelegator(delegatorName);
         }
         if (delegator == null) {
             delegator = (GenericDelegator) getServletContext().getAttribute("delegator");
         }
         if (delegator == null) {
             Debug.logError("[ControlServlet] ERROR: delegator not found in ServletContext", module);
         } else {
         	request.setAttribute("delegator", delegator);
         	// always put this in the session too so that session events can use the delegator
         	session.setAttribute("delegatorName", delegator.getDelegatorName());
         	ThreadContext.setDelegator(delegator);
         }

         LocalDispatcher dispatcher = (LocalDispatcher) session.getAttribute("dispatcher");
         if (dispatcher == null) {
             dispatcher = (LocalDispatcher) getServletContext().getAttribute("dispatcher");
         }
         if (dispatcher == null) {
             Debug.logError("[ControlServlet] ERROR: dispatcher not found in ServletContext", module);
         } else {
             request.setAttribute("dispatcher", dispatcher);
             ThreadContext.setDispatcher(dispatcher);
         }

         Authorization authz = (Authorization) session.getAttribute("authz");
         if (authz == null) {
             authz = (Authorization) getServletContext().getAttribute("authz");
         }
         if (authz == null) {
             Debug.logError("[ControlServlet] ERROR: authorization not found in ServletContext", module);
         }
         request.setAttribute("authz", authz); // maybe we should also add the value to 'security'

         AuthorizationManager security = (AuthorizationManager) session.getAttribute("security");
         if (security == null) {
             security = (AuthorizationManager) getServletContext().getAttribute("security");
         }
         if (security == null) {
             Debug.logError("[ControlServlet] ERROR: security not found in ServletContext", module);
         } else {
             request.setAttribute("security", security);
             ThreadContext.setSecurity(security);
         }

         request.setAttribute("_REQUEST_HANDLER_", requestHandler);

         // setup some things that should always be there
         UtilHttp.setInitialRequestInfo(request);
         VisitHandler.getVisitor(request, response);

         if (delegator != null) {
             // set the GenericDelegator properties
             String visitId = VisitHandler.getVisitId(session);
             if (UtilValidate.isNotEmpty(visitId)) {
                 delegator.setSessionIdentifier(visitId);
             }
             if (userLogin != null) {
                 delegator.setUserIdentifier(userLogin.getString("userLoginId"));
             }
         }

         // display details on the servlet objects
         if (Debug.verboseOn()) {
             logRequestInfo(request);
         }

         // some containers call filters on EVERY request, even forwarded ones, so let it know that it came from the control servlet
         request.setAttribute(ContextFilter.FORWARDED_FROM_SERVLET, Boolean.TRUE);

         String errorPage = null;
         try {
             // the ServerHitBin call for the event is done inside the doRequest method
             requestHandler.doRequest(request, response, null, userLogin, delegator);
         } catch (RequestHandlerException e) {
             Throwable throwable = e.getNested() != null ? e.getNested() : e;
             Debug.logError(throwable, "Error in request handler: ", module);
             request.setAttribute("_ERROR_MESSAGE_", throwable.toString());
             errorPage = requestHandler.getDefaultErrorPage(request);
         } catch (Exception e) {
             Debug.logError(e, "Error in request handler: ", module);
             request.setAttribute("_ERROR_MESSAGE_", e.toString());
             errorPage = requestHandler.getDefaultErrorPage(request);
         }

         // Forward to the JSP
         // if (Debug.infoOn()) Debug.logInfo("[" + rname + "] Event done, rendering page: " + nextPage, module);
         // if (Debug.timingOn()) timer.timerString("[" + rname + "] Event done, rendering page: " + nextPage, module);

         if (errorPage != null) {
             Debug.logError("An error occurred, going to the errorPage: " + errorPage, module);

             RequestDispatcher rd = request.getRequestDispatcher(errorPage);

             // use this request parameter to avoid infinite looping on errors in the error page...
             if (request.getAttribute("_ERROR_OCCURRED_") == null && rd != null) {
                 request.setAttribute("_ERROR_OCCURRED_", Boolean.TRUE);
                 Debug.logError("Including errorPage: " + errorPage, module);

                 // NOTE DEJ20070727 after having trouble with all of these, try to get the page out and as a last resort just send something back
                 try {
                     rd.include(request, response);
                 } catch (Throwable t) {
                     Debug.logWarning("Error while trying to send error page using rd.include (will try response.getOutputStream or response.getWriter): " + t.toString(), module);

                     String errorMessage = "ERROR rendering error page [" + errorPage + "], but here is the error text: " + request.getAttribute("_ERROR_MESSAGE_");
                     try {
                         if (UtilJ2eeCompat.useOutputStreamNotWriter(getServletContext())) {
                             response.getOutputStream().print(errorMessage);
                         } else {
                             response.getWriter().print(errorMessage);
                         }
                     } catch (Throwable t2) {
                         try {
                             int errorToSend = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
                             Debug.logWarning("Error while trying to write error message using response.getOutputStream or response.getWriter: " + t.toString() + "; sending error code [" + errorToSend + "], and message [" + errorMessage + "]", module);
                             response.sendError(errorToSend, errorMessage);
                         } catch (Throwable t3) {
                             // wow, still bad... just throw an IllegalStateException with the message and let the servlet container handle it
                             throw new IllegalStateException(errorMessage);
                         }
                     }
                 }

             } else {
                 if (rd == null) {
                     Debug.logError("Could not get RequestDispatcher for errorPage: " + errorPage, module);
                 }

                 String errorMessage = "<html><body>ERROR in error page, (infinite loop or error page not found with name [" + errorPage + "]), but here is the text just in case it helps you: " + request.getAttribute("_ERROR_MESSAGE_") + "</body></html>";
                 if (UtilJ2eeCompat.useOutputStreamNotWriter(getServletContext())) {
                     response.getOutputStream().print(errorMessage);
                 } else {
                     response.getWriter().print(errorMessage);
                 }
             }
         }

         // sanity check: make sure we don't have any transactions in place
         try {
             // roll back current TX first
             if (TransactionUtil.isTransactionInPlace()) {
                 Debug.logWarning("*** NOTICE: ControlServlet finished w/ a transaction in place! Rolling back.", module);
                 TransactionUtil.rollback();
             }

             // now resume/rollback any suspended txs
             if (TransactionUtil.suspendedTransactionsHeld()) {
                 int suspended = TransactionUtil.cleanSuspendedTransactions();
                 Debug.logWarning("Resumed/Rolled Back [" + suspended + "] transactions.", module);
             }
         } catch (GenericTransactionException e) {
             Debug.logWarning(e, module);
         }

         // run these two again before the ServerHitBin.countRequest call because on a logout this will end up creating a new visit
         if (response.isCommitted() && request.getSession(false) == null) {
             // response committed and no session, and we can't get a new session, what to do!
             // without a session we can't log the hit, etc; so just do nothing; this should NOT happen much!
             Debug.logError("Error in ControlServlet output where response isCommitted and there is no session (probably because of a logout); not saving ServerHit/Bin information because there is no session and as the response isCommitted we can't get a new one. The output was successful, but we just can't save ServerHit/Bin info.", module);
         } else {
             try {
                 ThreadContext.pushExecutionArtifact(module, webappName);
                 UtilHttp.setInitialRequestInfo(request);
                 VisitHandler.getVisitor(request, response);
                 if (requestHandler.trackStats(request)) {
                     ServerHitBin.countRequest(webappName + "." + rname, request, requestStartTime, System.currentTimeMillis() - requestStartTime, userLogin, delegator);
                 }
             } catch (Throwable t) {
                 Debug.logError(t, "Error in ControlServlet saving ServerHit/Bin information; the output was successful, but can't save this tracking information. The error was: " + t.toString(), module);
             } finally {
                 ThreadContext.popExecutionArtifact();
             }
         }
         if (Debug.timingOn()) timer.timerString("[" + rname + "] Request Done", module);
     }

     /**
      * @see javax.servlet.Servlet#destroy()
      */
     @Override
     public void destroy() {
         super.destroy();
     }

     protected RequestHandler getRequestHandler() {
         return RequestHandler.getRequestHandler(getServletContext());
     }

     protected void configureBsf() {
         String[] bshExtensions = {"bsh"};
         BSFManager.registerScriptingEngine("beanshell", "org.ofbiz.base.util.OfbizBshBsfEngine", bshExtensions);

         String[] jsExtensions = {"js"};
         BSFManager.registerScriptingEngine("javascript", "org.ofbiz.base.util.OfbizJsBsfEngine", jsExtensions);

         String[] smExtensions = {"sm"};
         BSFManager.registerScriptingEngine("simplemethod", "org.ofbiz.minilang.SimpleMethodBsfEngine", smExtensions);
     }

     protected void logRequestInfo(HttpServletRequest request) {
         ServletContext servletContext = this.getServletContext();
         HttpSession session = request.getSession();

         Debug.logVerbose("--- Start Request Headers: ---", module);
         Enumeration headerNames = request.getHeaderNames();
         while (headerNames.hasMoreElements()) {
             String headerName = (String) headerNames.nextElement();
             Debug.logVerbose(headerName + ":" + request.getHeader(headerName), module);
         }
         Debug.logVerbose("--- End Request Headers: ---", module);

         Debug.logVerbose("--- Start Request Parameters: ---", module);
         Enumeration paramNames = request.getParameterNames();
         while (paramNames.hasMoreElements()) {
             String paramName = (String) paramNames.nextElement();
             Debug.logVerbose(paramName + ":" + request.getParameter(paramName), module);
         }
         Debug.logVerbose("--- End Request Parameters: ---", module);

         Debug.logVerbose("--- Start Request Attributes: ---", module);
         Enumeration reqNames = request.getAttributeNames();
         while (reqNames != null && reqNames.hasMoreElements()) {
             String attName = (String) reqNames.nextElement();
             Debug.logVerbose(attName + ":" + request.getAttribute(attName), module);
         }
         Debug.logVerbose("--- End Request Attributes ---", module);

         Debug.logVerbose("--- Start Session Attributes: ---", module);
         Enumeration sesNames = null;
         try {
             sesNames = session.getAttributeNames();
         } catch (IllegalStateException e) {
             Debug.logVerbose("Cannot get session attributes : " + e.getMessage(), module);
         }
         while (sesNames != null && sesNames.hasMoreElements()) {
             String attName = (String) sesNames.nextElement();
             Debug.logVerbose(attName + ":" + session.getAttribute(attName), module);
         }
         Debug.logVerbose("--- End Session Attributes ---", module);

         Enumeration appNames = servletContext.getAttributeNames();
         Debug.logVerbose("--- Start ServletContext Attributes: ---", module);
         while (appNames != null && appNames.hasMoreElements()) {
             String attName = (String) appNames.nextElement();
             Debug.logVerbose(attName + ":" + servletContext.getAttribute(attName), module);
         }
         Debug.logVerbose("--- End ServletContext Attributes ---", module);
     }
 }
	/*******************************************************************************
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*******************************************************************************/
	package org.ofbiz.webapp.control;

	import javax.servlet.RequestDispatcher;
	import javax.servlet.ServletConfig;
	import javax.servlet.ServletContext;
	import javax.servlet.ServletException;
	import javax.servlet.http.HttpServlet;
	import javax.servlet.http.HttpServletRequest;
	import javax.servlet.http.HttpServletResponse;
	import javax.servlet.http.HttpSession;
	import java.io.IOException;
	import java.util.Enumeration;

	import org.apache.bsf.BSFManager;

	import org.ofbiz.service.ThreadContext;
	import org.ofbiz.base.util.Debug;
	import org.ofbiz.base.util.UtilHttp;
	import org.ofbiz.base.util.UtilJ2eeCompat;
	import org.ofbiz.base.util.UtilTimer;
	import org.ofbiz.base.util.UtilValidate;
	import org.ofbiz.entity.DelegatorFactory;
	import org.ofbiz.entity.GenericDelegator;
	import org.ofbiz.entity.GenericValue;
	import org.ofbiz.entity.transaction.GenericTransactionException;
	import org.ofbiz.entity.transaction.TransactionUtil;
	import org.ofbiz.api.authorization.AuthorizationManager;
	import org.ofbiz.security.authz.Authorization;
	import org.ofbiz.service.LocalDispatcher;
	import org.ofbiz.webapp.stats.ServerHitBin;
	import org.ofbiz.webapp.stats.VisitHandler;

	/**
	* ControlServlet.java - Master servlet for the web application.
	*/
	@SuppressWarnings("serial")
	public class ControlServlet extends HttpServlet {

	public static final String module = ControlServlet.class.getName();

	public ControlServlet() {
	super();
	}

	/**
	* @see javax.servlet.Servlet#init(javax.servlet.ServletConfig)
	*/
	@Override
	public void init(ServletConfig config) throws ServletException {
	super.init(config);
	if (Debug.infoOn()) Debug.logInfo("LOADING WEBAPP [" + config.getServletContext().getContextPath().substring(1) + "] " + config.getServletContext().getServletContextName() + ", located at " + config.getServletContext().getRealPath("/"), module);

	// configure custom BSF engines
	configureBsf();
	// initialize the request handler
	getRequestHandler();
	}

	/**
	* @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
	*/
	@Override
	public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
	doGet(request, response);
	}

	/**
	* @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
	*/
	@Override
	public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
	long requestStartTime = System.currentTimeMillis();
	RequestHandler requestHandler = this.getRequestHandler();
	HttpSession session = request.getSession();

	// setup DEFAULT chararcter encoding and content type, this will be overridden in the RequestHandler for view rendering
	String charset = getServletContext().getInitParameter("charset");
	if (charset == null \|\| charset.length() == 0) charset = request.getCharacterEncoding();
	if (charset == null \|\| charset.length() == 0) charset = "UTF-8";
	if (Debug.verboseOn()) Debug.logVerbose("The character encoding of the request is: [" + request.getCharacterEncoding() + "]. The character encoding we will use for the request and response is: [" + charset + "]", module);

	if (!"none".equals(charset)) {
	request.setCharacterEncoding(charset);
	}

	// setup content type
	String contentType = "text/html";
	if (charset.length() > 0 && !"none".equals(charset)) {
	response.setContentType(contentType + "; charset=" + charset);
	response.setCharacterEncoding(charset);
	} else {
	response.setContentType(contentType);
	}

	GenericValue userLogin = (GenericValue) session.getAttribute("userLogin");
	//Debug.log("Cert Chain: " + request.getAttribute("javax.servlet.request.X509Certificate"), module);

	// workaraound if we are in the root webapp
	String webappName = UtilHttp.getApplicationName(request);

	String rname = "";
	if (request.getPathInfo() != null) {
	rname = request.getPathInfo().substring(1);
	}
	if (rname.indexOf('/') > 0) {
	rname = rname.substring(0, rname.indexOf('/'));
	}

	UtilTimer timer = null;
	if (Debug.timingOn()) {
	timer = new UtilTimer();
	timer.setLog(true);
	timer.timerString("[" + rname + "] Request Begun, encoding=[" + charset + "]", module);
	}

	// Setup the CONTROL_PATH for JSP dispatching.
	String contextPath = request.getContextPath();
	if (contextPath == null \|\| "/".equals(contextPath)) {
	contextPath = "";
	}
	request.setAttribute("_CONTROL_PATH_", contextPath + request.getServletPath());
	if (Debug.verboseOn())
	Debug.logVerbose("Control Path: " + request.getAttribute("_CONTROL_PATH_"), module);

	ThreadContext.reset();
	ThreadContext.setLocale(UtilHttp.getLocale(request));
	ThreadContext.setUserLogin(userLogin);

	// for convenience, and necessity with event handlers, make security and delegator available in the request:
	// try to get it from the session first so that we can have a delegator/dispatcher/security for a certain user if desired
	GenericDelegator delegator = null;
	String delegatorName = (String) session.getAttribute("delegatorName");
	if (UtilValidate.isNotEmpty(delegatorName)) {
	delegator = DelegatorFactory.getGenericDelegator(delegatorName);
	}
	if (delegator == null) {
	delegator = (GenericDelegator) getServletContext().getAttribute("delegator");
	}
	if (delegator == null) {
	Debug.logError("[ControlServlet] ERROR: delegator not found in ServletContext", module);
	} else {
	request.setAttribute("delegator", delegator);
	// always put this in the session too so that session events can use the delegator
	session.setAttribute("delegatorName", delegator.getDelegatorName());
	ThreadContext.setDelegator(delegator);
	}

	LocalDispatcher dispatcher = (LocalDispatcher) session.getAttribute("dispatcher");
	if (dispatcher == null) {
	dispatcher = (LocalDispatcher) getServletContext().getAttribute("dispatcher");
	}
	if (dispatcher == null) {
	Debug.logError("[ControlServlet] ERROR: dispatcher not found in ServletContext", module);
	} else {
	request.setAttribute("dispatcher", dispatcher);
	ThreadContext.setDispatcher(dispatcher);
	}

	Authorization authz = (Authorization) session.getAttribute("authz");
	if (authz == null) {
	authz = (Authorization) getServletContext().getAttribute("authz");
	}
	if (authz == null) {
	Debug.logError("[ControlServlet] ERROR: authorization not found in ServletContext", module);
	}
	request.setAttribute("authz", authz); // maybe we should also add the value to 'security'

	AuthorizationManager security = (AuthorizationManager) session.getAttribute("security");
	if (security == null) {
	security = (AuthorizationManager) getServletContext().getAttribute("security");
	}
	if (security == null) {
	Debug.logError("[ControlServlet] ERROR: security not found in ServletContext", module);
	} else {
	request.setAttribute("security", security);
	ThreadContext.setSecurity(security);
	}

	request.setAttribute("_REQUEST_HANDLER_", requestHandler);

	// setup some things that should always be there
	UtilHttp.setInitialRequestInfo(request);
	VisitHandler.getVisitor(request, response);

	if (delegator != null) {
	// set the GenericDelegator properties
	String visitId = VisitHandler.getVisitId(session);
	if (UtilValidate.isNotEmpty(visitId)) {
	delegator.setSessionIdentifier(visitId);
	}
	if (userLogin != null) {
	delegator.setUserIdentifier(userLogin.getString("userLoginId"));
	}
	}

	// display details on the servlet objects
	if (Debug.verboseOn()) {
	logRequestInfo(request);
	}

	// some containers call filters on EVERY request, even forwarded ones, so let it know that it came from the control servlet
	request.setAttribute(ContextFilter.FORWARDED_FROM_SERVLET, Boolean.TRUE);

	String errorPage = null;
	try {
	// the ServerHitBin call for the event is done inside the doRequest method
	requestHandler.doRequest(request, response, null, userLogin, delegator);
	} catch (RequestHandlerException e) {
	Throwable throwable = e.getNested() != null ? e.getNested() : e;
	Debug.logError(throwable, "Error in request handler: ", module);
	request.setAttribute("_ERROR_MESSAGE_", throwable.toString());
	errorPage = requestHandler.getDefaultErrorPage(request);
	} catch (Exception e) {
	Debug.logError(e, "Error in request handler: ", module);
	request.setAttribute("_ERROR_MESSAGE_", e.toString());
	errorPage = requestHandler.getDefaultErrorPage(request);
	}

	// Forward to the JSP
	// if (Debug.infoOn()) Debug.logInfo("[" + rname + "] Event done, rendering page: " + nextPage, module);
	// if (Debug.timingOn()) timer.timerString("[" + rname + "] Event done, rendering page: " + nextPage, module);

	if (errorPage != null) {
	Debug.logError("An error occurred, going to the errorPage: " + errorPage, module);

	RequestDispatcher rd = request.getRequestDispatcher(errorPage);

	// use this request parameter to avoid infinite looping on errors in the error page...
	if (request.getAttribute("_ERROR_OCCURRED_") == null && rd != null) {
	request.setAttribute("_ERROR_OCCURRED_", Boolean.TRUE);
	Debug.logError("Including errorPage: " + errorPage, module);

	// NOTE DEJ20070727 after having trouble with all of these, try to get the page out and as a last resort just send something back
	try {
	rd.include(request, response);
	} catch (Throwable t) {
	Debug.logWarning("Error while trying to send error page using rd.include (will try response.getOutputStream or response.getWriter): " + t.toString(), module);

	String errorMessage = "ERROR rendering error page [" + errorPage + "], but here is the error text: " + request.getAttribute("_ERROR_MESSAGE_");
	try {
	if (UtilJ2eeCompat.useOutputStreamNotWriter(getServletContext())) {
	response.getOutputStream().print(errorMessage);
	} else {
	response.getWriter().print(errorMessage);
	}
	} catch (Throwable t2) {
	try {
	int errorToSend = HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
	Debug.logWarning("Error while trying to write error message using response.getOutputStream or response.getWriter: " + t.toString() + "; sending error code [" + errorToSend + "], and message [" + errorMessage + "]", module);
	response.sendError(errorToSend, errorMessage);
	} catch (Throwable t3) {
	// wow, still bad... just throw an IllegalStateException with the message and let the servlet container handle it
	throw new IllegalStateException(errorMessage);
	}
	}
	}

	} else {
	if (rd == null) {
	Debug.logError("Could not get RequestDispatcher for errorPage: " + errorPage, module);
	}

	String errorMessage = "<html><body>ERROR in error page, (infinite loop or error page not found with name [" + errorPage + "]), but here is the text just in case it helps you: " + request.getAttribute("_ERROR_MESSAGE_") + "</body></html>";
	if (UtilJ2eeCompat.useOutputStreamNotWriter(getServletContext())) {
	response.getOutputStream().print(errorMessage);
	} else {
	response.getWriter().print(errorMessage);
	}
	}
	}

	// sanity check: make sure we don't have any transactions in place
	try {
	// roll back current TX first
	if (TransactionUtil.isTransactionInPlace()) {
	Debug.logWarning("*** NOTICE: ControlServlet finished w/ a transaction in place! Rolling back.", module);
	TransactionUtil.rollback();
	}

	// now resume/rollback any suspended txs
	if (TransactionUtil.suspendedTransactionsHeld()) {
	int suspended = TransactionUtil.cleanSuspendedTransactions();
	Debug.logWarning("Resumed/Rolled Back [" + suspended + "] transactions.", module);
	}
	} catch (GenericTransactionException e) {
	Debug.logWarning(e, module);
	}

	// run these two again before the ServerHitBin.countRequest call because on a logout this will end up creating a new visit
	if (response.isCommitted() && request.getSession(false) == null) {
	// response committed and no session, and we can't get a new session, what to do!
	// without a session we can't log the hit, etc; so just do nothing; this should NOT happen much!
	Debug.logError("Error in ControlServlet output where response isCommitted and there is no session (probably because of a logout); not saving ServerHit/Bin information because there is no session and as the response isCommitted we can't get a new one. The output was successful, but we just can't save ServerHit/Bin info.", module);
	} else {
	try {
	ThreadContext.pushExecutionArtifact(module, webappName);
	UtilHttp.setInitialRequestInfo(request);
	VisitHandler.getVisitor(request, response);
	if (requestHandler.trackStats(request)) {
	ServerHitBin.countRequest(webappName + "." + rname, request, requestStartTime, System.currentTimeMillis() - requestStartTime, userLogin, delegator);
	}
	} catch (Throwable t) {
	Debug.logError(t, "Error in ControlServlet saving ServerHit/Bin information; the output was successful, but can't save this tracking information. The error was: " + t.toString(), module);
	} finally {
	ThreadContext.popExecutionArtifact();
	}
	}
	if (Debug.timingOn()) timer.timerString("[" + rname + "] Request Done", module);
	}

	/**
	* @see javax.servlet.Servlet#destroy()
	*/
	@Override
	public void destroy() {
	super.destroy();
	}

	protected RequestHandler getRequestHandler() {
	return RequestHandler.getRequestHandler(getServletContext());
	}

	protected void configureBsf() {
	String[] bshExtensions = {"bsh"};
	BSFManager.registerScriptingEngine("beanshell", "org.ofbiz.base.util.OfbizBshBsfEngine", bshExtensions);

	String[] jsExtensions = {"js"};
	BSFManager.registerScriptingEngine("javascript", "org.ofbiz.base.util.OfbizJsBsfEngine", jsExtensions);

	String[] smExtensions = {"sm"};
	BSFManager.registerScriptingEngine("simplemethod", "org.ofbiz.minilang.SimpleMethodBsfEngine", smExtensions);
	}

	protected void logRequestInfo(HttpServletRequest request) {
	ServletContext servletContext = this.getServletContext();
	HttpSession session = request.getSession();

	Debug.logVerbose("--- Start Request Headers: ---", module);
	Enumeration headerNames = request.getHeaderNames();
	while (headerNames.hasMoreElements()) {
	String headerName = (String) headerNames.nextElement();
	Debug.logVerbose(headerName + ":" + request.getHeader(headerName), module);
	}
	Debug.logVerbose("--- End Request Headers: ---", module);

	Debug.logVerbose("--- Start Request Parameters: ---", module);
	Enumeration paramNames = request.getParameterNames();
	while (paramNames.hasMoreElements()) {
	String paramName = (String) paramNames.nextElement();
	Debug.logVerbose(paramName + ":" + request.getParameter(paramName), module);
	}
	Debug.logVerbose("--- End Request Parameters: ---", module);

	Debug.logVerbose("--- Start Request Attributes: ---", module);
	Enumeration reqNames = request.getAttributeNames();
	while (reqNames != null && reqNames.hasMoreElements()) {
	String attName = (String) reqNames.nextElement();
	Debug.logVerbose(attName + ":" + request.getAttribute(attName), module);
	}
	Debug.logVerbose("--- End Request Attributes ---", module);

	Debug.logVerbose("--- Start Session Attributes: ---", module);
	Enumeration sesNames = null;
	try {
	sesNames = session.getAttributeNames();
	} catch (IllegalStateException e) {
	Debug.logVerbose("Cannot get session attributes : " + e.getMessage(), module);
	}
	while (sesNames != null && sesNames.hasMoreElements()) {
	String attName = (String) sesNames.nextElement();
	Debug.logVerbose(attName + ":" + session.getAttribute(attName), module);
	}
	Debug.logVerbose("--- End Session Attributes ---", module);

	Enumeration appNames = servletContext.getAttributeNames();
	Debug.logVerbose("--- Start ServletContext Attributes: ---", module);
	while (appNames != null && appNames.hasMoreElements()) {
	String attName = (String) appNames.nextElement();
	Debug.logVerbose(attName + ":" + servletContext.getAttribute(attName), module);
	}
	Debug.logVerbose("--- End ServletContext Attributes ---", module);
	}
	}