RequestModel.java

/**
 * 
 */
package com.microtripit.mandrillapp.lutung.model;

import java.io.IOException;
import java.io.InputStream;
import java.util.Map;

import org.apache.http.client.methods.HttpRequestBase;

/**
 * 
 * @author rschreijer
 * @since Jan 7, 2013
 * @param <V> The type that response-data/ response-content is parsed to.
 */
public interface RequestModel<V> {
	
	/**
	 * @return The url for this request, as {@link String}.
	 */
	public String getUrl();

	/**
	 * @return The request object describing the request to 
	 * be made w/ a http client.
	 * @throws IOException
	 * @since Mar 22, 2013
	 */
	public HttpRequestBase getRequest() throws IOException;
	
	/**
	 * <p>Checks weather the response-status is as-expected 
	 * for this request.</p>
	 * @param httpResponseStatus The HTTP response status
	 * @return <code>true</code> if the response status is as expected,
	 * <code>false</code> otherwise.
	 */
	public boolean validateResponseStatus(int httpResponseStatus);
	
	/**
	 * <p>Parses the content/data of this request's response into
	 * a desired format {@link V}.
	 * @param is
	 * @return
	 * @throws HandleResponseException
	 */
	public V handleResponse(InputStream is) throws HandleResponseException;
	
}