Add method for setting default HTTP headers for all requests #22

Author: gjs29

src/main/java/com/ibm/watson/developer_cloud/service/WatsonService.java

@@ -16,6 +16,7 @@
 import java.io.IOException;
 import java.net.CookieManager;
 import java.net.CookiePolicy;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -50,10 +51,11 @@ public abstract class WatsonService {
   private final OkHttpClient client;
   private String endPoint;
   private final String name;
+  private Headers defaultHeaders = null;
 
   /**
    * Instantiates a new Watson service.
-   * 
+   *
    * @param name the service name
    */
   public WatsonService(String name) {
@@ -96,6 +98,11 @@ protected Response execute(Request request) {
       builder.url(RequestUtil.replaceEndPoint(request.urlString(), getEndPoint()));
     }
 
+    // Set default headers
+    if (defaultHeaders != null) {
+      builder.headers(defaultHeaders);
+    }
+
     // Set User-Agent
     builder.header(HttpHeaders.USER_AGENT, getUserAgent());
 
@@ -299,9 +306,17 @@ public void setUsernameAndPassword(String username, String password) {
     apiKey = Credentials.basic(username, password);
   }
 
+  /**
+   * Set the default headers to be used on every HTTP request.
+   * @param headers name value pairs of headers
+   */
+  public void setDefaultHeaders(Map<String, String> headers) {
+    defaultHeaders = Headers.of(headers);
+  }
+
   /*
    * (non-Javadoc)
-   * 
+   *
    * @see java.lang.Object#toString()
    */
   @Override

src/test/java/com/ibm/watson/developer_cloud/service/GenericServiceTest.java

@@ -13,19 +13,24 @@
  */
 package com.ibm.watson.developer_cloud.service;
 
-import static org.mockserver.integration.ClientAndServer.startClientAndServer;
-import static org.mockserver.model.HttpRequest.request;
-import static org.mockserver.model.HttpResponse.response;
+import static org.mockserver.integration.ClientAndServer.*;
+import static org.mockserver.model.HttpRequest.*;
+import static org.mockserver.model.HttpResponse.*;
 
+import java.util.HashMap;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.mockserver.integration.ClientAndServer;
+import org.mockserver.model.Header;
+import org.mockserver.model.HttpRequest;
 
 import com.ibm.watson.developer_cloud.WatsonServiceTest;
+import com.ibm.watson.developer_cloud.http.HttpHeaders;
 import com.ibm.watson.developer_cloud.personality_insights.v2.PersonalityInsights;
 import com.ibm.watson.developer_cloud.personality_insights.v2.PersonalityInsightsTest;
 
@@ -64,6 +69,14 @@ private void mockAPICallWithError(int code, String errorMessage) {
             "{\"code\":" + code + ", \"error\":\"" + errorMessage + "\"}"));
   }
 
+  /**
+   * Mock a successful PersonalityInsights call.
+   */
+  private void mockAPICall() {
+    mockServer.when(request().withMethod(POST).withPath(GET_PROFILE_PATH)).respond(
+        response().withStatusCode(200).withBody("{}"));
+  }
+
   /**
    * Service unavailable exception.
    */
@@ -188,4 +201,27 @@ public void testUnsupportedException() {
     service.getProfile(sampleText);
   }
 
+  @Test
+  public void testUserAgentIsSet() {
+    mockAPICall();
+    service.getProfile(sampleText);
+    mockServer.verify(new HttpRequest().withMethod("POST")
+        .withHeader(new Header(HttpHeaders.USER_AGENT, "watson-developer-cloud-java-sdk-2.1.0")));
+  }
+
+  @Test
+  public void testDefaultHeadersAreSet() {
+    final Map<String, String> headers = new HashMap<String, String>();
+    headers.put("name1", "value1");
+    headers.put("name2", "value2");
+
+    final Header expectedHeader1 = new Header("name1", "value1");
+    final Header expectedHeader2 = new Header("name2", "value2");
+
+    service.setDefaultHeaders(headers);
+    mockAPICall();
+    service.getProfile(sampleText);
+    mockServer.verify(new HttpRequest().withMethod("POST")
+        .withHeader(expectedHeader1).withHeader(expectedHeader2));
+  }
 }