forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequestTemplate.java
More file actions
1072 lines (965 loc) · 32.1 KB
/
RequestTemplate.java
File metadata and controls
1072 lines (965 loc) · 32.1 KB
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2012-2024 The Feign Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package feign;
import static feign.Util.CONTENT_LENGTH;
import static feign.Util.checkNotNull;
import feign.Request.HttpMethod;
import feign.template.BodyTemplate;
import feign.template.HeaderTemplate;
import feign.template.QueryTemplate;
import feign.template.UriTemplate;
import feign.template.UriUtils;
import java.io.Serializable;
import java.net.URI;
import java.nio.charset.Charset;
import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
/**
* Request Builder for an HTTP Target.
* <p>
* This class is a variation on a UriTemplate, where, in addition to the uri, Headers and Query
* information also support template expressions.
* </p>
*/
@SuppressWarnings("UnusedReturnValue")
public final class RequestTemplate implements Serializable {
private static final Pattern QUERY_STRING_PATTERN = Pattern.compile("(?<!\\{)\\?");
private final Map<String, QueryTemplate> queries = new LinkedHashMap<>();
private final Map<String, HeaderTemplate> headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private String target;
private String fragment;
private boolean resolved = false;
private UriTemplate uriTemplate;
private BodyTemplate bodyTemplate;
private HttpMethod method;
private transient Charset charset = Util.UTF_8;
private Request.Body body = Request.Body.empty();
private boolean decodeSlash = true;
private CollectionFormat collectionFormat = CollectionFormat.EXPLODED;
private MethodMetadata methodMetadata;
private Target<?> feignTarget;
/**
* Create a new Request Template.
*/
public RequestTemplate() {
super();
}
/**
* Create a new Request Template.
*
* @param fragment part of the request uri.
* @param target for the template.
* @param uriTemplate for the template.
* @param bodyTemplate for the template, may be {@literal null}
* @param method of the request.
* @param charset for the request.
* @param body of the request, may be {@literal null}
* @param decodeSlash if the request uri should encode slash characters.
* @param collectionFormat when expanding collection based variables.
* @param feignTarget this template is targeted for.
* @param methodMetadata containing a reference to the method this template is built from.
*/
private RequestTemplate(String target,
String fragment,
UriTemplate uriTemplate,
BodyTemplate bodyTemplate,
HttpMethod method,
Charset charset,
Request.Body body,
boolean decodeSlash,
CollectionFormat collectionFormat,
MethodMetadata methodMetadata,
Target<?> feignTarget) {
this.target = target;
this.fragment = fragment;
this.uriTemplate = uriTemplate;
this.bodyTemplate = bodyTemplate;
this.method = method;
this.charset = charset;
this.body = body;
this.decodeSlash = decodeSlash;
this.collectionFormat =
(collectionFormat != null) ? collectionFormat : CollectionFormat.EXPLODED;
this.methodMetadata = methodMetadata;
this.feignTarget = feignTarget;
}
/**
* Create a Request Template from an existing Request Template.
*
* @param requestTemplate to copy from.
* @return a new Request Template.
*/
public static RequestTemplate from(RequestTemplate requestTemplate) {
RequestTemplate template =
new RequestTemplate(
requestTemplate.target,
requestTemplate.fragment,
requestTemplate.uriTemplate,
requestTemplate.bodyTemplate,
requestTemplate.method,
requestTemplate.charset,
requestTemplate.body,
requestTemplate.decodeSlash,
requestTemplate.collectionFormat,
requestTemplate.methodMetadata,
requestTemplate.feignTarget);
if (!requestTemplate.queries().isEmpty()) {
template.queries.putAll(requestTemplate.queries);
}
if (!requestTemplate.headers().isEmpty()) {
template.headers.putAll(requestTemplate.headers);
}
return template;
}
/**
* Create a Request Template from an existing Request Template.
*
* @param toCopy template.
* @deprecated replaced by {@link RequestTemplate#from(RequestTemplate)}
*/
@Deprecated
public RequestTemplate(RequestTemplate toCopy) {
checkNotNull(toCopy, "toCopy");
this.target = toCopy.target;
this.fragment = toCopy.fragment;
this.method = toCopy.method;
this.queries.putAll(toCopy.queries);
this.headers.putAll(toCopy.headers);
this.charset = toCopy.charset;
this.body = toCopy.body;
this.decodeSlash = toCopy.decodeSlash;
this.collectionFormat =
(toCopy.collectionFormat != null) ? toCopy.collectionFormat : CollectionFormat.EXPLODED;
this.uriTemplate = toCopy.uriTemplate;
this.bodyTemplate = toCopy.bodyTemplate;
this.resolved = false;
this.methodMetadata = toCopy.methodMetadata;
this.target = toCopy.target;
this.feignTarget = toCopy.feignTarget;
}
/**
* Resolve all expressions using the variable value substitutions provided. Variable values will
* be pct-encoded, if they are not already.
*
* @param variables containing the variable values to use when resolving expressions.
* @return a new Request Template with all of the variables resolved.
*/
public RequestTemplate resolve(Map<String, ?> variables) {
StringBuilder uri = new StringBuilder();
/* create a new template form this one, but explicitly */
RequestTemplate resolved = RequestTemplate.from(this);
if (this.uriTemplate == null) {
/* create a new uri template using the default root */
this.uriTemplate = UriTemplate.create("", !this.decodeSlash, this.charset);
}
String expanded = this.uriTemplate.expand(variables);
if (expanded != null) {
uri.append(expanded);
}
/*
* for simplicity, combine the queries into the uri and use the resulting uri to seed the
* resolved template.
*/
if (!this.queries.isEmpty()) {
/*
* since we only want to keep resolved query values, reset any queries on the resolved copy
*/
resolved.queries(Collections.emptyMap());
StringBuilder query = new StringBuilder();
Iterator<QueryTemplate> queryTemplates = this.queries.values().iterator();
while (queryTemplates.hasNext()) {
QueryTemplate queryTemplate = queryTemplates.next();
String queryExpanded = queryTemplate.expand(variables);
if (Util.isNotBlank(queryExpanded)) {
query.append(queryExpanded);
if (queryTemplates.hasNext()) {
query.append("&");
}
}
}
String queryString = query.toString();
if (!queryString.isEmpty()) {
Matcher queryMatcher = QUERY_STRING_PATTERN.matcher(uri);
if (queryMatcher.find()) {
/* the uri already has a query, so any additional queries should be appended */
uri.append("&");
} else {
uri.append("?");
}
uri.append(queryString);
}
}
/* add the uri to result */
resolved.uri(uri.toString());
/* headers */
if (!this.headers.isEmpty()) {
/*
* same as the query string, we only want to keep resolved values, so clear the header map on
* the resolved instance
*/
resolved.headers(Collections.emptyMap());
for (HeaderTemplate headerTemplate : this.headers.values()) {
/* resolve the header */
String header = headerTemplate.expand(variables);
if (!header.isEmpty()) {
/* append the header as a new literal as the value has already been expanded. */
resolved.appendHeader(
headerTemplate.getName(), Collections.singletonList(header), true);
}
}
}
if (this.bodyTemplate != null) {
resolved.body(this.bodyTemplate.expand(variables));
}
/* mark the new template resolved */
resolved.resolved = true;
return resolved;
}
/**
* Resolves all expressions, using the variables provided. Values not present in the {@code
* alreadyEncoded} map are pct-encoded.
*
* @param unencoded variable values to substitute.
* @param alreadyEncoded variable names.
* @return a resolved Request Template
* @deprecated use {@link RequestTemplate#resolve(Map)}. Values already encoded are recognized as
* such and skipped.
*/
@SuppressWarnings("unused")
@Deprecated
RequestTemplate resolve(Map<String, ?> unencoded, Map<String, Boolean> alreadyEncoded) {
return this.resolve(unencoded);
}
/**
* Creates a {@link Request} from this template. The template must be resolved before calling this
* method, or an {@link IllegalStateException} will be thrown.
*
* @return a new Request instance.
* @throws IllegalStateException if this template has not been resolved.
*/
public Request request() {
if (!this.resolved) {
throw new IllegalStateException("template has not been resolved.");
}
return Request.create(this.method, this.url(), this.headers(), this.body, this);
}
/**
* Set the Http Method.
*
* @param method to use.
* @return a RequestTemplate for chaining.
* @deprecated see {@link RequestTemplate#method(HttpMethod)}
*/
@Deprecated
public RequestTemplate method(String method) {
checkNotNull(method, "method");
try {
this.method = HttpMethod.valueOf(method);
} catch (IllegalArgumentException iae) {
throw new IllegalArgumentException("Invalid HTTP Method: " + method);
}
return this;
}
/**
* Set the Http Method.
*
* @param method to use.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate method(HttpMethod method) {
checkNotNull(method, "method");
this.method = method;
return this;
}
/**
* The Request Http Method.
*
* @return Http Method.
*/
public String method() {
return (method != null) ? method.name() : null;
}
/**
* Set whether do encode slash {@literal /} characters when resolving this template.
*
* @param decodeSlash if slash literals should not be encoded.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate decodeSlash(boolean decodeSlash) {
this.decodeSlash = decodeSlash;
this.uriTemplate =
UriTemplate.create(this.uriTemplate.toString(), !this.decodeSlash, this.charset);
if (!this.queries.isEmpty()) {
this.queries.replaceAll((key, queryTemplate) -> QueryTemplate.create(
/* replace the current template with new ones honoring the decode value */
queryTemplate.getName(), queryTemplate.getValues(), charset, collectionFormat,
decodeSlash));
}
return this;
}
/**
* If slash {@literal /} characters are not encoded when resolving.
*
* @return true if slash literals are not encoded, false otherwise.
*/
public boolean decodeSlash() {
return decodeSlash;
}
/**
* The Collection Format to use when resolving variables that represent {@link Iterable}s or
* {@link Collection}s
*
* @param collectionFormat to use.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate collectionFormat(CollectionFormat collectionFormat) {
this.collectionFormat = collectionFormat;
return this;
}
/**
* The Collection Format that will be used when resolving {@link Iterable} and {@link Collection}
* variables.
*
* @return the collection format set
*/
@SuppressWarnings("unused")
public CollectionFormat collectionFormat() {
return collectionFormat;
}
/**
* Append the value to the template.
* <p>
* This method is poorly named and is used primarily to store the relative uri for the request. It
* has been replaced by {@link RequestTemplate#uri(String)} and will be removed in a future
* release.
* </p>
*
* @param value to append.
* @return a RequestTemplate for chaining.
* @deprecated see {@link RequestTemplate#uri(String, boolean)}
*/
@Deprecated
public RequestTemplate append(CharSequence value) {
/* proxy to url */
if (this.uriTemplate != null) {
return this.uri(value.toString(), true);
}
return this.uri(value.toString());
}
/**
* Insert the value at the specified point in the template uri.
* <p>
* This method is poorly named has undocumented behavior. When the value contains a fully
* qualified http request url, the value is always inserted at the beginning of the uri.
* </p>
* <p>
* Due to this, use of this method is not recommended and remains for backward compatibility. It
* has been replaced by {@link RequestTemplate#target(String)} and will be removed in a future
* release.
* </p>
*
* @param pos in the uri to place the value.
* @param value to insert.
* @return a RequestTemplate for chaining.
* @deprecated see {@link RequestTemplate#target(String)}
*/
@SuppressWarnings("unused")
@Deprecated
public RequestTemplate insert(int pos, CharSequence value) {
return target(value.toString());
}
/**
* Set the Uri for the request, replacing the existing uri if set.
*
* @param uri to use, must be a relative uri.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate uri(String uri) {
return this.uri(uri, false);
}
/**
* Set the uri for the request.
*
* @param uri to use, must be a relative uri.
* @param append if the uri should be appended, if the uri is already set.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate uri(String uri, boolean append) {
/* validate and ensure that the url is always a relative one */
if (UriUtils.isAbsolute(uri)) {
throw new IllegalArgumentException("url values must be not be absolute.");
}
if (uri == null) {
uri = "/";
} else if ((!uri.isEmpty() && !uri.startsWith("/") && !uri.startsWith("{")
&& !uri.startsWith("?") && !uri.startsWith(";"))) {
/* if the start of the url is a literal, it must begin with a slash. */
uri = "/" + uri;
}
int fragmentIndex = uri.indexOf('#');
if (fragmentIndex > -1) {
fragment = uri.substring(fragmentIndex);
uri = uri.substring(0, fragmentIndex);
}
/*
* templates may provide query parameters. since we want to manage those explicity, we will need
* to extract those out, leaving the uriTemplate with only the path to deal with.
*/
Matcher queryMatcher = QUERY_STRING_PATTERN.matcher(uri);
if (queryMatcher.find()) {
String queryString = uri.substring(queryMatcher.start() + 1);
/* parse the query string */
this.extractQueryTemplates(queryString, append);
/* reduce the uri to the path */
uri = uri.substring(0, queryMatcher.start());
}
/* replace the uri template */
if (append && this.uriTemplate != null) {
this.uriTemplate = UriTemplate.append(this.uriTemplate, uri);
} else {
this.uriTemplate = UriTemplate.create(uri, !this.decodeSlash, this.charset);
}
return this;
}
/**
* Set the target host for this request.
*
* @param target host for this request. Must be an absolute target.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate target(String target) {
/* target can be empty */
if (Util.isBlank(target)) {
return this;
}
/* verify that the target contains the scheme, host and port */
if (!UriUtils.isAbsolute(target)) {
throw new IllegalArgumentException("target values must be absolute.");
}
if (target.endsWith("/")) {
target = target.substring(0, target.length() - 1);
}
try {
/* parse the target */
URI targetUri = URI.create(target);
if (Util.isNotBlank(targetUri.getRawQuery())) {
/*
* target has a query string, we need to make sure that they are recorded as queries
*/
this.extractQueryTemplates(targetUri.getRawQuery(), true);
}
/* strip the query string */
this.target =
targetUri.getScheme() + "://" + targetUri.getRawAuthority() + targetUri.getRawPath();
if (targetUri.getFragment() != null) {
this.fragment = "#" + targetUri.getFragment();
}
} catch (IllegalArgumentException iae) {
/* the uri provided is not a valid one, we can't continue */
throw new IllegalArgumentException("Target is not a valid URI.", iae);
}
return this;
}
/**
* The URL for the request. If the template has not been resolved, the url will represent a uri
* template.
*
* @return the url
*/
public String url() {
/* build the fully qualified url with all query parameters */
StringBuilder url = new StringBuilder(this.path());
if (!this.queries.isEmpty()) {
url.append(this.queryLine());
}
if (fragment != null) {
url.append(fragment);
}
return url.toString();
}
/**
* The Uri Path.
*
* @return the uri path.
*/
public String path() {
/* build the fully qualified url with all query parameters */
StringBuilder path = new StringBuilder();
if (this.target != null) {
path.append(this.target);
}
if (this.uriTemplate != null) {
path.append(this.uriTemplate.toString());
}
if (path.length() == 0) {
/* no path indicates the root uri */
path.append("/");
}
return path.toString();
}
/**
* List all of the template variable expressions for this template.
*
* @return a list of template variable names
*/
public List<String> variables() {
/* combine the variables from the uri, query, header, and body templates */
List<String> variables = new ArrayList<>(this.uriTemplate.getVariables());
/* queries */
for (QueryTemplate queryTemplate : this.queries.values()) {
variables.addAll(queryTemplate.getVariables());
}
/* headers */
for (HeaderTemplate headerTemplate : this.headers.values()) {
variables.addAll(headerTemplate.getVariables());
}
/* body */
if (this.bodyTemplate != null) {
variables.addAll(this.bodyTemplate.getVariables());
}
return variables;
}
/**
* @see RequestTemplate#query(String, Iterable)
*/
public RequestTemplate query(String name, String... values) {
if (values == null) {
return query(name, Collections.emptyList());
}
return query(name, Arrays.asList(values));
}
/**
* Specify a Query String parameter, with the specified values. Values can be literals or template
* expressions.
*
* @param name of the parameter.
* @param values for this parameter.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate query(String name, Iterable<String> values) {
return appendQuery(name, values, this.collectionFormat);
}
/**
* Specify a Query String parameter, with the specified values. Values can be literals or template
* expressions.
*
* @param name of the parameter.
* @param values for this parameter.
* @param collectionFormat to use when resolving collection based expressions.
* @return a Request Template for chaining.
*/
public RequestTemplate query(String name,
Iterable<String> values,
CollectionFormat collectionFormat) {
return appendQuery(name, values, collectionFormat);
}
/**
* Appends the query name and values.
*
* @param name of the parameter.
* @param values for the parameter, may be expressions.
* @param collectionFormat to use when resolving collection based query variables.
* @return a RequestTemplate for chaining.
*/
private RequestTemplate appendQuery(String name,
Iterable<String> values,
CollectionFormat collectionFormat) {
if (!values.iterator().hasNext()) {
/* empty value, clear the existing values */
this.queries.remove(name);
return this;
}
/* create a new query template out of the information here */
this.queries.compute(name, (key, queryTemplate) -> {
if (queryTemplate == null) {
return QueryTemplate.create(name, values, this.charset, collectionFormat, this.decodeSlash);
} else {
return QueryTemplate.append(queryTemplate, values, collectionFormat, this.decodeSlash);
}
});
return this;
}
/**
* Sets the Query Parameters.
*
* @param queries to use for this request.
* @return a RequestTemplate for chaining.
*/
@SuppressWarnings("unused")
public RequestTemplate queries(Map<String, Collection<String>> queries) {
if (queries == null || queries.isEmpty()) {
this.queries.clear();
} else {
queries.forEach(this::query);
}
return this;
}
/**
* Return an immutable Map of all Query Parameters and their values.
*
* @return registered Query Parameters.
*/
public Map<String, Collection<String>> queries() {
Map<String, Collection<String>> queryMap = new LinkedHashMap<>();
this.queries.forEach((key, queryTemplate) -> {
List<String> values = new ArrayList<>(queryTemplate.getValues());
/* add the expanded collection, but lock it */
queryMap.put(key, Collections.unmodifiableList(values));
});
return Collections.unmodifiableMap(queryMap);
}
/**
* @see RequestTemplate#header(String, Iterable)
*/
public RequestTemplate header(String name, String... values) {
if (values == null) {
return appendHeader(name, Collections.emptyList());
}
return header(name, Arrays.asList(values));
}
/**
* Specify a Header, with the specified values. Values can be literals or template expressions.
*
* @param name of the header.
* @param values for this header.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate header(String name, Iterable<String> values) {
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("name is required.");
}
if (values == null) {
values = Collections.emptyList();
}
return appendHeader(name, values);
}
/**
* Clear on reader from {@link RequestTemplate}
*
* @param name of the header.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate removeHeader(String name) {
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("name is required.");
}
this.headers.remove(name);
return this;
}
/**
* Append the Header. Will create a new Header if it doesn't already exist. Treats all values as
* potentially expressions.
*
* @param name of the header
* @param values for the header, may be expressions.
* @return a RequestTemplate for chaining.
*/
private RequestTemplate appendHeader(String name, Iterable<String> values) {
return this.appendHeader(name, values, false);
}
/**
* Append the Header. Will create a new Header if it doesn't already exist.
*
* @param name of the header
* @param values for the header, may be expressions.
* @param literal indicator, to treat the values as literals and not expressions
* @return a RequestTemplate for chaining.
*/
private RequestTemplate appendHeader(String name, Iterable<String> values, boolean literal) {
if (!values.iterator().hasNext()) {
/* empty value, clear the existing values */
this.headers.remove(name);
return this;
}
if (name.equals("Content-Type")) {
// a client can only produce content of one single type, so always override Content-Type and
// only add a single type
this.headers.remove(name);
this.headers.put(name,
HeaderTemplate.create(name, Collections.singletonList(values.iterator().next())));
return this;
}
this.headers.compute(name, (headerName, headerTemplate) -> {
if (headerTemplate == null) {
if (literal) {
return HeaderTemplate.literal(headerName, values);
} else {
return HeaderTemplate.create(headerName, values);
}
} else if (literal) {
return HeaderTemplate.appendLiteral(headerTemplate, values);
} else {
return HeaderTemplate.append(headerTemplate, values);
}
});
return this;
}
/**
* Headers for this Request.
*
* @param headers to use.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate headers(Map<String, Collection<String>> headers) {
if (headers != null && !headers.isEmpty()) {
headers.forEach(this::header);
} else {
this.headers.clear();
}
return this;
}
/**
* Returns an copy of the Headers for this request.
*
* @return the currently applied headers.
*/
public Map<String, Collection<String>> headers() {
Map<String, Collection<String>> headerMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
this.headers.forEach((key, headerTemplate) -> {
List<String> values = new ArrayList<>(headerTemplate.getValues());
/* add the expanded collection, but only if it has values */
if (!values.isEmpty()) {
headerMap.put(key, values);
}
});
return headerMap;
}
/**
* Sets the Body and Charset for this request.
*
* @param data to send, can be null.
* @param charset of the encoded data.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate body(byte[] data, Charset charset) {
this.body(Request.Body.create(data, charset));
return this;
}
/**
* Set the Body for this request. Charset is assumed to be UTF_8. Data must be encoded.
*
* @param bodyText to send.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate body(String bodyText) {
this.body(Request.Body.create(bodyText.getBytes(this.charset), this.charset));
return this;
}
/**
* Set the Body for this request.
*
* @param body to send.
* @return a RequestTemplate for chaining.
* @deprecated use {@link #body(byte[], Charset)} instead.
*/
@Deprecated
public RequestTemplate body(Request.Body body) {
this.body = body;
/* body template must be cleared to prevent double processing */
this.bodyTemplate = null;
header(CONTENT_LENGTH, Collections.emptyList());
if (body.length() > 0) {
header(CONTENT_LENGTH, String.valueOf(body.length()));
}
return this;
}
/**
* Charset of the Request Body, if known.
*
* @return the currently applied Charset.
*/
public Charset requestCharset() {
if (this.body != null) {
return this.body.getEncoding()
.orElse(this.charset);
}
return this.charset;
}
/**
* The Request Body.
*
* @return the request body.
*/
public byte[] body() {
return body.asBytes();
}
/**
* The Request.Body internal object.
*
* @return the internal Request.Body.
* @deprecated this abstraction is leaky and will be removed in later releases.
*/
@Deprecated
public Request.Body requestBody() {
return this.body;
}
/**
* Specify the Body Template to use. Can contain literals and expressions.
*
* @param bodyTemplate to use.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate bodyTemplate(String bodyTemplate) {
this.bodyTemplate = BodyTemplate.create(bodyTemplate, this.charset);
return this;
}
/**
* Specify the Body Template to use. Can contain literals and expressions.
*
* @param bodyTemplate to use.
* @return a RequestTemplate for chaining.
*/
public RequestTemplate bodyTemplate(String bodyTemplate, Charset charset) {
this.bodyTemplate = BodyTemplate.create(bodyTemplate, charset);
this.charset = charset;
return this;
}
/**
* Body Template to resolve.
*
* @return the unresolved body template.
*/
public String bodyTemplate() {
if (this.bodyTemplate != null) {
return this.bodyTemplate.toString();
}
return null;
}
@Override
public String toString() {
return request().toString();
}
/**
* Return if the variable exists on the uri, query, or headers, in this template.
*
* @param variable to look for.
* @return true if the variable exists, false otherwise.
*/
public boolean hasRequestVariable(String variable) {
return this.getRequestVariables().contains(variable);
}
/**
* Retrieve all uri, header, and query template variables.
*
* @return a List of all the variable names.
*/
public Collection<String> getRequestVariables() {
final Collection<String> variables = new LinkedHashSet<>(this.uriTemplate.getVariables());
this.queries.values().forEach(queryTemplate -> variables.addAll(queryTemplate.getVariables()));
this.headers.values()
.forEach(headerTemplate -> variables.addAll(headerTemplate.getVariables()));
return variables;
}
/**
* If this template has been resolved.
*
* @return true if the template has been resolved, false otherwise.
*/
@SuppressWarnings("unused")
public boolean resolved() {
return this.resolved;
}
/**
* The Query String for the template. Expressions are not resolved.
*
* @return the Query String.
*/
public String queryLine() {
StringBuilder queryString = new StringBuilder();
if (!this.queries.isEmpty()) {
Iterator<QueryTemplate> iterator = this.queries.values().iterator();
while (iterator.hasNext()) {
QueryTemplate queryTemplate = iterator.next();
String query = queryTemplate.toString();
if (query != null && !query.isEmpty()) {
queryString.append(query);
if (iterator.hasNext()) {
queryString.append("&");
}
}
}
}