com.rathravane.drumlin.service.framework.context.DrumlinRequestContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of drumlin Show documentation
A simple Java webapp framework with POJO path routing, Velocity templates, and basic app functionality such as HTML form validation.
There is a newer version: 1.3.0
Show newest version
/*
 *	Copyright 2006-2013, Rathravane LLC
 *
 *	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 com.rathravane.drumlin.service.framework.context;

import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.velocity.VelocityContext;
import org.slf4j.LoggerFactory;

import com.rathravane.drumlin.service.framework.DrumlinConnection;
import com.rathravane.drumlin.service.framework.DrumlinServlet;
import com.rathravane.drumlin.service.framework.rendering.DrumlinRenderContext;
import com.rathravane.drumlin.service.framework.routing.DrumlinRequestRouter;
import com.rathravane.till.nv.rrNvReadable;

/**
 * The DrumlinRequestContext provides the servlet, the inbound HTTP request, the outbound
 * HTTP response, the Connection, and other information to the request handlers provided by
 * the web application.
 * 
 * @author [email protected]
 *
 */
public class DrumlinRequestContext
{
	public DrumlinRequestContext ( DrumlinServlet webServlet, HttpServletRequest req, HttpServletResponse resp,
		C s, Map objects, DrumlinRequestRouter router )
	{
		fRequest = req;
		fResponse = resp;
		fSession = s;
		fServlet = webServlet;
		fBaseRenderContext = webServlet.getBaseContext ();
		fLocalContext = new HashMap ();
		fObjects = objects;
		fRouter = router;

		fRequestImpl = new StdRequest ( fRequest );
	}

	/**
	 * Get the connection being serviced.
	 * @return a connection
	 */
	public C session ()
	{
		return fSession;
	}

	public rrNvReadable systemSettings ()
	{
		return fServlet.getSettings ();
	}

	public DrumlinRequestRouter router ()
	{
		return fRouter;
	}

	public DrumlinServlet getServlet ()
	{
		return fServlet;
	}

	public String servletPathToFullUrl ( String contentUrl )
	{
		final StringBuffer url = new StringBuffer ();

		final String scheme = fRequest.getScheme ().toLowerCase ();
		url.append ( scheme );
		url.append ( "://" );
		url.append ( fRequest.getServerName () );

		final int serverPort = fRequest.getServerPort ();
		if ( !( ( scheme.equals ( "http" ) && serverPort == 80 ) ||
			( scheme.equals ( "https" ) && serverPort == 443 ) ) )
		{
			url.append ( ":" );
			url.append ( serverPort );
		}

		final String path = servletPathToFullPath ( contentUrl );
		url.append ( path );

		log.info ( "calculated full URL for [" + contentUrl + "]: [" + url + "]" );
		return url.toString ();
	}

	public String servletPathToFullPath ( String contentUrl )
	{
		return servletPathToFullPath ( contentUrl, fRequest );
	}

	public static String servletPathToFullPath ( String contentUrl, HttpServletRequest req )
	{
		final StringBuffer sb = new StringBuffer ();

		final String contextPart = req.getContextPath ();
		sb.append ( contextPart );

		final String servletPart = req.getServletPath ();
		sb.append ( servletPart );

		sb.append ( contentUrl );

		log.info ( "calculated full path for [" + contentUrl + "]: context=[" + contextPart + "], servlet=["
			+ servletPart + "], result=[" + sb.toString () + "]" );
		return sb.toString ();
	}

	public Object object ( String key )
	{
		return fObjects.get ( key );
	}

	public DrumlinRequest request ()
	{
		return fRequestImpl;
	}

	public DrumlinResponse response ()
	{
		return new StdResponse ( fRequest, fResponse, fRouter );
	}

	public DrumlinRenderContext renderer ()
	{
		return new StdRenderer (this);
	}

	public void merge ( String templateName, Map data, PrintWriter to )
	{
		final VelocityContext ctx = new VelocityContext ( fBaseRenderContext );
		for ( Entry e : data.entrySet () )
		{
			ctx.put ( e.getKey(), e.getValue() );
		}
		fServlet.getVelocity ().mergeTemplate ( templateName, "UTF-8", ctx, to );
	}
	
	private final HttpServletRequest fRequest;
	private final HttpServletResponse fResponse;
	final C fSession;
	private final DrumlinServlet fServlet;
	private final VelocityContext fBaseRenderContext;
	final HashMap fLocalContext;
	private final Map fObjects;
	private final DrumlinRequestRouter fRouter;

	private final DrumlinRequest fRequestImpl;
	
	static org.slf4j.Logger log = LoggerFactory.getLogger ( DrumlinRequestContext.class );
}