Request.java

//*****************************************************************************
//    This file is part of CheckIn4Me.  Copyright � 2010  David Ivins
//
//    CheckIn4Me is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    CheckIn4Me 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with CheckIn4Me.  If not, see <http://www.gnu.org/licenses/>.
//*****************************************************************************
package com.davidivins.checkin4me.util;

import android.util.Log;

import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;

/**
 * Request
 * 
 * @author david ivins
 */
abstract public class Request 
{
	protected static final String TAG      = Request.class.getSimpleName();
	protected static final String ENCODING = "ISO-8859-1";

	protected String method;
	protected String host;
	protected String endpoint;
	protected Map<String, String> headers;
	protected Map<String, String> query_parameters;
	
	/**
	 * Request
	 */
	public Request()
	{
		method = "";
		host = "";
		endpoint = "";
		headers = new HashMap<String, String>();
		query_parameters = new TreeMap<String, String>();
	}
	
	/**
	 * Request
	 * 
	 * @param method
	 * @param host
	 * @param endpoint
	 */
	public Request(String method, String host, String endpoint)
	{
		this.method = method;
		this.host = host;
		this.endpoint = endpoint;
		headers = new HashMap<String, String>();
		query_parameters = new TreeMap<String, String>();	
	}
	
	/**
	 * Request
	 * 
	 * @param request
	 */
	public Request(Request request)
	{
		this.method = request.getMethod();
		this.host = request.getHost();
		this.endpoint = request.getEndpoint();
		
		query_parameters = new TreeMap<String, String>();
		query_parameters.putAll(request.getQueryParameters());
	}
	
	/**
	 * execute
	 * 
	 * @return Response
	 */
	abstract public Response execute();

	/**
	 * setMethod
	 * 
	 * @param method
	 */
	public void setMethod(String method)
	{
		this.method = method;
	}
	
	/**
	 * setHost
	 * 
	 * @param host
	 */
	public void setHost(String host)
	{
		this.host = host;
	}
	
	/**
	 * setEndpoint
	 * 
	 * @param endpoint
	 */
	public void setEndpoint(String endpoint)
	{
		this.endpoint = endpoint;
	}
	
	/**
	 * addHeader
	 * 
	 * @param key
	 * @param value
	 */
	public void addHeader(String key, String value)
	{
		headers.put(key, value);
	}
	
	/**
	 * addQueryParameter
	 * 
	 * @param key
	 * @param value
	 */
	public void addQueryParameter(String key, String value)
	{
		query_parameters.put(key, value.replace(" ", "%20"));
	}
	
	/**
	 * addQueryParameterAndEncode
	 * 
	 * @param key
	 * @param value
	 */
	public void addQueryParameterAndEncode(String key, String value)
	{
		try
		{
			String encoded_value = URLEncoder.encode(value, ENCODING);
			query_parameters.put(key, encoded_value.replace(" ", "%20"));
		}
		catch (Exception e)
		{
			Log.i(TAG, "Encoding doesn't exist!?");
		}
	}
	
	/**
	 * getMethod
	 * 
	 * @return String
	 */
	public String getMethod()
	{
		return method;
	}
	
	/**
	 * getHost
	 * 
	 * @return String
	 */
	public String getHost()
	{
		return host;
	}
	
	/**
	 * getEndpoint
	 * 
	 * @return String
	 */
	public String getEndpoint()
	{
		return endpoint;
	}
	
	/**
	 * getQueryParameters
	 * 
	 * @return TreeMap<String, String>
	 */
	public Map<String, String> getQueryParameters()
	{
		return query_parameters;
	}
	
	/**
	 * getURIQueryParametersAsString
	 * 
	 * @return String
	 */
	protected String getURIQueryParametersAsString()
	{
		String uri_query_parameters = "";
		
		for (String key : query_parameters.keySet())
		{
			if (!uri_query_parameters.equals(""))
				uri_query_parameters += "&";
			
			uri_query_parameters += key + "=" + query_parameters.get(key);
		}
		
		Log.i(TAG, "uri_query_parameters = " + uri_query_parameters);
		return uri_query_parameters;
	}
}