#29 - Rename methods on HttpClientContext to be consistent with under…

…lying HttpClient
avaje · Jul 7, 2021 · 7d4ef79 · 7d4ef79
1 parent c7539d0
commit 7d4ef79
Show file tree

Hide file tree

Showing 15 changed files with 85 additions and 86 deletions.
diff --git a/client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java b/client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java
@@ -40,103 +40,103 @@ class DHttpClientContextBuilder implements HttpClientContext.Builder {
   }
 
   @Override
-  public HttpClientContext.Builder with(HttpClient client) {
+  public HttpClientContext.Builder client(HttpClient client) {
     this.client = client;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withBaseUrl(String baseUrl) {
+  public HttpClientContext.Builder baseUrl(String baseUrl) {
     this.baseUrl = baseUrl;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withRequestTimeout(Duration requestTimeout) {
+  public HttpClientContext.Builder requestTimeout(Duration requestTimeout) {
     this.requestTimeout = requestTimeout;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withBodyAdapter(BodyAdapter adapter) {
+  public HttpClientContext.Builder bodyAdapter(BodyAdapter adapter) {
     this.bodyAdapter = adapter;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withRetryHandler(RetryHandler retryHandler) {
+  public HttpClientContext.Builder retryHandler(RetryHandler retryHandler) {
     this.retryHandler = retryHandler;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withRequestListener(RequestListener requestListener) {
+  public HttpClientContext.Builder requestListener(RequestListener requestListener) {
     this.listeners.add(requestListener);
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withRequestIntercept(RequestIntercept requestIntercept) {
+  public HttpClientContext.Builder requestIntercept(RequestIntercept requestIntercept) {
     this.interceptors.add(requestIntercept);
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withAuthTokenProvider(AuthTokenProvider authTokenProvider) {
+  public HttpClientContext.Builder authTokenProvider(AuthTokenProvider authTokenProvider) {
     this.authTokenProvider = authTokenProvider;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withCookieHandler(CookieHandler cookieHandler) {
+  public HttpClientContext.Builder cookieHandler(CookieHandler cookieHandler) {
     this.cookieHandler = cookieHandler;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withRedirect(HttpClient.Redirect redirect) {
+  public HttpClientContext.Builder redirect(HttpClient.Redirect redirect) {
     this.redirect = redirect;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withVersion(HttpClient.Version version) {
+  public HttpClientContext.Builder version(HttpClient.Version version) {
     this.version = version;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withExecutor(Executor executor) {
+  public HttpClientContext.Builder executor(Executor executor) {
     this.executor = executor;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withProxy(ProxySelector proxySelector) {
+  public HttpClientContext.Builder proxy(ProxySelector proxySelector) {
     this.proxy = proxySelector;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withSSLContext(SSLContext sslContext) {
+  public HttpClientContext.Builder sslContext(SSLContext sslContext) {
     this.sslContext = sslContext;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withSSLParameters(SSLParameters sslParameters) {
+  public HttpClientContext.Builder sslParameters(SSLParameters sslParameters) {
     this.sslParameters = sslParameters;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withAuthenticator(Authenticator authenticator) {
+  public HttpClientContext.Builder authenticator(Authenticator authenticator) {
     this.authenticator = authenticator;
     return this;
   }
 
   @Override
-  public HttpClientContext.Builder withPriority(int priority) {
+  public HttpClientContext.Builder priority(int priority) {
     this.priority = priority;
     return this;
   }

diff --git a/client/src/main/java/io/avaje/http/client/HttpClientContext.java b/client/src/main/java/io/avaje/http/client/HttpClientContext.java
@@ -16,9 +16,9 @@
  * <pre>{@code
  *
  *   HttpClientContext ctx = HttpClientContext.newBuilder()
- *       .withBaseUrl("http://localhost:8080")
- *       .withRequestListener(new RequestLogger())
- *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+ *       .baseUrl("http://localhost:8080")
+ *       .requestListener(new RequestLogger())
+ *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
  *       .build();
  *
  *  HelloDto dto = ctx.request()
@@ -38,9 +38,9 @@ public interface HttpClientContext {
    * <pre>{@code
    *
    *   HttpClientContext ctx = HttpClientContext.newBuilder()
-   *       .withBaseUrl("http://localhost:8080")
-   *       .withRequestListener(new RequestLogger())
-   *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+   *       .baseUrl("http://localhost:8080")
+   *       .requestListener(new RequestLogger())
+   *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
    *       .build();
    *
    *  HttpResponse<String> res = ctx.request()
@@ -123,9 +123,9 @@ static HttpClientContext.Builder newBuilder() {
    * <pre>{@code
    *
    *   HttpClientContext ctx = HttpClientContext.newBuilder()
-   *       .withBaseUrl("http://localhost:8080")
-   *       .withRequestListener(new RequestLogger())
-   *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+   *       .baseUrl("http://localhost:8080")
+   *       .requestListener(new RequestLogger())
+   *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
    *       .build();
    *
    *  HelloDto dto = ctx.request()
@@ -144,32 +144,32 @@ interface Builder {
      * <p>
      * Used when we wish to control all options of the HttpClient.
      */
-    Builder with(HttpClient client);
+    Builder client(HttpClient client);
 
     /**
      * Set the base URL to use for requests created from the context.
      * <p>
      * Note that the base url can be replaced via {@link HttpClientRequest#url(String)}.
      */
-    Builder withBaseUrl(String baseUrl);
+    Builder baseUrl(String baseUrl);
 
     /**
      * Set the default request timeout.
      *
      * @see java.net.http.HttpRequest.Builder#timeout(Duration)
      */
-    Builder withRequestTimeout(Duration requestTimeout);
+    Builder requestTimeout(Duration requestTimeout);
 
     /**
      * Set the body adapter to use to convert beans to body content
      * and response content back to beans.
      */
-    Builder withBodyAdapter(BodyAdapter adapter);
+    Builder bodyAdapter(BodyAdapter adapter);
 
     /**
      * Set a RetryHandler to use to retry requests.
      */
-    Builder withRetryHandler(RetryHandler retryHandler);
+    Builder retryHandler(RetryHandler retryHandler);
 
     /**
      * Add a request listener. Multiple listeners may be added, when
@@ -179,12 +179,12 @@ interface Builder {
      * implementation for debug logging request/response headers and
      * content.
      */
-    Builder withRequestListener(RequestListener requestListener);
+    Builder requestListener(RequestListener requestListener);
 
     /**
      * Add a request interceptor. Multiple interceptors may be added.
      */
-    Builder withRequestIntercept(RequestIntercept requestIntercept);
+    Builder requestIntercept(RequestIntercept requestIntercept);
 
     /**
      * Add a Authorization token provider.
@@ -196,81 +196,81 @@ interface Builder {
      * is automatically called as needed and the Authorization Bearer header set
      * on all requests (not marked with skipAuthToken()).
      */
-    Builder withAuthTokenProvider(AuthTokenProvider authTokenProvider);
+    Builder authTokenProvider(AuthTokenProvider authTokenProvider);
 
     /**
      * Specify a cookie handler to use on the HttpClient. This would override the default cookie handler.
      *
      * @see HttpClient.Builder#cookieHandler(CookieHandler)
      */
-    Builder withCookieHandler(CookieHandler cookieHandler);
+    Builder cookieHandler(CookieHandler cookieHandler);
 
     /**
      * Specify the redirect policy. Defaults to HttpClient.Redirect.NORMAL.
      *
      * @see HttpClient.Builder#followRedirects(HttpClient.Redirect)
      */
-    Builder withRedirect(HttpClient.Redirect redirect);
+    Builder redirect(HttpClient.Redirect redirect);
 
     /**
      * Specify the HTTP version. Defaults to not set.
      *
      * @see HttpClient.Builder#version(HttpClient.Version)
      */
-    Builder withVersion(HttpClient.Version version);
+    Builder version(HttpClient.Version version);
 
     /**
      * Specify the Executor to use for asynchronous tasks.
      * If not specified a default executor will be used.
      *
      * @see HttpClient.Builder#executor(Executor)
      */
-    Builder withExecutor(Executor executor);
+    Builder executor(Executor executor);
 
     /**
      * Set the proxy to the underlying {@link HttpClient}.
      *
      * @see HttpClient.Builder#proxy(ProxySelector)
      */
-    Builder withProxy(ProxySelector proxySelector);
+    Builder proxy(ProxySelector proxySelector);
 
     /**
      * Set the sslContext to the underlying {@link HttpClient}.
      *
      * @see HttpClient.Builder#sslContext(SSLContext)
      */
-    Builder withSSLContext(SSLContext sslContext);
+    Builder sslContext(SSLContext sslContext);
 
     /**
      * Set the sslParameters to the underlying {@link HttpClient}.
      *
      * @see HttpClient.Builder#sslParameters(SSLParameters)
      */
-    Builder withSSLParameters(SSLParameters sslParameters);
+    Builder sslParameters(SSLParameters sslParameters);
 
     /**
      * Set a HttpClient authenticator to the underlying {@link HttpClient}.
      *
      * @see HttpClient.Builder#authenticator(Authenticator)
      */
-    Builder withAuthenticator(Authenticator authenticator);
+    Builder authenticator(Authenticator authenticator);
 
     /**
      * Set the priority for HTTP/2 requests to the underlying {@link HttpClient}.
      *
      * @see HttpClient.Builder#priority(int)
      */
-    Builder withPriority(int priority);
+    Builder priority(int priority);
 
     /**
      * Build and return the context.
      *
      * <pre>{@code
      *
      *   HttpClientContext ctx = HttpClientContext.newBuilder()
-     *       .withBaseUrl("http://localhost:8080")
-     *       .withRequestListener(new RequestLogger())
-     *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+     *       .baseUrl("http://localhost:8080")
+     *       .requestListener(new RequestLogger())
+     *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
      *       .build();
      *
      *  HelloDto dto = ctx.request()

diff --git a/client/src/main/java/io/avaje/http/client/HttpClientRequest.java b/client/src/main/java/io/avaje/http/client/HttpClientRequest.java
@@ -145,7 +145,7 @@ public interface HttpClientRequest {
    *
    * @param url The url effectively replacing the base url.
    * @return The request being built
-   * @see HttpClientContext.Builder#withBaseUrl(String)
+   * @see HttpClientContext.Builder#baseUrl(String)
    */
   HttpClientRequest url(String url);
 

diff --git a/client/src/main/java/io/avaje/http/client/JacksonBodyAdapter.java b/client/src/main/java/io/avaje/http/client/JacksonBodyAdapter.java
@@ -16,10 +16,9 @@
  * <pre>{@code
  *
  *   HttpClientContext.newBuilder()
- *       .withBaseUrl(baseUrl)
- *       .withRequestListener(new RequestLogger())
- *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
- *       //.withBodyAdapter(new GsonBodyAdapter(new Gson()))
+ *       .baseUrl(baseUrl)
+ *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+ *       //.bodyAdapter(new GsonBodyAdapter(new Gson()))
  *       .build();
  *
  * }</pre>

diff --git a/client/src/main/java/io/avaje/http/client/package-info.java b/client/src/main/java/io/avaje/http/client/package-info.java
@@ -7,8 +7,8 @@
  * <pre>{@code
  *
  *   HttpClientContext ctx = HttpClientContext.newBuilder()
- *       .withBaseUrl("http://localhost:8080")
- *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+ *       .baseUrl("http://localhost:8080")
+ *       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
  *       .build();
  *
  *  HelloDto dto = ctx.request()

diff --git a/client/src/test/java/io/avaje/http/client/AuthTokenTest.java b/client/src/test/java/io/avaje/http/client/AuthTokenTest.java
@@ -46,10 +46,10 @@ public AuthToken obtainToken(HttpClientRequest tokenRequest) {
   void sendEmail() {
 
     HttpClientContext ctx = HttpClientContext.newBuilder()
-      .withBaseUrl("https://foo")
-      .withBodyAdapter(new JacksonBodyAdapter(objectMapper))
-      .withRequestListener(new RequestLogger())
-      .withAuthTokenProvider(new MyAuthTokenProvider())
+      .baseUrl("https://foo")
+      .bodyAdapter(new JacksonBodyAdapter(objectMapper))
+      .requestListener(new RequestLogger())
+      .authTokenProvider(new MyAuthTokenProvider())
       .build();
 
     String path = "bar";

diff --git a/client/src/test/java/io/avaje/http/client/BaseWebTest.java b/client/src/test/java/io/avaje/http/client/BaseWebTest.java
@@ -25,9 +25,9 @@ public static void shutdown() {
 
   public static HttpClientContext client() {
     return HttpClientContext.newBuilder()
-      .withBaseUrl(baseUrl)
-      .withRequestListener(new RequestLogger())
-      .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+      .baseUrl(baseUrl)
+      .requestListener(new RequestLogger())
+      .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
 //      .withBodyAdapter(new GsonBodyAdapter(new Gson()))
       .build();
   }

diff --git a/client/src/test/java/io/avaje/http/client/BasicAuthInterceptTest.java b/client/src/test/java/io/avaje/http/client/BasicAuthInterceptTest.java
@@ -18,7 +18,7 @@ void encode() {
   void beforeRequest() {
     // setup
     final BasicAuthIntercept intercept = new BasicAuthIntercept("Aladdin", "open sesame");
-    final HttpClientContext ctx = HttpClientContext.newBuilder().withBaseUrl("junk").build();
+    final HttpClientContext ctx = HttpClientContext.newBuilder().baseUrl("junk").build();
 
     // act
     final HttpClientRequest request = ctx.request();

diff --git a/client/src/test/java/io/avaje/http/client/DHttpApiTest.java b/client/src/test/java/io/avaje/http/client/DHttpApiTest.java
@@ -20,8 +20,8 @@ void test_github_listRepos() {
       .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false));
 
     final HttpClientContext clientContext = HttpClientContext.newBuilder()
-      .withBaseUrl("https://api.github.com")
-      .withBodyAdapter(bodyAdapter)
+      .baseUrl("https://api.github.com")
+      .bodyAdapter(bodyAdapter)
       .build();
 
     DHttpApi httpApi = new DHttpApi();