Skip to content

Commit 6edef86

Browse files
rbygraverbygrave
committed
#29 - Rename methods on HttpClientContext to be consistent with underlying HttpClient
1 parent a11ad14 commit 6edef86

File tree

15 files changed

+85
-86
lines changed

15 files changed

+85
-86
lines changed

‎http-client/client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,103 +40,103 @@ class DHttpClientContextBuilder implements HttpClientContext.Builder {
4040
}
4141

4242
@Override
43-
public HttpClientContext.Builder with(HttpClient client) {
43+
public HttpClientContext.Builder client(HttpClient client) {
4444
this.client = client;
4545
return this;
4646
}
4747

4848
@Override
49-
public HttpClientContext.Builder withBaseUrl(String baseUrl) {
49+
public HttpClientContext.Builder baseUrl(String baseUrl) {
5050
this.baseUrl = baseUrl;
5151
return this;
5252
}
5353

5454
@Override
55-
public HttpClientContext.Builder withRequestTimeout(Duration requestTimeout) {
55+
public HttpClientContext.Builder requestTimeout(Duration requestTimeout) {
5656
this.requestTimeout = requestTimeout;
5757
return this;
5858
}
5959

6060
@Override
61-
public HttpClientContext.Builder withBodyAdapter(BodyAdapter adapter) {
61+
public HttpClientContext.Builder bodyAdapter(BodyAdapter adapter) {
6262
this.bodyAdapter = adapter;
6363
return this;
6464
}
6565

6666
@Override
67-
public HttpClientContext.Builder withRetryHandler(RetryHandler retryHandler) {
67+
public HttpClientContext.Builder retryHandler(RetryHandler retryHandler) {
6868
this.retryHandler = retryHandler;
6969
return this;
7070
}
7171

7272
@Override
73-
public HttpClientContext.Builder withRequestListener(RequestListener requestListener) {
73+
public HttpClientContext.Builder requestListener(RequestListener requestListener) {
7474
this.listeners.add(requestListener);
7575
return this;
7676
}
7777

7878
@Override
79-
public HttpClientContext.Builder withRequestIntercept(RequestIntercept requestIntercept) {
79+
public HttpClientContext.Builder requestIntercept(RequestIntercept requestIntercept) {
8080
this.interceptors.add(requestIntercept);
8181
return this;
8282
}
8383

8484
@Override
85-
public HttpClientContext.Builder withAuthTokenProvider(AuthTokenProvider authTokenProvider) {
85+
public HttpClientContext.Builder authTokenProvider(AuthTokenProvider authTokenProvider) {
8686
this.authTokenProvider = authTokenProvider;
8787
return this;
8888
}
8989

9090
@Override
91-
public HttpClientContext.Builder withCookieHandler(CookieHandler cookieHandler) {
91+
public HttpClientContext.Builder cookieHandler(CookieHandler cookieHandler) {
9292
this.cookieHandler = cookieHandler;
9393
return this;
9494
}
9595

9696
@Override
97-
public HttpClientContext.Builder withRedirect(HttpClient.Redirect redirect) {
97+
public HttpClientContext.Builder redirect(HttpClient.Redirect redirect) {
9898
this.redirect = redirect;
9999
return this;
100100
}
101101

102102
@Override
103-
public HttpClientContext.Builder withVersion(HttpClient.Version version) {
103+
public HttpClientContext.Builder version(HttpClient.Version version) {
104104
this.version = version;
105105
return this;
106106
}
107107

108108
@Override
109-
public HttpClientContext.Builder withExecutor(Executor executor) {
109+
public HttpClientContext.Builder executor(Executor executor) {
110110
this.executor = executor;
111111
return this;
112112
}
113113

114114
@Override
115-
public HttpClientContext.Builder withProxy(ProxySelector proxySelector) {
115+
public HttpClientContext.Builder proxy(ProxySelector proxySelector) {
116116
this.proxy = proxySelector;
117117
return this;
118118
}
119119

120120
@Override
121-
public HttpClientContext.Builder withSSLContext(SSLContext sslContext) {
121+
public HttpClientContext.Builder sslContext(SSLContext sslContext) {
122122
this.sslContext = sslContext;
123123
return this;
124124
}
125125

126126
@Override
127-
public HttpClientContext.Builder withSSLParameters(SSLParameters sslParameters) {
127+
public HttpClientContext.Builder sslParameters(SSLParameters sslParameters) {
128128
this.sslParameters = sslParameters;
129129
return this;
130130
}
131131

132132
@Override
133-
public HttpClientContext.Builder withAuthenticator(Authenticator authenticator) {
133+
public HttpClientContext.Builder authenticator(Authenticator authenticator) {
134134
this.authenticator = authenticator;
135135
return this;
136136
}
137137

138138
@Override
139-
public HttpClientContext.Builder withPriority(int priority) {
139+
public HttpClientContext.Builder priority(int priority) {
140140
this.priority = priority;
141141
return this;
142142
}

‎http-client/client/src/main/java/io/avaje/http/client/HttpClientContext.java

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
* <pre>{@code
1717
*
1818
* HttpClientContext ctx = HttpClientContext.newBuilder()
19-
* .withBaseUrl("http://localhost:8080")
20-
* .withRequestListener(new RequestLogger())
21-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
19+
* .baseUrl("http://localhost:8080")
20+
* .requestListener(new RequestLogger())
21+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
2222
* .build();
2323
*
2424
* HelloDto dto = ctx.request()
@@ -38,9 +38,9 @@ public interface HttpClientContext {
3838
* <pre>{@code
3939
*
4040
* HttpClientContext ctx = HttpClientContext.newBuilder()
41-
* .withBaseUrl("http://localhost:8080")
42-
* .withRequestListener(new RequestLogger())
43-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
41+
* .baseUrl("http://localhost:8080")
42+
* .requestListener(new RequestLogger())
43+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
4444
* .build();
4545
*
4646
* HttpResponse<String> res = ctx.request()
@@ -123,9 +123,9 @@ static HttpClientContext.Builder newBuilder() {
123123
* <pre>{@code
124124
*
125125
* HttpClientContext ctx = HttpClientContext.newBuilder()
126-
* .withBaseUrl("http://localhost:8080")
127-
* .withRequestListener(new RequestLogger())
128-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
126+
* .baseUrl("http://localhost:8080")
127+
* .requestListener(new RequestLogger())
128+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
129129
* .build();
130130
*
131131
* HelloDto dto = ctx.request()
@@ -144,32 +144,32 @@ interface Builder {
144144
* <p>
145145
* Used when we wish to control all options of the HttpClient.
146146
*/
147-
Builder with(HttpClient client);
147+
Builder client(HttpClient client);
148148

149149
/**
150150
* Set the base URL to use for requests created from the context.
151151
* <p>
152152
* Note that the base url can be replaced via {@link HttpClientRequest#url(String)}.
153153
*/
154-
Builder withBaseUrl(String baseUrl);
154+
Builder baseUrl(String baseUrl);
155155

156156
/**
157157
* Set the default request timeout.
158158
*
159159
* @see java.net.http.HttpRequest.Builder#timeout(Duration)
160160
*/
161-
Builder withRequestTimeout(Duration requestTimeout);
161+
Builder requestTimeout(Duration requestTimeout);
162162

163163
/**
164164
* Set the body adapter to use to convert beans to body content
165165
* and response content back to beans.
166166
*/
167-
Builder withBodyAdapter(BodyAdapter adapter);
167+
Builder bodyAdapter(BodyAdapter adapter);
168168

169169
/**
170170
* Set a RetryHandler to use to retry requests.
171171
*/
172-
Builder withRetryHandler(RetryHandler retryHandler);
172+
Builder retryHandler(RetryHandler retryHandler);
173173

174174
/**
175175
* Add a request listener. Multiple listeners may be added, when
@@ -179,12 +179,12 @@ interface Builder {
179179
* implementation for debug logging request/response headers and
180180
* content.
181181
*/
182-
Builder withRequestListener(RequestListener requestListener);
182+
Builder requestListener(RequestListener requestListener);
183183

184184
/**
185185
* Add a request interceptor. Multiple interceptors may be added.
186186
*/
187-
Builder withRequestIntercept(RequestIntercept requestIntercept);
187+
Builder requestIntercept(RequestIntercept requestIntercept);
188188

189189
/**
190190
* Add a Authorization token provider.
@@ -196,81 +196,81 @@ interface Builder {
196196
* is automatically called as needed and the Authorization Bearer header set
197197
* on all requests (not marked with skipAuthToken()).
198198
*/
199-
Builder withAuthTokenProvider(AuthTokenProvider authTokenProvider);
199+
Builder authTokenProvider(AuthTokenProvider authTokenProvider);
200200

201201
/**
202202
* Specify a cookie handler to use on the HttpClient. This would override the default cookie handler.
203203
*
204204
* @see HttpClient.Builder#cookieHandler(CookieHandler)
205205
*/
206-
Builder withCookieHandler(CookieHandler cookieHandler);
206+
Builder cookieHandler(CookieHandler cookieHandler);
207207

208208
/**
209209
* Specify the redirect policy. Defaults to HttpClient.Redirect.NORMAL.
210210
*
211211
* @see HttpClient.Builder#followRedirects(HttpClient.Redirect)
212212
*/
213-
Builder withRedirect(HttpClient.Redirect redirect);
213+
Builder redirect(HttpClient.Redirect redirect);
214214

215215
/**
216216
* Specify the HTTP version. Defaults to not set.
217217
*
218218
* @see HttpClient.Builder#version(HttpClient.Version)
219219
*/
220-
Builder withVersion(HttpClient.Version version);
220+
Builder version(HttpClient.Version version);
221221

222222
/**
223223
* Specify the Executor to use for asynchronous tasks.
224224
* If not specified a default executor will be used.
225225
*
226226
* @see HttpClient.Builder#executor(Executor)
227227
*/
228-
Builder withExecutor(Executor executor);
228+
Builder executor(Executor executor);
229229

230230
/**
231231
* Set the proxy to the underlying {@link HttpClient}.
232232
*
233233
* @see HttpClient.Builder#proxy(ProxySelector)
234234
*/
235-
Builder withProxy(ProxySelector proxySelector);
235+
Builder proxy(ProxySelector proxySelector);
236236

237237
/**
238238
* Set the sslContext to the underlying {@link HttpClient}.
239239
*
240240
* @see HttpClient.Builder#sslContext(SSLContext)
241241
*/
242-
Builder withSSLContext(SSLContext sslContext);
242+
Builder sslContext(SSLContext sslContext);
243243

244244
/**
245245
* Set the sslParameters to the underlying {@link HttpClient}.
246246
*
247247
* @see HttpClient.Builder#sslParameters(SSLParameters)
248248
*/
249-
Builder withSSLParameters(SSLParameters sslParameters);
249+
Builder sslParameters(SSLParameters sslParameters);
250250

251251
/**
252252
* Set a HttpClient authenticator to the underlying {@link HttpClient}.
253253
*
254254
* @see HttpClient.Builder#authenticator(Authenticator)
255255
*/
256-
Builder withAuthenticator(Authenticator authenticator);
256+
Builder authenticator(Authenticator authenticator);
257257

258258
/**
259259
* Set the priority for HTTP/2 requests to the underlying {@link HttpClient}.
260260
*
261261
* @see HttpClient.Builder#priority(int)
262262
*/
263-
Builder withPriority(int priority);
263+
Builder priority(int priority);
264264

265265
/**
266266
* Build and return the context.
267267
*
268268
* <pre>{@code
269269
*
270270
* HttpClientContext ctx = HttpClientContext.newBuilder()
271-
* .withBaseUrl("http://localhost:8080")
272-
* .withRequestListener(new RequestLogger())
273-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
271+
* .baseUrl("http://localhost:8080")
272+
* .requestListener(new RequestLogger())
273+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
274274
* .build();
275275
*
276276
* HelloDto dto = ctx.request()

‎http-client/client/src/main/java/io/avaje/http/client/HttpClientRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public interface HttpClientRequest {
145145
*
146146
* @param url The url effectively replacing the base url.
147147
* @return The request being built
148-
* @see HttpClientContext.Builder#withBaseUrl(String)
148+
* @see HttpClientContext.Builder#baseUrl(String)
149149
*/
150150
HttpClientRequest url(String url);
151151

‎http-client/client/src/main/java/io/avaje/http/client/JacksonBodyAdapter.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@
1616
* <pre>{@code
1717
*
1818
* HttpClientContext.newBuilder()
19-
* .withBaseUrl(baseUrl)
20-
* .withRequestListener(new RequestLogger())
21-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
22-
* //.withBodyAdapter(new GsonBodyAdapter(new Gson()))
19+
* .baseUrl(baseUrl)
20+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
21+
* //.bodyAdapter(new GsonBodyAdapter(new Gson()))
2322
* .build();
2423
*
2524
* }</pre>

‎http-client/client/src/main/java/io/avaje/http/client/package-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* <pre>{@code
88
*
99
* HttpClientContext ctx = HttpClientContext.newBuilder()
10-
* .withBaseUrl("http://localhost:8080")
11-
* .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
10+
* .baseUrl("http://localhost:8080")
11+
* .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
1212
* .build();
1313
*
1414
* HelloDto dto = ctx.request()

‎http-client/client/src/test/java/io/avaje/http/client/AuthTokenTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ public AuthToken obtainToken(HttpClientRequest tokenRequest) {
4646
void sendEmail() {
4747

4848
HttpClientContext ctx = HttpClientContext.newBuilder()
49-
.withBaseUrl("https://foo")
50-
.withBodyAdapter(new JacksonBodyAdapter(objectMapper))
51-
.withRequestListener(new RequestLogger())
52-
.withAuthTokenProvider(new MyAuthTokenProvider())
49+
.baseUrl("https://foo")
50+
.bodyAdapter(new JacksonBodyAdapter(objectMapper))
51+
.requestListener(new RequestLogger())
52+
.authTokenProvider(new MyAuthTokenProvider())
5353
.build();
5454

5555
String path = "bar";

‎http-client/client/src/test/java/io/avaje/http/client/BaseWebTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ public static void shutdown() {
2525

2626
public static HttpClientContext client() {
2727
return HttpClientContext.newBuilder()
28-
.withBaseUrl(baseUrl)
29-
.withRequestListener(new RequestLogger())
30-
.withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
28+
.baseUrl(baseUrl)
29+
.requestListener(new RequestLogger())
30+
.bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
3131
// .withBodyAdapter(new GsonBodyAdapter(new Gson()))
3232
.build();
3333
}

‎http-client/client/src/test/java/io/avaje/http/client/BasicAuthInterceptTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ void encode() {
1818
void beforeRequest() {
1919
// setup
2020
final BasicAuthIntercept intercept = new BasicAuthIntercept("Aladdin", "open sesame");
21-
final HttpClientContext ctx = HttpClientContext.newBuilder().withBaseUrl("junk").build();
21+
final HttpClientContext ctx = HttpClientContext.newBuilder().baseUrl("junk").build();
2222

2323
// act
2424
final HttpClientRequest request = ctx.request();

‎http-client/client/src/test/java/io/avaje/http/client/DHttpApiTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ void test_github_listRepos() {
2020
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false));
2121

2222
final HttpClientContext clientContext = HttpClientContext.newBuilder()
23-
.withBaseUrl("https://api.github.com")
24-
.withBodyAdapter(bodyAdapter)
23+
.baseUrl("https://api.github.com")
24+
.bodyAdapter(bodyAdapter)
2525
.build();
2626

2727
DHttpApi httpApi = new DHttpApi();

0 commit comments

Comments
 (0)