com.rathravane.drumlin.service.framework.context.StdRequest 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-2015, 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.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import com.rathravane.till.data.rrConvertor;

public class StdRequest implements DrumlinRequest
{
	public StdRequest ( HttpServletRequest r )
	{
		fRequest = r;
		fParamOverrides = new HashMap<>();
	}

	@Override
	public String getUrl ()
	{
		return fRequest.getRequestURL ().toString ();
	}

	@Override
	public boolean isSecure ()
	{
		return fRequest.isSecure ();
	}

	@Override
	public String getQueryString ()
	{
		final String qs = fRequest.getQueryString ();
		if ( qs != null && qs.length () == 0 ) return null;
		return qs;
	}
	
	@Override
	public String getMethod ()
	{
		return fRequest.getMethod ();
	}

	@Override
	public String getPathInContext ()
	{
		final String ctxPath = fRequest.getContextPath ();
		final int ctxPathLen = ctxPath.length();
		return fRequest.getRequestURI().substring ( ctxPathLen );
	}

	@Override
	public String getFirstHeader ( String h )
	{
		return getFirstHeader ( fRequest, h );
	}

	@Override
	public List getHeader ( String h )
	{
		return getHeader ( fRequest, h );
	}

	@Override
	public Map> getAllHeaders ()
	{
		return getAllHeaders ( fRequest );
	}
	
	@Override
	public String getContentType ()
	{
		return fRequest.getContentType ();
	}

	@Override
	public int getContentLength ()
	{
		return fRequest.getContentLength ();
	}

	@Override
	public InputStream getBodyStream ()
		throws IOException
	{
		return fRequest.getInputStream ();
	}

	@Override
	public BufferedReader getBodyStreamAsText ()
		throws IOException
	{
		return new BufferedReader ( new InputStreamReader ( getBodyStream () ) );
	}

	@Override
	public Map getParameterMap ()
	{
		final HashMap map = new HashMap<>();
		final Map m = fRequest.getParameterMap ();

		map.putAll ( m );
		map.putAll ( fParamOverrides );

		return map;
	}

	@Override
	public String getParameter ( String key )
	{
		if ( fParamOverrides.containsKey ( key ) )
		{
			final String[] o = fParamOverrides.get ( key );
			return o.length > 0 ? o[0] : "";
		}
		else
		{
			return fRequest.getParameter ( key );
		}
	}

	@Override
	public String getParameter ( String key, String defVal )
	{
		String p = getParameter ( key );
		if ( p == null )
		{
			p = defVal;
		}
		return p;
	}

	@Override
	public int getIntParameter ( String key, int defVal )
	{
		int result = defVal;
		final String p = getParameter ( key );
		if ( p != null )
		{
			try
			{
				result = rrConvertor.convertToInt ( p );
			}
			catch ( Exception x )
			{
				result = defVal;
			}
		}
		return result;
	}

	@Override
	public double getDoubleParameter ( String key, double defVal )
	{
		double result = defVal;
		final String p = getParameter ( key );
		if ( p != null )
		{
			try
			{
				result = rrConvertor.convertToDouble ( p );
			}
			catch ( Exception x )
			{
				result = defVal;
			}
		}
		return result;
	}

	@Override
	public boolean getBooleanParameter ( String key, boolean defVal )
	{
		boolean result = defVal;
		final String p = getParameter ( key );
		if ( p != null )
		{
			try
			{
				result = rrConvertor.convertToBooleanBroad ( p );
			}
			catch ( Exception x )
			{
				result = defVal;
			}
		}
		return result;
	}

	@Override
	public void changeParameter ( String fieldName, String value )
	{
		fParamOverrides.put ( fieldName, new String[] { value } );
	}

	@Override
	public String getActualRemoteAddress ()
	{
		return getActualRemoteAddress ( fRequest );
	}

	@Override
	public String getBestRemoteAddress ()
	{
		return getBestRemoteAddress ( fRequest );
	}

	/**
	 * Get the actual remote addr (which could be a load balancer, for example)
	 * as address:port.
	 *  
	 * @param req
	 * @return
	 */
	public static String getActualRemoteAddress ( HttpServletRequest req )
	{
		return req.getRemoteAddr () + ":" + req.getRemotePort ();
	}

	public static String getBestRemoteAddress ( HttpServletRequest req )
	{
		final String fwdHost = getFirstHeader ( req, "X-Forwarded-For" );
		if ( fwdHost != null )
		{
			return fwdHost + ":" + getFirstHeader ( req, "X-Forwarded-Port" );
		}
		return getActualRemoteAddress ( req );
	}

	public static String getFirstHeader ( HttpServletRequest req, String h )
	{
		List l = getHeader ( req, h );
		return ( l.size () > 0 ) ? l.iterator ().next () : null;
	}

	public static List getHeader ( HttpServletRequest req, String h )
	{
		final LinkedList list = new LinkedList<>();
		final Enumeration e = req.getHeaders ( h );
		while ( e.hasMoreElements () )
		{
			list.add ( e.nextElement ().toString () );
		}
		return list;
	}

	public static Map> getAllHeaders ( HttpServletRequest req )
	{
		final HashMap> result = new HashMap> ();

		final Enumeration names = req.getHeaderNames ();
		if ( names != null )
		{
			while ( names.hasMoreElements () )
			{
				final String headerName = names.nextElement ().toString ();
				final LinkedList list = new LinkedList ();
				result.put ( headerName, list );

				final Enumeration values = req.getHeaders ( headerName );
				if ( values != null )
				{
					while ( values.hasMoreElements () )
					{
						list.add ( values.nextElement ().toString () );
					}
				}
				// else: javadocs say some containers return null.
			}
		}
		// else: javadocs say some containers return null.

		return result;
	}

	private final HttpServletRequest fRequest;
	private final HashMap fParamOverrides;
}