add default HTTP client configs (to use like 'new ServiceBuilder().httpClientConfig(OkHttpHttpClientConfig.defaultConfig())')

kullfar · kullfar · commit 65761bb1bcef · 2016-12-08T18:00:10.000+03:00
diff --git a/changelog b/changelog
@@ -4,6 +4,7 @@
  * add support for byte[] and File (async only) payload in OAuth Requests (thanks to https://github.com/keijohyttinen)
  * add support for  HTTP verbs (thanks to https://github.com/keijohyttinen)
  * add OkHttp http client support (thanks to https://github.com/arcao)
+ * add default HTTP client configs (to use like 'new ServiceBuilder().httpClientConfig(OkHttpHttpClientConfig.defaultConfig())')
 
 [3.3.0]
  * update Facebook v2.6 -> v2.8
diff --git a/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/GitHubAsyncOkHttpExample.java b/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/GitHubAsyncOkHttpExample.java
@@ -8,7 +8,6 @@
 import com.github.scribejava.core.model.Verb;
 import com.github.scribejava.core.oauth.OAuth20Service;
 import com.github.scribejava.httpclient.okhttp.OkHttpHttpClientConfig;
-import okhttp3.OkHttpClient;
 
 import java.io.IOException;
 import java.util.Random;
@@ -28,13 +27,12 @@ public static void main(String... args) throws IOException, ExecutionException,
         final String clientId = "your client id";
         final String clientSecret = "your client secret";
         final String secretState = "secret" + new Random().nextInt(999_999);
-        final OkHttpClient.Builder okHttpBuilder = new OkHttpClient.Builder();
         final OAuth20Service service = new ServiceBuilder()
                 .apiKey(clientId)
                 .apiSecret(clientSecret)
                 .state(secretState)
                 .callback("http://www.example.com/oauth_callback/")
-                .httpClientConfig(new OkHttpHttpClientConfig(okHttpBuilder))
+                .httpClientConfig(OkHttpHttpClientConfig.defaultConfig())
                 .build(GitHubApi.instance());
         final Scanner in = new Scanner(System.in, "UTF-8");
 
diff --git a/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/Google20AsyncAHCExample.java b/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/Google20AsyncAHCExample.java
@@ -6,7 +6,7 @@
 import com.github.scribejava.httpclient.ahc.AhcHttpClientConfig;
 import com.github.scribejava.core.builder.ServiceBuilder;
 import com.github.scribejava.core.model.ForceTypeOfHttpRequest;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthRequestAsync;
 import com.github.scribejava.core.model.Response;
@@ -33,7 +33,7 @@ public static void main(String... args) throws InterruptedException, ExecutionEx
         final String clientSecret = "your client secret";
         final String secretState = "secret" + new Random().nextInt(999_999);
         ScribeJavaConfig.setForceTypeOfHttpRequests(ForceTypeOfHttpRequest.FORCE_ASYNC_ONLY_HTTP_REQUESTS);
-        final HttpClient.Config clientConfig = new AhcHttpClientConfig(new DefaultAsyncHttpClientConfig.Builder()
+        final HttpClientConfig clientConfig = new AhcHttpClientConfig(new DefaultAsyncHttpClientConfig.Builder()
                 .setMaxConnections(5)
                 .setRequestTimeout(10_000)
                 .setPooledConnectionIdleTimeout(1_000)
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilder.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilder.java
@@ -1,7 +1,8 @@
 package com.github.scribejava.core.builder;
 
 import com.github.scribejava.core.builder.api.BaseApi;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthConstants;
 import com.github.scribejava.core.model.SignatureType;
@@ -30,7 +31,7 @@ public class ServiceBuilder {
     private Integer readTimeout;
 
     //not-default httpclient only
-    private HttpClient.Config httpClientConfig;
+    private HttpClientConfig httpClientConfig;
     private HttpClient httpClient;
 
     public ServiceBuilder() {
@@ -134,7 +135,19 @@ public ServiceBuilder readTimeout(Integer readTimeout) {
         return this;
     }
 
-    public ServiceBuilder httpClientConfig(HttpClient.Config httpClientConfig) {
+    /**
+     * throws UnsupportedOperationException
+     *
+     * @param httpClientConfig httpClientConfig
+     * @return never
+     * @deprecated use {@link #httpClientConfig(com.github.scribejava.core.httpclient.HttpClientConfig)}
+     */
+    @Deprecated
+    public ServiceBuilder httpClientConfig(com.github.scribejava.core.model.HttpClient.Config httpClientConfig) {
+        throw new UnsupportedOperationException("deprecated, use another method, see javadocs");
+    }
+
+    public ServiceBuilder httpClientConfig(HttpClientConfig httpClientConfig) {
         Preconditions.checkNotNull(httpClientConfig, "httpClientConfig can't be null");
         this.httpClientConfig = httpClientConfig;
         return this;
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClient.java b/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClient.java
@@ -0,0 +1,26 @@
+package com.github.scribejava.core.httpclient;
+
+import com.github.scribejava.core.model.OAuthAsyncRequestCallback;
+import com.github.scribejava.core.model.OAuthRequestAsync;
+import com.github.scribejava.core.model.Verb;
+import java.io.File;
+import java.io.IOException;
+import java.util.Map;
+import java.util.concurrent.Future;
+
+public interface HttpClient {
+
+    void close() throws IOException;
+
+    <T> Future<T> executeAsync(String userAgent, Map<String, String> headers, Verb httpVerb, String completeUrl,
+            byte[] bodyContents, OAuthAsyncRequestCallback<T> callback,
+            OAuthRequestAsync.ResponseConverter<T> converter);
+
+    <T> Future<T> executeAsync(String userAgent, Map<String, String> headers, Verb httpVerb, String completeUrl,
+            String bodyContents, OAuthAsyncRequestCallback<T> callback,
+            OAuthRequestAsync.ResponseConverter<T> converter);
+
+    <T> Future<T> executeAsync(String userAgent, Map<String, String> headers, Verb httpVerb, String completeUrl,
+            File bodyContents, OAuthAsyncRequestCallback<T> callback, OAuthRequestAsync.ResponseConverter<T> converter);
+
+}
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClientConfig.java b/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClientConfig.java
@@ -0,0 +1,6 @@
+package com.github.scribejava.core.httpclient;
+
+public interface HttpClientConfig {
+
+    HttpClientConfig createDefaultConfig();
+}
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClientProvider.java b/scribejava-core/src/main/java/com/github/scribejava/core/httpclient/HttpClientProvider.java
@@ -1,8 +1,6 @@
 package com.github.scribejava.core.httpclient;
 
-import com.github.scribejava.core.model.HttpClient;
-
 public interface HttpClientProvider {
 
-    HttpClient createClient(HttpClient.Config httpClientConfig);
+    HttpClient createClient(HttpClientConfig httpClientConfig);
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/HttpClient.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/HttpClient.java
@@ -5,6 +5,11 @@
 import java.util.Map;
 import java.util.concurrent.Future;
 
+/**
+ *
+ * @deprecated use {@link com.github.scribejava.core.httpclient.HttpClient}
+ */
+@Deprecated
 public interface HttpClient {
 
     void close() throws IOException;
@@ -20,6 +25,12 @@ <T> Future<T> executeAsync(String userAgent, Map<String, String> headers, Verb h
     <T> Future<T> executeAsync(String userAgent, Map<String, String> headers, Verb httpVerb, String completeUrl,
             File bodyContents, OAuthAsyncRequestCallback<T> callback, OAuthRequestAsync.ResponseConverter<T> converter);
 
+    /**
+     *
+     * @deprecated use {@link com.github.scribejava.core.httpclient.HttpClientConfig}
+     */
+    @Deprecated
     interface Config {
+
     }
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuthConfig.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuthConfig.java
@@ -1,5 +1,6 @@
 package com.github.scribejava.core.model;
 
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import java.io.IOException;
 import java.io.OutputStream;
 
@@ -23,16 +24,46 @@ public class OAuthConfig {
     private final Integer readTimeout;
 
     //async version only
-    private HttpClient.Config httpClientConfig;
-    private HttpClient httpClient;
+    private HttpClientConfig httpClientConfig;
+    private com.github.scribejava.core.httpclient.HttpClient httpClient;
 
     public OAuthConfig(String key, String secret) {
-        this(key, secret, null, null, null, null, null, null, null, null, null, null, null);
+        this(key, secret, null, null, null, null, null, null, null, null, null, (HttpClientConfig) null, null);
     }
 
+    /**
+     * throws UnsupportedOperationException
+     *
+     * @param apiKey apiKey
+     * @param apiSecret apiSecret
+     * @param callback callback
+     * @param signatureType signatureType
+     * @param scope scope
+     * @param debugStream debugStream
+     * @param state state
+     * @param responseType responseType
+     * @param userAgent userAgent
+     * @param connectTimeout connectTimeout
+     * @param readTimeout readTimeout
+     * @param httpClientConfig httpClientConfig
+     * @param httpClient httpClient
+     * @deprecated use
+     * {@link #OAuthConfig(java.lang.String, java.lang.String, java.lang.String,
+     * com.github.scribejava.core.model.SignatureType, java.lang.String, java.io.OutputStream, java.lang.String,
+     * java.lang.String, java.lang.String, java.lang.Integer, java.lang.Integer,
+     * com.github.scribejava.core.httpclient.HttpClientConfig, com.github.scribejava.core.httpclient.HttpClient)}
+     */
+    @Deprecated
     public OAuthConfig(String apiKey, String apiSecret, String callback, SignatureType signatureType, String scope,
             OutputStream debugStream, String state, String responseType, String userAgent, Integer connectTimeout,
             Integer readTimeout, HttpClient.Config httpClientConfig, HttpClient httpClient) {
+        throw new UnsupportedOperationException("deprecated, use another method, see javadocs");
+    }
+
+    public OAuthConfig(String apiKey, String apiSecret, String callback, SignatureType signatureType, String scope,
+            OutputStream debugStream, String state, String responseType, String userAgent, Integer connectTimeout,
+            Integer readTimeout, HttpClientConfig httpClientConfig,
+            com.github.scribejava.core.httpclient.HttpClient httpClient) {
         this.apiKey = apiKey;
         this.apiSecret = apiSecret;
         this.callback = callback;
@@ -99,11 +130,11 @@ public Integer getReadTimeout() {
         return readTimeout;
     }
 
-    public HttpClient.Config getHttpClientConfig() {
+    public HttpClientConfig getHttpClientConfig() {
         return httpClientConfig;
     }
 
-    public HttpClient getHttpClient() {
+    public com.github.scribejava.core.httpclient.HttpClient getHttpClient() {
         return httpClient;
     }
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuthService.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuthService.java
@@ -4,7 +4,8 @@
 import com.github.scribejava.core.httpclient.HttpClientProvider;
 import com.github.scribejava.core.model.AbstractRequest;
 import com.github.scribejava.core.model.ForceTypeOfHttpRequest;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import com.github.scribejava.core.model.OAuthAsyncRequestCallback;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthRequest;
@@ -34,7 +35,7 @@ public abstract class OAuthService<T extends Token> {
     public OAuthService(OAuthConfig config) {
         this.config = config;
         final ForceTypeOfHttpRequest forceTypeOfHttpRequest = ScribeJavaConfig.getForceTypeOfHttpRequests();
-        final HttpClient.Config httpClientConfig = config.getHttpClientConfig();
+        final HttpClientConfig httpClientConfig = config.getHttpClientConfig();
         final HttpClient externalHttpClient = config.getHttpClient();
 
         if (httpClientConfig == null && externalHttpClient == null) {
@@ -57,7 +58,7 @@ public OAuthService(OAuthConfig config) {
         }
     }
 
-    private static HttpClient getClient(HttpClient.Config config) {
+    private static HttpClient getClient(HttpClientConfig config) {
         for (HttpClientProvider provider : ServiceLoader.load(HttpClientProvider.class)) {
             final HttpClient client = provider.createClient(config);
             if (client != null) {
diff --git a/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcHttpClient.java b/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcHttpClient.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.httpclient.ahc;
 
 import com.github.scribejava.core.model.AbstractRequest;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClient;
 import com.github.scribejava.core.model.OAuthAsyncRequestCallback;
 import com.github.scribejava.core.model.OAuthConstants;
 import com.github.scribejava.core.model.OAuthRequestAsync;
@@ -15,14 +15,16 @@
 
 import static com.github.scribejava.core.model.AbstractRequest.DEFAULT_CONTENT_TYPE;
 import java.io.File;
+import org.asynchttpclient.AsyncHttpClientConfig;
 import org.asynchttpclient.BoundRequestBuilder;
 
 public class AhcHttpClient implements HttpClient {
 
     private final AsyncHttpClient client;
 
     public AhcHttpClient(AhcHttpClientConfig ahcConfig) {
-        client = new DefaultAsyncHttpClient(ahcConfig.getClientConfig());
+        final AsyncHttpClientConfig clientConfig = ahcConfig.getClientConfig();
+        client = clientConfig == null ? new DefaultAsyncHttpClient() : new DefaultAsyncHttpClient(clientConfig);
     }
 
     public AhcHttpClient(DefaultAsyncHttpClient ahcClient) {
diff --git a/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcHttpClientConfig.java b/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcHttpClientConfig.java
@@ -1,9 +1,9 @@
 package com.github.scribejava.httpclient.ahc;
 
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import org.asynchttpclient.AsyncHttpClientConfig;
 
-public class AhcHttpClientConfig implements HttpClient.Config {
+public class AhcHttpClientConfig implements HttpClientConfig {
 
     private final AsyncHttpClientConfig clientConfig;
 
@@ -14,4 +14,13 @@ public AhcHttpClientConfig(AsyncHttpClientConfig clientConfig) {
     public AsyncHttpClientConfig getClientConfig() {
         return clientConfig;
     }
+
+    @Override
+    public HttpClientConfig createDefaultConfig() {
+        return defaultConfig();
+    }
+
+    public static HttpClientConfig defaultConfig() {
+        return new AhcHttpClientConfig(null);
+    }
 }
diff --git a/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcProvider.java b/scribejava-httpclient-ahc/src/main/java/com/github/scribejava/httpclient/ahc/AhcProvider.java
@@ -1,12 +1,13 @@
 package com.github.scribejava.httpclient.ahc;
 
 import com.github.scribejava.core.httpclient.HttpClientProvider;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 
 public class AhcProvider implements HttpClientProvider {
 
     @Override
-    public HttpClient createClient(HttpClient.Config config) {
+    public HttpClient createClient(HttpClientConfig config) {
         if (config instanceof AhcHttpClientConfig) {
             return new AhcHttpClient((AhcHttpClientConfig) config);
         }
diff --git a/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingHttpClient.java b/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingHttpClient.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.httpclient.ning;
 
 import com.github.scribejava.core.model.AbstractRequest;
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClient;
 import com.github.scribejava.core.model.OAuthAsyncRequestCallback;
 import com.github.scribejava.core.model.OAuthConstants;
 import com.github.scribejava.core.model.OAuthRequestAsync;
@@ -12,6 +12,7 @@
 import java.util.concurrent.Future;
 
 import static com.github.scribejava.core.model.AbstractRequest.DEFAULT_CONTENT_TYPE;
+import com.ning.http.client.AsyncHttpClientConfig;
 import java.io.File;
 
 public class NingHttpClient implements HttpClient {
@@ -20,8 +21,15 @@ public class NingHttpClient implements HttpClient {
 
     public NingHttpClient(NingHttpClientConfig ningConfig) {
         final String ningAsyncHttpProviderClassName = ningConfig.getNingAsyncHttpProviderClassName();
-        client = ningAsyncHttpProviderClassName == null ? new AsyncHttpClient(ningConfig.getConfig())
-                : new AsyncHttpClient(ningAsyncHttpProviderClassName, ningConfig.getConfig());
+        AsyncHttpClientConfig config = ningConfig.getConfig();
+        if (ningAsyncHttpProviderClassName == null) {
+            client = config == null ? new AsyncHttpClient() : new AsyncHttpClient(config);
+        } else {
+            if (config == null) {
+                config = new AsyncHttpClientConfig.Builder().build();
+            }
+            client = new AsyncHttpClient(ningAsyncHttpProviderClassName, config);
+        }
     }
 
     public NingHttpClient(AsyncHttpClient client) {
diff --git a/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingHttpClientConfig.java b/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingHttpClientConfig.java
@@ -1,9 +1,9 @@
 package com.github.scribejava.httpclient.ning;
 
-import com.github.scribejava.core.model.HttpClient;
+import com.github.scribejava.core.httpclient.HttpClientConfig;
 import com.ning.http.client.AsyncHttpClientConfig;
 
-public class NingHttpClientConfig implements HttpClient.Config {
+public class NingHttpClientConfig implements HttpClientConfig {
 
     private final AsyncHttpClientConfig config;
     private String ningAsyncHttpProviderClassName;
@@ -23,4 +23,13 @@ public void setNingAsyncHttpProviderClassName(String ningAsyncHttpProviderClassN
     public AsyncHttpClientConfig getConfig() {
         return config;
     }
+
+    @Override
+    public HttpClientConfig createDefaultConfig() {
+        return defaultConfig();
+    }
+
+    public static HttpClientConfig defaultConfig() {
+        return new NingHttpClientConfig(null);
+    }
 }
diff --git a/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingProvider.java b/scribejava-httpclient-ning/src/main/java/com/github/scribejava/httpclient/ning/NingProvider.java
diff --git a/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClient.java b/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClient.java
diff --git a/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientConfig.java b/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientConfig.java
diff --git a/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpProvider.java b/scribejava-httpclient-okhttp/src/main/java/com/github/scribejava/httpclient/okhttp/OkHttpProvider.java
diff --git a/scribejava-httpclient-okhttp/src/test/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientTest.java b/scribejava-httpclient-okhttp/src/test/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`package com.github.scribejava.core.httpclient;`
`2`	`2`
`3`		`-import com.github.scribejava.core.model.HttpClient;`
`4`		`-`
`5`	`3`	`public interface HttpClientProvider {`
`6`	`4`
`7`		`- HttpClient createClient(HttpClient.Config httpClientConfig);`
	`5`	`+ HttpClient createClient(HttpClientConfig httpClientConfig);`
`8`	`6`	`}`