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
543 lines (501 loc) · 17 KB
/
RequestTemplate.java
File metadata and controls
543 lines (501 loc) · 17 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
/*
* Copyright 2013 Netflix, Inc.
*
* 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 com.google.common.base.Objects;
import com.google.common.base.Optional;
import com.google.common.base.Splitter;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.Iterables;
import com.google.common.collect.LinkedListMultimap;
import com.google.common.collect.ListMultimap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.util.Collection;
import java.util.Map;
import java.util.Map.Entry;
import static com.google.common.base.Charsets.UTF_8;
import static com.google.common.base.Objects.equal;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.net.HttpHeaders.CONTENT_LENGTH;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Builds a request to an http target. Not thread safe.
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* A combination of {@code javax.ws.rs.client.WebTarget} and
* {@code javax.ws.rs.client.Invocation.Builder}, ensuring you can modify any
* part of the request. However, this object is mutable, so needs to be guarded
* with the copy constructor.
*/
public final class RequestTemplate implements Serializable {
/**
* A templatized form for a PUT or POST command. Values of {@link javax.ws.rs.PathParam},
* {@link javax.ws.rs.QueryParam}, {@link javax.ws.rs.HeaderParam}, and {@link javax.ws.rs.FormParam} can be
* used are passed to the template.
* <p/>
* ex.
* <p/>
* <pre>
* @Body("<v01:getResourceRecordsOfZone><zoneName>{zoneName}</zoneName><rrType>0</rrType></v01:getResourceRecordsOfZone>")
* List<Record> listByZone(@PayloadParam("zoneName") String zoneName);
* </pre>
* <p/>
* Note that if you'd like curly braces literally in the body, urlencode
* them first.
*
* @see RequestTemplate#expand(String, Map)
*/
@Target(METHOD) @Retention(RUNTIME) public @interface Body {
String value();
}
private String method;
/* final to encourage mutable use vs replacing the object. */
private StringBuilder url = new StringBuilder();
private final ListMultimap<String, String> queries = LinkedListMultimap.create();
private final ListMultimap<String, String> headers = LinkedListMultimap.create();
private Optional<String> body = Optional.absent();
private Optional<String> bodyTemplate = Optional.absent();
public RequestTemplate() {
}
/* Copy constructor. Use this when making templates. */
public RequestTemplate(RequestTemplate toCopy) {
checkNotNull(toCopy, "toCopy");
this.method = toCopy.method;
this.url.append(toCopy.url);
this.queries.putAll(toCopy.queries);
this.headers.putAll(toCopy.headers);
this.body = toCopy.body;
this.bodyTemplate = toCopy.bodyTemplate;
}
/**
* Targets a template to this target, adding the {@link #url() base url} and
* any authentication headers.
* <p/>
* <p/>
* For example:
* <p/>
* <pre>
* public Request apply(RequestTemplate input) {
* input.insert(0, url());
* input.replaceHeader("X-Auth", currentToken);
* return input.asRequest();
* }
* </pre>
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* This call is similar to
* {@code javax.ws.rs.client.WebTarget.resolveTemplates(templateValues, true)}
* , except that the template values apply to any part of the request, not
* just the URL
*/
public RequestTemplate resolve(Map<String, ?> unencoded) {
Map<String, String> encoded = Maps.newLinkedHashMap();
for (Entry<String, ?> entry : unencoded.entrySet()) {
encoded.put(entry.getKey(), urlEncode(String.valueOf(entry.getValue())));
}
String queryLine = expand(queryLine(), encoded);
queries.clear();
pullAnyQueriesOutOfUrl(new StringBuilder(queryLine));
String resolvedUrl = expand(url.toString(), encoded).replace("%2F", "/");
url = new StringBuilder(resolvedUrl);
ListMultimap<String, String> resolvedHeaders = LinkedListMultimap.create();
for (Entry<String, String> entry : headers.entries()) {
String value = null;
if (entry.getValue().indexOf('{') == 0) {
value = String.valueOf(unencoded.get(entry.getKey()));
} else {
value = entry.getValue();
}
if (value != null)
resolvedHeaders.put(entry.getKey(), value);
}
headers.clear();
headers.putAll(resolvedHeaders);
if (bodyTemplate.isPresent())
body(urlDecode(expand(bodyTemplate.get(), unencoded)));
return this;
}
/* roughly analogous to {@code javax.ws.rs.client.Target.request()}. */
public Request request() {
return new Request(method, new StringBuilder(url).append(queryLine()).toString(),
ImmutableListMultimap.copyOf(headers), body);
}
private static String urlDecode(String arg) {
try {
return URLDecoder.decode(arg, UTF_8.name());
} catch (UnsupportedEncodingException e) {
throw new RuntimeException(e);
}
}
private static String urlEncode(Object arg) {
try {
return URLEncoder.encode(String.valueOf(arg), UTF_8.name());
} catch (UnsupportedEncodingException e) {
throw new RuntimeException(e);
}
}
/**
* Expands a {@code template}, such as {@code username}, using the {@code variables} supplied. Any unresolved
* parameters will remain.
* <p/>
* Note that if you'd like curly braces literally in the {@code template},
* urlencode them first.
*
* @param template URI template that can be in level 1 <a
* href="http://tools.ietf.org/html/rfc6570">RFC6570</a> form.
* @param variables to the URI template
* @return expanded template, leaving any unresolved parameters literal
*/
public static String expand(String template, Map<String, ?> variables) {
// skip expansion if there's no valid variables set. ex. {a} is the
// first valid
if (checkNotNull(template, "template").length() < 3)
return template.toString();
checkNotNull(variables, "variables for %s", template);
boolean inVar = false;
StringBuilder var = new StringBuilder();
StringBuilder builder = new StringBuilder();
for (char c : Lists.charactersOf(template)) {
switch (c) {
case '{':
inVar = true;
break;
case '}':
inVar = false;
String key = var.toString();
Object value = variables.get(var.toString());
if (value != null)
builder.append(value);
else
builder.append('{').append(key).append('}');
var = new StringBuilder();
break;
default:
if (inVar)
var.append(c);
else
builder.append(c);
}
}
return builder.toString();
}
/* @see Request#method() */
public RequestTemplate method(String method) {
this.method = checkNotNull(method, "method");
return this;
}
/* @see Request#method() */
public String method() {
return method;
}
/* @see #url() */
public RequestTemplate append(CharSequence value) {
url.append(value);
url = pullAnyQueriesOutOfUrl(url);
return this;
}
/* @see #url() */
public RequestTemplate insert(int pos, CharSequence value) {
url.insert(pos, value);
url = pullAnyQueriesOutOfUrl(url);
return this;
}
public String url() {
return url.toString();
}
/**
* Replaces queries with the specified {@code configKey} with url decoded
* {@code values} supplied.
* <p/>
* When the {@code value} is {@code null}, all queries with the {@code configKey}
* are removed.
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* Like {@code WebTarget.query}, except the values can be templatized.
* <p/>
* ex.
* <p/>
* <pre>
* template.query("Signature", "{signature}");
* </pre>
*
* @param configKey the configKey of the query
* @param values can be a single null to imply removing all values. Else no
* values are expected to be null.
* @see #queries()
*/
public RequestTemplate query(String configKey, String... values) {
queries.removeAll(checkNotNull(configKey, "configKey"));
if (values != null && values.length > 0 && values[0] != null) {
for (String value : values)
this.queries.put(encodeIfNotVariable(configKey), encodeIfNotVariable(value));
}
return this;
}
/* @see #query(String, String...) */
public RequestTemplate query(String configKey, Iterable<String> values) {
if (values != null)
return query(configKey, Iterables.toArray(values, String.class));
return query(configKey, (String[]) null);
}
private String encodeIfNotVariable(String in) {
if (in == null || in.indexOf('{') == 0)
return in;
return urlEncode(in);
}
/**
* Replaces all existing queries with the newly supplied url decoded
* queries.
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* Like {@code WebTarget.queries}, except the values can be templatized.
* <p/>
* ex.
* <p/>
* <pre>
* template.queries(ImmutableMultimap.of("Signature", "{signature}"));
* </pre>
*
* @param queries if null, remove all queries. else value to replace all queries
* with.
* @see #queries()
*/
public RequestTemplate queries(Multimap<String, String> queries) {
if (queries == null || queries.isEmpty()) {
this.queries.clear();
} else {
for (Entry<String, Collection<String>> entry : queries.asMap().entrySet())
query(entry.getKey(), Iterables.toArray(entry.getValue(), String.class));
}
return this;
}
/**
* Returns an immutable copy of the url decoded queries.
*
* @see Request#url()
*/
public ListMultimap<String, String> queries() {
ListMultimap<String, String> unencoded = LinkedListMultimap.create();
for (Entry<String, String> entry : queries.entries())
unencoded.put(urlDecode(entry.getKey()), urlDecode(entry.getValue()));
return Multimaps.unmodifiableListMultimap(unencoded);
}
/**
* Replaces headers with the specified {@code configKey} with the
* {@code values} supplied.
* <p/>
* When the {@code value} is {@code null}, all headers with the {@code configKey}
* are removed.
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* Like {@code WebTarget.queries} and {@code javax.ws.rs.client.Invocation.Builder.header},
* except the values can be templatized.
* <p/>
* ex.
* <p/>
* <pre>
* template.query("X-Application-Version", "{version}");
* </pre>
*
* @param configKey the configKey of the header
* @param values can be a single null to imply removing all values. Else no
* values are expected to be null.
* @see #headers()
*/
public RequestTemplate header(String configKey, String... values) {
checkNotNull(configKey, "header configKey");
if (values == null || (values.length == 1 && values[0] == null))
headers.removeAll(configKey);
else
this.headers.replaceValues(configKey, ImmutableList.copyOf(values));
return this;
}
/* @see #header(String, String...) */
public RequestTemplate header(String configKey, Iterable<String> values) {
if (values != null)
return header(configKey, Iterables.toArray(values, String.class));
return header(configKey, (String[]) null);
}
/**
* Replaces all existing headers with the newly supplied headers.
* <p/>
* <h4>relationship to JAXRS 2.0</h4>
* <p/>
* Like {@code Invocation.Builder.headers(MultivaluedMap)}, except the
* values can be templatized.
* <p/>
* ex.
* <p/>
* <pre>
* template.headers(ImmutableMultimap.of("X-Application-Version", "{version}"));
* </pre>
*
* @param headers if null, remove all headers. else value to replace all headers
* with.
* @see #headers()
*/
public RequestTemplate headers(Multimap<String, String> headers) {
if (headers == null || headers.isEmpty())
this.headers.clear();
else
this.headers.putAll(headers);
return this;
}
/**
* Returns an immutable copy of the current headers.
*
* @see Request#headers()
*/
public ListMultimap<String, String> headers() {
return ImmutableListMultimap.copyOf(headers);
}
/**
* replaces the {@link com.google.common.net.HttpHeaders#CONTENT_LENGTH} header.
* <p/>
* Usually populated by {@link feign.codec.BodyEncoder} or {@link feign.codec.FormEncoder}
*
* @see Request#body()
*/
public RequestTemplate body(String body) {
this.body = Optional.fromNullable(body);
if (this.body.isPresent()) {
byte[] contentLength = body.getBytes(UTF_8);
header(CONTENT_LENGTH, String.valueOf(contentLength.length));
}
this.bodyTemplate = Optional.absent();
return this;
}
/* @see Request#body() */
public Optional<String> body() {
return body;
}
/**
* populated by {@link Body}
*
* @see Request#body()
*/
public RequestTemplate bodyTemplate(String bodyTemplate) {
this.bodyTemplate = Optional.fromNullable(bodyTemplate);
this.body = Optional.absent();
return this;
}
/**
* @see Request#body()
* @see #expand(String, Map)
*/
public Optional<String> bodyTemplate() {
return bodyTemplate;
}
@Override public int hashCode() {
return Objects.hashCode(method, url, queries, headers, body);
}
/**
* if there are any query params in the {@link #body()}, this will extract
* them out.
*
* @return
*/
private StringBuilder pullAnyQueriesOutOfUrl(StringBuilder url) {
// parse out queries
int queryIndex = url.indexOf("?");
if (queryIndex != -1) {
String queryLine = url.substring(queryIndex + 1);
ListMultimap<String, String> firstQueries = parseAndDecodeQueries(queryLine);
if (!queries.isEmpty()) {
firstQueries.putAll(queries);
queries.clear();
}
queries.putAll(firstQueries);
return new StringBuilder(url.substring(0, queryIndex));
}
return url;
}
private static ListMultimap<String, String> parseAndDecodeQueries(String queryLine) {
ListMultimap<String, String> map = LinkedListMultimap.create();
if (Strings.emptyToNull(queryLine) == null)
return map;
if (queryLine.indexOf('&') == -1) {
if (queryLine.indexOf('=') != -1)
putKV(queryLine, map);
else
map.put(queryLine, null);
} else {
for (String part : Splitter.on('&').split(queryLine)) {
putKV(part, map);
}
}
return map;
}
private static void putKV(String stringToParse, Multimap<String, String> map) {
String key;
String value;
// note that '=' can be a valid part of the value
int firstEq = stringToParse.indexOf('=');
if (firstEq == -1) {
key = urlDecode(stringToParse);
value = null;
} else {
key = urlDecode(stringToParse.substring(0, firstEq));
value = urlDecode(stringToParse.substring(firstEq + 1));
}
map.put(key, value);
}
@Override public boolean equals(Object obj) {
if (this == obj)
return true;
if (RequestTemplate.class != obj.getClass())
return false;
RequestTemplate that = RequestTemplate.class.cast(obj);
return equal(this.method, that.method) && equal(this.url, that.url) && equal(this.queries, that.queries)
&& equal(this.headers, that.headers) && equal(this.body, that.body);
}
@Override public String toString() {
return request().toString();
}
public String queryLine() {
if (queries.isEmpty())
return "";
StringBuilder queryBuilder = new StringBuilder();
for (Entry<String, ?> pair : queries.entries()) {
queryBuilder.append('&');
queryBuilder.append(pair.getKey());
if (pair.getValue() != null)
queryBuilder.append('=');
if (pair.getValue() != null && !pair.getValue().equals("")) {
queryBuilder.append(pair.getValue());
}
}
queryBuilder.deleteCharAt(0);
return queryBuilder.insert(0, '?').toString();
}
private static final long serialVersionUID = 1L;
}