1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 package org.apache.hc.client5.http.config;
29
30 import java.util.Collection;
31 import java.util.concurrent.TimeUnit;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.http.HttpHost;
36 import org.apache.hc.core5.util.TimeValue;
37 import org.apache.hc.core5.util.Timeout;
38
39
40
41
42 @Contract(threading = ThreadingBehavior.IMMUTABLE)
43 public class RequestConfig implements Cloneable {
44
45 private static final Timeout DEFAULT_CONNECTION_REQUEST_TIMEOUT = Timeout.ofMinutes(3);
46 private static final TimeValue DEFAULT_CONN_KEEP_ALIVE = TimeValue.ofMinutes(3);
47
48 public static final RequestConfig DEFAULT = new Builder().build();
49
50 private final boolean expectContinueEnabled;
51 private final HttpHost proxy;
52 private final String cookieSpec;
53 private final boolean redirectsEnabled;
54 private final boolean circularRedirectsAllowed;
55 private final int maxRedirects;
56 private final boolean authenticationEnabled;
57 private final Collection<String> targetPreferredAuthSchemes;
58 private final Collection<String> proxyPreferredAuthSchemes;
59 private final Timeout connectionRequestTimeout;
60 private final Timeout connectTimeout;
61 private final Timeout responseTimeout;
62 private final TimeValue connectionKeepAlive;
63 private final boolean contentCompressionEnabled;
64 private final boolean hardCancellationEnabled;
65 private final boolean protocolUpgradeEnabled;
66
67
68
69
70 protected RequestConfig() {
71 this(false, null, null, false, false, 0, false, null, null,
72 DEFAULT_CONNECTION_REQUEST_TIMEOUT, null, null, DEFAULT_CONN_KEEP_ALIVE, false, false, false);
73 }
74
75 RequestConfig(
76 final boolean expectContinueEnabled,
77 final HttpHost proxy,
78 final String cookieSpec,
79 final boolean redirectsEnabled,
80 final boolean circularRedirectsAllowed,
81 final int maxRedirects,
82 final boolean authenticationEnabled,
83 final Collection<String> targetPreferredAuthSchemes,
84 final Collection<String> proxyPreferredAuthSchemes,
85 final Timeout connectionRequestTimeout,
86 final Timeout connectTimeout,
87 final Timeout responseTimeout,
88 final TimeValue connectionKeepAlive,
89 final boolean contentCompressionEnabled,
90 final boolean hardCancellationEnabled,
91 final boolean protocolUpgradeEnabled) {
92 super();
93 this.expectContinueEnabled = expectContinueEnabled;
94 this.proxy = proxy;
95 this.cookieSpec = cookieSpec;
96 this.redirectsEnabled = redirectsEnabled;
97 this.circularRedirectsAllowed = circularRedirectsAllowed;
98 this.maxRedirects = maxRedirects;
99 this.authenticationEnabled = authenticationEnabled;
100 this.targetPreferredAuthSchemes = targetPreferredAuthSchemes;
101 this.proxyPreferredAuthSchemes = proxyPreferredAuthSchemes;
102 this.connectionRequestTimeout = connectionRequestTimeout;
103 this.connectTimeout = connectTimeout;
104 this.responseTimeout = responseTimeout;
105 this.connectionKeepAlive = connectionKeepAlive;
106 this.contentCompressionEnabled = contentCompressionEnabled;
107 this.hardCancellationEnabled = hardCancellationEnabled;
108 this.protocolUpgradeEnabled = protocolUpgradeEnabled;
109 }
110
111
112
113
114 public boolean isExpectContinueEnabled() {
115 return expectContinueEnabled;
116 }
117
118
119
120
121
122
123
124 @Deprecated
125 public HttpHost getProxy() {
126 return proxy;
127 }
128
129
130
131
132 public String getCookieSpec() {
133 return cookieSpec;
134 }
135
136
137
138
139 public boolean isRedirectsEnabled() {
140 return redirectsEnabled;
141 }
142
143
144
145
146 public boolean isCircularRedirectsAllowed() {
147 return circularRedirectsAllowed;
148 }
149
150
151
152
153 public int getMaxRedirects() {
154 return maxRedirects;
155 }
156
157
158
159
160 public boolean isAuthenticationEnabled() {
161 return authenticationEnabled;
162 }
163
164
165
166
167 public Collection<String> getTargetPreferredAuthSchemes() {
168 return targetPreferredAuthSchemes;
169 }
170
171
172
173
174 public Collection<String> getProxyPreferredAuthSchemes() {
175 return proxyPreferredAuthSchemes;
176 }
177
178
179
180
181 public Timeout getConnectionRequestTimeout() {
182 return connectionRequestTimeout;
183 }
184
185
186
187
188
189
190 @Deprecated
191 public Timeout getConnectTimeout() {
192 return connectTimeout;
193 }
194
195
196
197
198 public Timeout getResponseTimeout() {
199 return responseTimeout;
200 }
201
202
203
204
205 public TimeValue getConnectionKeepAlive() {
206 return connectionKeepAlive;
207 }
208
209
210
211
212 public boolean isContentCompressionEnabled() {
213 return contentCompressionEnabled;
214 }
215
216
217
218
219 public boolean isHardCancellationEnabled() {
220 return hardCancellationEnabled;
221 }
222
223
224
225
226 public boolean isProtocolUpgradeEnabled() {
227 return protocolUpgradeEnabled;
228 }
229
230 @Override
231 protected RequestConfig clone() throws CloneNotSupportedException {
232 return (RequestConfig) super.clone();
233 }
234
235 @Override
236 public String toString() {
237 final StringBuilder builder = new StringBuilder();
238 builder.append("[");
239 builder.append("expectContinueEnabled=").append(expectContinueEnabled);
240 builder.append(", proxy=").append(proxy);
241 builder.append(", cookieSpec=").append(cookieSpec);
242 builder.append(", redirectsEnabled=").append(redirectsEnabled);
243 builder.append(", maxRedirects=").append(maxRedirects);
244 builder.append(", circularRedirectsAllowed=").append(circularRedirectsAllowed);
245 builder.append(", authenticationEnabled=").append(authenticationEnabled);
246 builder.append(", targetPreferredAuthSchemes=").append(targetPreferredAuthSchemes);
247 builder.append(", proxyPreferredAuthSchemes=").append(proxyPreferredAuthSchemes);
248 builder.append(", connectionRequestTimeout=").append(connectionRequestTimeout);
249 builder.append(", connectTimeout=").append(connectTimeout);
250 builder.append(", responseTimeout=").append(responseTimeout);
251 builder.append(", connectionKeepAlive=").append(connectionKeepAlive);
252 builder.append(", contentCompressionEnabled=").append(contentCompressionEnabled);
253 builder.append(", hardCancellationEnabled=").append(hardCancellationEnabled);
254 builder.append(", protocolUpgradeEnabled=").append(protocolUpgradeEnabled);
255 builder.append("]");
256 return builder.toString();
257 }
258
259 public static RequestConfig.Builder custom() {
260 return new Builder();
261 }
262 @SuppressWarnings("deprecation")
263 public static RequestConfig.Builder copy(final RequestConfig config) {
264 return new Builder()
265 .setExpectContinueEnabled(config.isExpectContinueEnabled())
266 .setProxy(config.getProxy())
267 .setCookieSpec(config.getCookieSpec())
268 .setRedirectsEnabled(config.isRedirectsEnabled())
269 .setCircularRedirectsAllowed(config.isCircularRedirectsAllowed())
270 .setMaxRedirects(config.getMaxRedirects())
271 .setAuthenticationEnabled(config.isAuthenticationEnabled())
272 .setTargetPreferredAuthSchemes(config.getTargetPreferredAuthSchemes())
273 .setProxyPreferredAuthSchemes(config.getProxyPreferredAuthSchemes())
274 .setConnectionRequestTimeout(config.getConnectionRequestTimeout())
275 .setConnectTimeout(config.getConnectTimeout())
276 .setResponseTimeout(config.getResponseTimeout())
277 .setConnectionKeepAlive(config.getConnectionKeepAlive())
278 .setContentCompressionEnabled(config.isContentCompressionEnabled())
279 .setHardCancellationEnabled(config.isHardCancellationEnabled())
280 .setProtocolUpgradeEnabled(config.isProtocolUpgradeEnabled());
281 }
282
283 public static class Builder {
284
285 private boolean expectContinueEnabled;
286 private HttpHost proxy;
287 private String cookieSpec;
288 private boolean redirectsEnabled;
289 private boolean circularRedirectsAllowed;
290 private int maxRedirects;
291 private boolean authenticationEnabled;
292 private Collection<String> targetPreferredAuthSchemes;
293 private Collection<String> proxyPreferredAuthSchemes;
294 private Timeout connectionRequestTimeout;
295 private Timeout connectTimeout;
296 private Timeout responseTimeout;
297 private TimeValue connectionKeepAlive;
298 private boolean contentCompressionEnabled;
299 private boolean hardCancellationEnabled;
300 private boolean protocolUpgradeEnabled;
301
302 Builder() {
303 super();
304 this.redirectsEnabled = true;
305 this.maxRedirects = 50;
306 this.authenticationEnabled = true;
307 this.connectionRequestTimeout = DEFAULT_CONNECTION_REQUEST_TIMEOUT;
308 this.contentCompressionEnabled = true;
309 this.hardCancellationEnabled = true;
310 this.protocolUpgradeEnabled = true;
311 }
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335 public Builder setExpectContinueEnabled(final boolean expectContinueEnabled) {
336 this.expectContinueEnabled = expectContinueEnabled;
337 return this;
338 }
339
340
341
342
343
344
345
346
347
348
349 @Deprecated
350 public Builder setProxy(final HttpHost proxy) {
351 this.proxy = proxy;
352 return this;
353 }
354
355
356
357
358
359
360
361
362 public Builder setCookieSpec(final String cookieSpec) {
363 this.cookieSpec = cookieSpec;
364 return this;
365 }
366
367
368
369
370
371
372
373 public Builder setRedirectsEnabled(final boolean redirectsEnabled) {
374 this.redirectsEnabled = redirectsEnabled;
375 return this;
376 }
377
378
379
380
381
382
383
384
385
386 public Builder setCircularRedirectsAllowed(final boolean circularRedirectsAllowed) {
387 this.circularRedirectsAllowed = circularRedirectsAllowed;
388 return this;
389 }
390
391
392
393
394
395
396
397
398 public Builder setMaxRedirects(final int maxRedirects) {
399 this.maxRedirects = maxRedirects;
400 return this;
401 }
402
403
404
405
406
407
408
409 public Builder setAuthenticationEnabled(final boolean authenticationEnabled) {
410 this.authenticationEnabled = authenticationEnabled;
411 return this;
412 }
413
414
415
416
417
418
419
420
421 public Builder setTargetPreferredAuthSchemes(final Collection<String> targetPreferredAuthSchemes) {
422 this.targetPreferredAuthSchemes = targetPreferredAuthSchemes;
423 return this;
424 }
425
426
427
428
429
430
431
432
433 public Builder setProxyPreferredAuthSchemes(final Collection<String> proxyPreferredAuthSchemes) {
434 this.proxyPreferredAuthSchemes = proxyPreferredAuthSchemes;
435 return this;
436 }
437
438
439
440
441
442
443
444 public Builder setConnectionRequestTimeout(final Timeout connectionRequestTimeout) {
445 this.connectionRequestTimeout = connectionRequestTimeout;
446 return this;
447 }
448
449
450
451
452 public Builder setConnectionRequestTimeout(final long connectionRequestTimeout, final TimeUnit timeUnit) {
453 this.connectionRequestTimeout = Timeout.of(connectionRequestTimeout, timeUnit);
454 return this;
455 }
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470 @Deprecated
471 public Builder setConnectTimeout(final Timeout connectTimeout) {
472 this.connectTimeout = connectTimeout;
473 return this;
474 }
475
476
477
478
479
480
481 @Deprecated
482 public Builder setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) {
483 this.connectTimeout = Timeout.of(connectTimeout, timeUnit);
484 return this;
485 }
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503 public Builder setResponseTimeout(final Timeout responseTimeout) {
504 this.responseTimeout = responseTimeout;
505 return this;
506 }
507
508
509
510
511 public Builder setResponseTimeout(final long responseTimeout, final TimeUnit timeUnit) {
512 this.responseTimeout = Timeout.of(responseTimeout, timeUnit);
513 return this;
514 }
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529 public Builder setConnectionKeepAlive(final TimeValue connectionKeepAlive) {
530 this.connectionKeepAlive = connectionKeepAlive;
531 return this;
532 }
533
534
535
536
537 public Builder setDefaultKeepAlive(final long defaultKeepAlive, final TimeUnit timeUnit) {
538 this.connectionKeepAlive = TimeValue.of(defaultKeepAlive, timeUnit);
539 return this;
540 }
541
542
543
544
545
546
547
548
549
550 public Builder setContentCompressionEnabled(final boolean contentCompressionEnabled) {
551 this.contentCompressionEnabled = contentCompressionEnabled;
552 return this;
553 }
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582 public Builder setHardCancellationEnabled(final boolean hardCancellationEnabled) {
583 this.hardCancellationEnabled = hardCancellationEnabled;
584 return this;
585 }
586
587
588
589
590
591
592
593
594
595
596
597
598
599 public Builder setProtocolUpgradeEnabled(final boolean protocolUpgradeEnabled) {
600 this.protocolUpgradeEnabled = protocolUpgradeEnabled;
601 return this;
602 }
603
604 public RequestConfig build() {
605 return new RequestConfig(
606 expectContinueEnabled,
607 proxy,
608 cookieSpec,
609 redirectsEnabled,
610 circularRedirectsAllowed,
611 maxRedirects,
612 authenticationEnabled,
613 targetPreferredAuthSchemes,
614 proxyPreferredAuthSchemes,
615 connectionRequestTimeout != null ? connectionRequestTimeout : DEFAULT_CONNECTION_REQUEST_TIMEOUT,
616 connectTimeout,
617 responseTimeout,
618 connectionKeepAlive != null ? connectionKeepAlive : DEFAULT_CONN_KEEP_ALIVE,
619 contentCompressionEnabled,
620 hardCancellationEnabled,
621 protocolUpgradeEnabled);
622 }
623
624 }
625
626 }