Change functionality in HttpRequest and HttpExecutor (#24)

- HttpRequest is now mockable by defining new ways of
  initializing the class.
- HttpMethod can now be set after initializing as well.
  This makes it possible for spring to autowire in a class
  while different member functions still can execute
  different types of requests.
- Headers can now be set in request body.
- URI can now be retrieved from HttpRequest.

Author: erik-edling

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.github.ericsson</groupId>
     <artifactId>eiffel-commons-java</artifactId>
-    <version>0.0.13</version>
+    <version>0.0.15</version>
 
     <name>eiffel commons java</name>
     <description>A shared library for eiffel components</description>

src/main/java/com/ericsson/eiffelcommons/utils/HttpExecutor.java

@@ -24,7 +24,7 @@
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClientBuilder;
 
-public final class HttpExecutor {
+public class HttpExecutor {
 
     private static HttpExecutor instance;
     private CloseableHttpClient client = HttpClientBuilder.create()
@@ -34,6 +34,10 @@ public HttpExecutor() {
 
     }
 
+    public HttpExecutor(CloseableHttpClient client) {
+        this.client = client;
+    }
+
     public static HttpExecutor getInstance() {
         if (instance == null) {
             instance = new HttpExecutor();

src/main/java/com/ericsson/eiffelcommons/utils/HttpRequest.java

@@ -13,16 +13,18 @@
    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.ericsson.eiffelcommons.utils;
 
 import java.io.File;
 import java.io.IOException;
+import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.commons.io.FileUtils;
+import org.apache.http.Header;
 import org.apache.http.client.ClientProtocolException;
 import org.apache.http.client.methods.HttpDelete;
 import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
@@ -31,7 +33,9 @@
 import org.apache.http.client.methods.HttpPut;
 import org.apache.http.client.methods.HttpRequestBase;
 import org.apache.http.client.utils.URIBuilder;
+import org.apache.http.entity.ContentType;
 import org.apache.http.entity.StringEntity;
+import org.apache.http.message.BasicHeader;
 
 import lombok.Getter;
 import lombok.Setter;
@@ -56,28 +60,23 @@ public enum HttpMethod {
     @Getter
     protected Map<String, String> params;
 
+    public HttpRequest() {
+        params = new HashMap<>();
+        initExecutor(false);
+    }
+
     public HttpRequest(HttpMethod method) {
         this(method, false);
     }
 
+    public HttpRequest(HttpMethod method, HttpExecutor executor) {
+        this(method, false);
+        this.executor = executor;
+    }
+
     public HttpRequest(HttpMethod method, boolean persistentClient) {
         params = new HashMap<>();
-
-        switch (method) {
-            case POST:
-                request = new HttpPost();
-                break;
-            case GET:
-                request = new HttpGet();
-                break;
-            case DELETE:
-                request = new HttpDelete();
-                break;
-            case PUT:
-                request = new HttpPut();
-                break;
-        }
-
+        setHttpMethod(method);
         initExecutor(persistentClient);
     }
 
@@ -89,6 +88,29 @@ private void initExecutor(boolean persistentClient) {
         }
     }
 
+    /**
+     * Sets the http method for this request object
+     * @param method
+     */
+    public HttpRequest setHttpMethod(HttpMethod method) {
+        switch (method) {
+        case POST:
+            request = new HttpPost();
+            break;
+        case GET:
+            request = new HttpGet();
+            break;
+        case DELETE:
+            request = new HttpDelete();
+            break;
+        case PUT:
+            request = new HttpPut();
+            break;
+        }
+
+        return this;
+    }
+
     /**
      * Gets the base url(not including endpoint) for example: http://localhost:8080
      * @return String
@@ -129,12 +151,24 @@ public void resetHttpRequestObject() {
      *            :: the key of the header
      * @param value
      *            :: the value of the header
-     * @return
+     * @return HttpRequest
      */
     public HttpRequest addHeader(String key, String value) {
         request.addHeader(key, value);
         return this;
     }
+    /**
+     * Function that overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.
+     *
+     * @param key
+     * @param value
+     * @return HttpRequest
+     */
+    public HttpRequest setHeader(String key, String value) {
+        Header header = new BasicHeader(key, value);
+        request.setHeader(header);
+        return this;
+    }
 
     /**
      * Takes a header key as input and removes that key and value from the list of headers.
@@ -165,34 +199,60 @@ public void addParameters(Map<String, String> parameters) {
      *            :: the key of the parameter
      * @param value
      *            :: the value of the parameter
-     * @return
+     * @return HttpRequest
      */
     public HttpRequest addParam(String key, String value) {
         params.put(key, value);
         return this;
     }
 
     /**
-     * Function that sets the body of the http request.
+     * Function that sets the body of the http request with a chosen content type.
+     *
+     * @param body
+     *            :: String input
+     * @return HTTPRequest
+     */
+    public HttpRequest setBody(String body, ContentType contentType) {
+        ((HttpEntityEnclosingRequestBase) request).setEntity(new StringEntity(body, contentType));
+        return this;
+    }
+
+    /**
+     * Function that sets the body of the http request with default content type(text/plain).
      *
      * @param body
      *            :: String input
      * @return HTTPRequest
      */
     public HttpRequest setBody(String body) {
-        ((HttpEntityEnclosingRequestBase) request).setEntity(new StringEntity(body, "UTF-8"));
+        setBody(body, ContentType.TEXT_PLAIN);
         return this;
     }
 
     /**
-     * Function that sets the body of the http request.
+     * Function that sets the body of the http request with default value of content type (text/plain).
      *
      * @param file
      *            :: File input
      * @return HTTPRequest
      * @throws IOException
      */
     public HttpRequest setBody(File file) throws IOException {
+        setBody(file, ContentType.TEXT_PLAIN);
+        return this;
+    }
+
+    /**
+     * Function that sets the body of the http request with a chosen content type.
+     *
+     * @param file
+     *            :: File input
+     * @param type
+     * @return HTTPRequest
+     * @throws IOException
+     */
+    public HttpRequest setBody(File file, ContentType contentType) throws IOException {
         String fileContent = "";
         try {
             fileContent = FileUtils.readFileToString(file, "UTF-8");
@@ -201,7 +261,7 @@ public HttpRequest setBody(File file) throws IOException {
                     + e.getMessage();
             throw new IOException(message);
         }
-        return setBody(fileContent);
+        return setBody(fileContent, contentType);
     }
 
     /**
@@ -215,11 +275,21 @@ public HttpRequest setBody(File file) throws IOException {
     public ResponseEntity performRequest() throws URISyntaxException, ClientProtocolException, IOException {
         URIBuilder builder = createURIBuilder();
         builder = addParametersToURIBuilder(builder);
-
         request.setURI(builder.build());
         return executor.executeRequest(request);
     }
 
+    /**
+     * Function that returns the URI of the request.
+     *
+     * @return URI
+     * @throws URISyntaxException
+     */
+    public URI getURI() throws URISyntaxException {
+        URIBuilder builder = createURIBuilder();
+        return builder.build();
+    }
+
     /**
      * Function that adds parameters to the URIBuilder
      *