Initial commit

src/main/java/org/scribe/model/Request.java

@@ -0,0 +1,217 @@
+package org.scribe.model;
+
+import java.io.*;
+import java.net.*;
+import java.util.*;
+
+import org.scribe.exceptions.*;
+import org.scribe.utils.*;
+
+/**
+ * Represents an HTTP Request object
+ * 
+ * @author Pablo Fernandez
+ */
+public class Request
+{
+
+  private static final String CONTENT_LENGTH = "Content-Length";
+
+  private String url;
+  private Verb verb;
+  private Map<String, String> bodyParams;
+  private Map<String, String> headers;
+  private String payload = null;
+  private HttpURLConnection connection;
+
+  public Request(Verb verb, String url)
+  {
+    this.verb = verb;
+    this.url = url;
+    this.bodyParams = new HashMap<String, String>();
+    this.headers = new HashMap<String, String>();
+    try
+    {
+      this.connection = (HttpURLConnection) new URL(url).openConnection();
+    } catch (IOException ioe)
+    {
+      throw new OAuthException("Could not open connection to: " + url, ioe);
+    }
+  }
+
+  /**
+   * Execute the request and return a {@link Response}
+   * 
+   * @return Http Response
+   * @throws RuntimeException
+   *           if the connection cannot be created.
+   */
+  public Response send()
+  {
+    try
+    {
+      return doSend();
+    } catch (IOException ioe)
+    {
+      throw new OAuthException("Problems while creating connection", ioe);
+    }
+  }
+
+  Response doSend() throws IOException
+  {
+    connection.setRequestMethod(this.verb.name());
+    addHeaders(connection);
+    if (verb.equals(Verb.PUT) || verb.equals(Verb.POST))
+    {
+      addBody(connection, getBodyContents());
+    }
+    return new Response(connection);
+  }
+
+  void addHeaders(HttpURLConnection conn)
+  {
+    for (String key : headers.keySet())
+      conn.setRequestProperty(key, headers.get(key));
+  }
+
+  void addBody(HttpURLConnection conn, String content) throws IOException
+  {
+    conn.setRequestProperty(CONTENT_LENGTH, String.valueOf(content.getBytes().length));
+    conn.setDoOutput(true);
+    conn.getOutputStream().write(content.getBytes());
+  }
+
+  /**
+   * Add an HTTP Header to the Request
+   * 
+   * @param name
+   * @param value
+   */
+  public void addHeader(String key, String value)
+  {
+    this.headers.put(key, value);
+  }
+
+  /**
+   * Add a body Parameter (for POST/ PUT Requests)
+   * 
+   * @param name
+   * @param value
+   */
+  public void addBodyParameter(String key, String value)
+  {
+    this.bodyParams.put(key, value);
+  }
+
+  /**
+   * Add body payload.
+   * 
+   * This method is used when the HTTP body is not a form-url-encoded string,
+   * but another thing. Like for example XML.
+   * 
+   * Note: The contents are not part of the OAuth signature
+   * 
+   * @param payload
+   */
+  public void addPayload(String payload)
+  {
+    this.payload = payload;
+  }
+
+  /**
+   * Get a {@link Map} of the query string parameters.
+   * 
+   * @return a map containing the query string parameters
+   */
+  public Map<String, String> getQueryStringParams()
+  {
+    try
+    {
+      Map<String, String> params = new HashMap<String, String>();
+      String query = new URL(url).getQuery();
+      if (query != null)
+      {
+        for (String param : query.split("&"))
+        {
+          String pair[] = param.split("=");
+          params.put(pair[0], pair[1]);
+        }
+      }
+      return params;
+    } catch (MalformedURLException mue)
+    {
+      throw new OAuthException("Malformed URL", mue);
+    }
+  }
+
+  /**
+   * Obtains a {@link Map} of the body parameters.
+   * 
+   * @return a map containing the body parameters.
+   */
+  public Map<String, String> getBodyParams()
+  {
+    return bodyParams;
+  }
+
+  /**
+   * Obtains the URL of the HTTP Request.
+   * 
+   * @return the original URL of the HTTP Request
+   */
+  public String getUrl()
+  {
+    return url;
+  }
+
+  /**
+   * Returns the URL without the port and the query string part.
+   * 
+   * @return the OAuth-sanitized URL
+   */
+  public String getSanitizedUrl()
+  {
+    return url.replaceAll("\\?.*", "").replace("\\:\\d{4}", "");
+  }
+
+  public String getBodyContents()
+  {
+    return (payload != null) ? payload : URLUtils.formURLEncodeMap(bodyParams);
+  }
+
+  /**
+   * Returns the HTTP Verb
+   * 
+   * @return the verb
+   */
+  public Verb getVerb()
+  {
+    return verb;
+  }
+
+  public Map<String, String> getHeaders()
+  {
+    return headers;
+  }
+
+  void setConnection(HttpURLConnection connection)
+  {
+    this.connection = connection;
+  }
+
+  @Override
+  public String toString()
+  {
+    return String.format("@Request(%s %s)", getVerb(), getUrl());
+  }
+
+  /**
+   * An enumeration containing the most common HTTP Verbs.
+   * 
+   * @author Pablo Fernandez
+   */
+  public static enum Verb
+  {
+    GET, POST, PUT, DELETE
+  }
+}