/*
* Copyright 2005 Joe Walker
*
* Licensed 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.directwebremoting.impl;
import java.io.IOException;
import java.io.StringWriter;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.directwebremoting.Container;
import org.directwebremoting.ScriptBuffer;
import org.directwebremoting.ScriptSession;
import org.directwebremoting.extend.EnginePrivate;
import org.directwebremoting.extend.RealScriptSession;
import org.directwebremoting.extend.RealWebContext;
import org.directwebremoting.extend.ScriptSessionManager;
import org.directwebremoting.extend.IdGenerator;
import org.directwebremoting.util.SwallowingHttpServletResponse;
/**
* A default implementation of WebContext.
* @author Joe Walker [joe at getahead dot ltd dot uk]
*/
public class DefaultWebContext extends DefaultServerContext implements RealWebContext
{
/**
* Create a new DefaultWebContext
* @param container The IoC container
* @param request The incoming http request
* @param response The outgoing http reply
* @param servletConfig The servlet configuration
* @param servletContext The servlet context
* @see org.directwebremoting.WebContextFactory.WebContextBuilder#engageThread(Container, HttpServletRequest, HttpServletResponse)
*/
protected DefaultWebContext(Container container, HttpServletRequest request, HttpServletResponse response, ServletConfig servletConfig, ServletContext servletContext)
{
setServletConfig(servletConfig);
setServletContext(servletContext);
setContainer(container);
this.request = request;
this.response = response;
Object value = container.getBean("avoidConnectionLimitWithWindowName");
if (value != null)
{
avoidConnectionLimitWithWindowName = Boolean.parseBoolean(value.toString());
}
}
/* (non-Javadoc)
* @see org.directwebremoting.extend.RealWebContext#checkPageInformation(java.lang.String, java.lang.String, java.lang.String)
*/
public void checkPageInformation(final String sentPage, String sentScriptId, String windowName)
{
ScriptSessionManager scriptSessionManager = getScriptSessionManager();
// Get the httpSessionId if it exists, but don't create one if it doesn't
String httpSessionId = null;
HttpSession httpSession = request.getSession(false);
if (httpSession != null)
{
httpSessionId = httpSession.getId();
}
// Check validity to the script session id. It could be invalid due to
// to a server re-start, a timeout, a back-button, just because the user
// is new to this page, or because someone is hacking
this.scriptSession = scriptSessionManager.getOrCreateScriptSession(sentScriptId, sentPage, httpSessionId);
// The passed script session id passed the test, use it
this.page = sentPage;
if (avoidConnectionLimitWithWindowName)
{
if (windowName == null || "".equals(windowName))
{
windowName = "DWR-" + this.getContainer().getBean(IdGenerator.class).generate();
ScriptBuffer script = EnginePrivate.getRemoteHandleNewWindowNameScript(windowName);
scriptSession.addScript(script);
}
scriptSession.setWindowName(windowName);
}
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getCurrentPage()
*/
public String getCurrentPage()
{
if (page == null)
{
throw new UnsupportedOperationException("CurrentPage is not supported from a JSON call.");
}
return page;
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getScriptSession()
*/
public ScriptSession getScriptSession()
{
return scriptSession;
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getSession()
*/
public HttpSession getSession()
{
return request.getSession();
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getSession(boolean)
*/
public HttpSession getSession(boolean create)
{
return request.getSession(create);
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getHttpServletRequest()
*/
public HttpServletRequest getHttpServletRequest()
{
return request;
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#getHttpServletResponse()
*/
public HttpServletResponse getHttpServletResponse()
{
return response;
}
/* (non-Javadoc)
* @see org.directwebremoting.WebContext#forwardToString(java.lang.String)
*/
public String forwardToString(String url) throws ServletException, IOException
{
StringWriter sout = new StringWriter();
StringBuffer buffer = sout.getBuffer();
HttpServletResponse realResponse = getHttpServletResponse();
HttpServletResponse fakeResponse = new SwallowingHttpServletResponse(realResponse, sout, realResponse.getCharacterEncoding());
HttpServletRequest realRequest = getHttpServletRequest();
realRequest.setAttribute(ATTRIBUTE_DWR, Boolean.TRUE);
getServletContext().getRequestDispatcher(url).forward(realRequest, fakeResponse);
return buffer.toString();
}
/**
* ScriptSession IDs are too long to be useful to humans. We shorten them
* to the first 4 characters.
*/
private String simplifyId(String id)
{
if (id == null)
{
return "[null]";
}
if (id.length() == 0)
{
return "[blank]";
}
if (id.length() < 4)
{
return id;
}
return id.substring(0, 4);
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return "DefaultWebContext[id=" + simplifyId(scriptSession.getId()) + ", page=" + page + "]";
}
/**
* We can turn connection limit avoidance off
*/
private boolean avoidConnectionLimitWithWindowName = false;
/**
* The unique ID (like a session ID) assigned to the current page
*/
private RealScriptSession scriptSession;
/**
* The URL of the current page
*/
private String page;
/**
* The HttpServletRequest associated with the current request
*/
private final HttpServletRequest request;
/**
* The HttpServletResponse associated with the current request
*/
private final HttpServletResponse response;
}