org.mobicents.servlet.sip.startup.SipStandardContextValve Maven / Gradle / Ivy
/*
* TeleStax, Open Source Cloud Communications
* Copyright 2011-2014, Telestax Inc and individual contributors
* by the @authors tag.
*
* This program is free software: you can redistribute it and/or modify
* under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see SipStandardContext container implementation.
*
* USAGE CONSTRAINT: This implementation is likely to be useful only
* when processing HTTP requests.
*
* The code was copy pasted from tomcat 5.5.20 source and some specific code was added on invoke
* method to store the htpp session in the threadlocal of the sipfactoryfacade and check if the request
* has an application key associated with it
*
* @author Jean Deruelle
*
*/
final class SipStandardContextValve extends org.apache.catalina.valves.ValveBase {
//------------------------------------------------------ Constructor
public SipStandardContextValve() {
super(true);
}
// ----------------------------------------------------- Instance Variables
/**
* The descriptive information related to this implementation.
*/
private static final String info =
"org.apache.catalina.core.StandardContextValve/1.0";
/**
* The string manager for this package.
*/
private static final StringManager sm =
StringManager.getManager(Constants.Package);
private static transient final Logger logger = Logger.getLogger(SipStandardContextValve.class);
private SipStandardContext context = null;
// ------------------------------------------------------------- Properties
/**
* Return descriptive information about this Valve implementation.
*/
public String getInfo() {
return (info);
}
// --------------------------------------------------------- Public Methods
/**
* Cast to a StandardContext right away, as it will be needed later.
*
* @see org.apache.catalina.Contained#setContainer(org.apache.catalina.Container)
*/
public void setContainer(Container container) {
super.setContainer(container);
context = (SipStandardContext) container;
}
/**
* Select the appropriate child Wrapper to process this request,
* based on the specified request URI. If no matching Wrapper can
* be found, return an appropriate HTTP error.
*
* @param request Request to be processed
* @param response Response to be produced
* @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*/
public final void invoke(Request request, Response response)
throws IOException, ServletException {
// Disallow any direct access to resources under WEB-INF or META-INF
MessageBytes requestPathMB = request.getRequestPathMB();
if ((requestPathMB.startsWithIgnoreCase("/META-INF/", 0))
|| (requestPathMB.equalsIgnoreCase("/META-INF"))
|| (requestPathMB.startsWithIgnoreCase("/WEB-INF/", 0))
|| (requestPathMB.equalsIgnoreCase("/WEB-INF"))) {
notFound(response);
return;
}
// Wait if we are reloading
boolean reloaded = false;
while (context.getPaused()) {
reloaded = true;
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
;
}
}
// Reloading will have stopped the old webappclassloader and
// created a new one
if (reloaded &&
context.getLoader() != null &&
context.getLoader().getClassLoader() != null) {
Thread.currentThread().setContextClassLoader(
context.getLoader().getClassLoader());
}
// Select the Wrapper to be used for this Request
Wrapper wrapper = request.getWrapper();
if (wrapper == null) {
notFound(response);
return;
} else if (wrapper.isUnavailable()) {
// May be as a result of a reload, try and find the new wrapper
wrapper = (Wrapper) container.findChild(wrapper.getName());
if (wrapper == null) {
notFound(response);
return;
}
}
// Normal request processing
Object instances[] = context.getApplicationEventListeners();
ServletRequestEvent event = null;
if ((instances != null)
&& (instances.length > 0)) {
event = new ServletRequestEvent
(((StandardContext) container).getServletContext(),
request.getRequest());
// create pre-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestInitialized(event);
} catch (Throwable t) {
container.getLogger().error(sm.getString("standardContext.requestListener.requestInit",
instances[i].getClass().getName()), t);
ServletRequest sreq = request.getRequest();
sreq.setAttribute("javax.servlet.error.exception",t);
return;
}
}
}
boolean batchStarted = context.enterSipAppHa(false);
//the line below was replaced by the whole bunch of code because getting the parameter from the request is causing
//JRuby-Rails persistence to fail, go figure...
// String sipApplicationKey = request.getParameter(MobicentsSipApplicationSession.SIP_APPLICATION_KEY_PARAM_NAME);
String sipApplicationKey = null;
String queryString = request.getQueryString();
if(queryString != null) {
int indexOfSipAppKey = queryString.indexOf(MobicentsSipApplicationSession.SIP_APPLICATION_KEY_PARAM_NAME);
if(indexOfSipAppKey != -1) {
// +1 to remove the = sign also
String sipAppKeyParam = queryString.substring(indexOfSipAppKey + MobicentsSipApplicationSession.SIP_APPLICATION_KEY_PARAM_NAME.length() + 1);
int indexOfPoundSign = sipAppKeyParam.indexOf("&");
if(indexOfPoundSign != -1) {
sipAppKeyParam = sipAppKeyParam.substring(0, indexOfPoundSign);
}
sipApplicationKey = sipAppKeyParam;
}
}
MobicentsSipApplicationSession sipApplicationSessionImpl = null;
if(sipApplicationKey != null && sipApplicationKey.length() > 0) {
try {
SipApplicationSessionKey sipApplicationSessionKey =
SessionManagerUtil.parseSipApplicationSessionKey(sipApplicationKey);
sipApplicationSessionImpl =
context.getSipManager().getSipApplicationSession(sipApplicationSessionKey, false);
sipApplicationSessionImpl.addHttpSession(request.getSession());
} catch (ParseException pe) {
logger.error("Unexpected exception while parsing the sip application session key" + sipApplicationKey, pe);
}
} else {
// Fix for Issue 882 : HTTP requests to a SIP application always create an HTTP session, even for static resources
// Don't create an http session if not already created
final HttpSession httpSession = request.getSession(false);
if(httpSession != null) {
context.getSipFactoryFacade().storeHttpSession(httpSession);
ConvergedSession convergedSession = (ConvergedSession) httpSession;
sipApplicationSessionImpl = convergedSession.getApplicationSession(false);
}
}
// Fix for http://code.google.com/p/mobicents/issues/detail?id=1386 :
// Ensure SipApplicationSession concurrency control on converged HTTP apps
context.enterSipApp(sipApplicationSessionImpl, null, false, true);
try {
wrapper.getPipeline().getFirst().invoke(request, response);
} finally {
context.exitSipApp(sipApplicationSessionImpl, null);
context.exitSipAppHa(null, null, batchStarted);
}
// Fix for Issue 882 :remove the http session from the thread local to avoid any leaking of the session
context.getSipFactoryFacade().removeHttpSession();
if ((instances !=null ) &&
(instances.length > 0)) {
// create post-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestDestroyed(event);
} catch (Throwable t) {
container.getLogger().error(sm.getString("standardContext.requestListener.requestDestroy",
instances[i].getClass().getName()), t);
ServletRequest sreq = request.getRequest();
sreq.setAttribute("javax.servlet.error.exception",t);
}
}
}
}
/**
* Select the appropriate child Wrapper to process this request,
* based on the specified request URI. If no matching Wrapper can
* be found, return an appropriate HTTP error.
*
* @param request Request to be processed
* @param response Response to be produced
* @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*/
public final void event(Request request, Response response, CometEvent event)
throws IOException, ServletException {
// Select the Wrapper to be used for this Request
Wrapper wrapper = request.getWrapper();
// Normal request processing
// FIXME: This could be an addition to the core API too
/*
Object instances[] = context.getApplicationEventListeners();
ServletRequestEvent event = null;
if ((instances != null)
&& (instances.length > 0)) {
event = new ServletRequestEvent
(((StandardContext) container).getServletContext(),
request.getRequest());
// create pre-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestInitialized(event);
} catch (Throwable t) {
container.getLogger().error(sm.getString("requestListenerValve.requestInit",
instances[i].getClass().getName()), t);
ServletRequest sreq = request.getRequest();
sreq.setAttribute(Globals.EXCEPTION_ATTR,t);
return;
}
}
}
*/
wrapper.getPipeline().getFirst().event(request, response, event);
/*
if ((instances !=null ) &&
(instances.length > 0)) {
// create post-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestDestroyed(event);
} catch (Throwable t) {
container.getLogger().error(sm.getString("requestListenerValve.requestDestroy",
instances[i].getClass().getName()), t);
ServletRequest sreq = request.getRequest();
sreq.setAttribute(Globals.EXCEPTION_ATTR,t);
}
}
}
*/
}
// -------------------------------------------------------- Private Methods
/**
* Report a "not found" error for the specified resource. FIXME: We
* should really be using the error reporting settings for this web
* application, but currently that code runs at the wrapper level rather
* than the context level.
*
* @param response The response we are creating
*/
private void notFound(HttpServletResponse response) {
try {
response.sendError(HttpServletResponse.SC_NOT_FOUND);
} catch (IllegalStateException e) {
;
} catch (IOException e) {
;
}
}
}