This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 119
/
HttpJsonCallContext.java
454 lines (410 loc) · 13.7 KB
/
HttpJsonCallContext.java
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
/*
* Copyright 2017 Google LLC
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.api.gax.httpjson;
import com.google.api.core.BetaApi;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.TransportChannel;
import com.google.api.gax.rpc.internal.ApiCallContextOptions;
import com.google.api.gax.rpc.internal.Headers;
import com.google.api.gax.tracing.ApiTracer;
import com.google.api.gax.tracing.BaseApiTracer;
import com.google.auth.Credentials;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.threeten.bp.Duration;
import org.threeten.bp.Instant;
/**
* HttpJsonCallContext encapsulates context data used to make an http-json call.
*
* <p>HttpJsonCallContext is immutable in the sense that none of its methods modifies the
* HttpJsonCallContext itself or the underlying data. Methods of the form {@code withX} return
* copies of the object, but with one field changed. The immutability and thread safety of the
* arguments solely depends on the arguments themselves.
*/
@BetaApi
public final class HttpJsonCallContext implements ApiCallContext {
private final HttpJsonChannel channel;
private final Duration timeout;
private final Instant deadline;
private final Credentials credentials;
private final ImmutableMap<String, List<String>> extraHeaders;
private final ApiCallContextOptions options;
private final ApiTracer tracer;
private final RetrySettings retrySettings;
private final ImmutableSet<StatusCode.Code> retryableCodes;
/** Returns an empty instance. */
public static HttpJsonCallContext createDefault() {
return new HttpJsonCallContext(
null,
null,
null,
null,
ImmutableMap.<String, List<String>>of(),
ApiCallContextOptions.getDefaultOptions(),
null,
null,
null);
}
private HttpJsonCallContext(
HttpJsonChannel channel,
Duration timeout,
Instant deadline,
Credentials credentials,
ImmutableMap<String, List<String>> extraHeaders,
ApiCallContextOptions options,
ApiTracer tracer,
RetrySettings defaultRetrySettings,
Set<StatusCode.Code> defaultRetryableCodes) {
this.channel = channel;
this.timeout = timeout;
this.deadline = deadline;
this.credentials = credentials;
this.extraHeaders = extraHeaders;
this.options = options;
this.tracer = tracer;
this.retrySettings = defaultRetrySettings;
this.retryableCodes =
defaultRetryableCodes == null ? null : ImmutableSet.copyOf(defaultRetryableCodes);
}
/**
* Returns inputContext cast to {@link HttpJsonCallContext}, or an empty {@link
* HttpJsonCallContext} if inputContext is null.
*
* @param inputContext the {@link ApiCallContext} to cast if it is not null
*/
@Override
public HttpJsonCallContext nullToSelf(ApiCallContext inputContext) {
HttpJsonCallContext httpJsonCallContext;
if (inputContext == null) {
httpJsonCallContext = this;
} else {
if (!(inputContext instanceof HttpJsonCallContext)) {
throw new IllegalArgumentException(
"context must be an instance of HttpJsonCallContext, but found "
+ inputContext.getClass().getName());
}
httpJsonCallContext = (HttpJsonCallContext) inputContext;
}
return httpJsonCallContext;
}
@Override
public HttpJsonCallContext merge(ApiCallContext inputCallContext) {
if (inputCallContext == null) {
return this;
}
if (!(inputCallContext instanceof HttpJsonCallContext)) {
throw new IllegalArgumentException(
"context must be an instance of HttpJsonCallContext, but found "
+ inputCallContext.getClass().getName());
}
HttpJsonCallContext httpJsonCallContext = (HttpJsonCallContext) inputCallContext;
HttpJsonChannel newChannel = httpJsonCallContext.channel;
if (newChannel == null) {
newChannel = this.channel;
}
Duration newTimeout = httpJsonCallContext.timeout;
if (newTimeout == null) {
newTimeout = this.timeout;
}
Instant newDeadline = httpJsonCallContext.deadline;
if (newDeadline == null) {
newDeadline = this.deadline;
}
Credentials newCredentials = httpJsonCallContext.credentials;
if (newCredentials == null) {
newCredentials = this.credentials;
}
ImmutableMap<String, List<String>> newExtraHeaders =
Headers.mergeHeaders(extraHeaders, httpJsonCallContext.extraHeaders);
ApiCallContextOptions newOptions = options.merge(httpJsonCallContext.options);
ApiTracer newTracer = httpJsonCallContext.tracer;
if (newTracer == null) {
newTracer = this.tracer;
}
RetrySettings newRetrySettings = httpJsonCallContext.retrySettings;
if (newRetrySettings == null) {
newRetrySettings = this.retrySettings;
}
Set<StatusCode.Code> newRetryableCodes = httpJsonCallContext.retryableCodes;
if (newRetryableCodes == null) {
newRetryableCodes = this.retryableCodes;
}
return new HttpJsonCallContext(
newChannel,
newTimeout,
newDeadline,
newCredentials,
newExtraHeaders,
newOptions,
newTracer,
newRetrySettings,
newRetryableCodes);
}
@Override
public HttpJsonCallContext withCredentials(Credentials newCredentials) {
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
newCredentials,
this.extraHeaders,
this.options,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
@Override
public HttpJsonCallContext withTransportChannel(TransportChannel inputChannel) {
Preconditions.checkNotNull(inputChannel);
if (!(inputChannel instanceof HttpJsonTransportChannel)) {
throw new IllegalArgumentException(
"Expected HttpJsonTransportChannel, got " + inputChannel.getClass().getName());
}
HttpJsonTransportChannel transportChannel = (HttpJsonTransportChannel) inputChannel;
return withChannel(transportChannel.getChannel());
}
@Override
public HttpJsonCallContext withTimeout(Duration timeout) {
// Default RetrySettings use 0 for RPC timeout. Treat that as disabled timeouts.
if (timeout != null && (timeout.isZero() || timeout.isNegative())) {
timeout = null;
}
// Prevent expanding deadlines
if (timeout != null && this.timeout != null && this.timeout.compareTo(timeout) <= 0) {
return this;
}
return new HttpJsonCallContext(
this.channel,
timeout,
this.deadline,
this.credentials,
this.extraHeaders,
this.options,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
@Nullable
@Override
public Duration getTimeout() {
return timeout;
}
@Override
public ApiCallContext withStreamWaitTimeout(@Nonnull Duration streamWaitTimeout) {
throw new UnsupportedOperationException("Http/json transport does not support streaming");
}
@Nullable
@Override
public Duration getStreamWaitTimeout() {
throw new UnsupportedOperationException("Http/json transport does not support streaming");
}
@Override
public ApiCallContext withStreamIdleTimeout(@Nonnull Duration streamIdleTimeout) {
throw new UnsupportedOperationException("Http/json transport does not support streaming");
}
@Nullable
@Override
public Duration getStreamIdleTimeout() {
throw new UnsupportedOperationException("Http/json transport does not support streaming");
}
@BetaApi("The surface for extra headers is not stable yet and may change in the future.")
@Override
public ApiCallContext withExtraHeaders(Map<String, List<String>> extraHeaders) {
Preconditions.checkNotNull(extraHeaders);
ImmutableMap<String, List<String>> newExtraHeaders =
Headers.mergeHeaders(this.extraHeaders, extraHeaders);
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
this.credentials,
newExtraHeaders,
this.options,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
@BetaApi("The surface for extra headers is not stable yet and may change in the future.")
@Override
public Map<String, List<String>> getExtraHeaders() {
return extraHeaders;
}
/** {@inheritDoc} */
@Override
public <T> ApiCallContext withOption(Key<T> key, T value) {
ApiCallContextOptions newOptions = options.withOption(key, value);
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
this.credentials,
this.extraHeaders,
newOptions,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
/** {@inheritDoc} */
@Override
public <T> T getOption(Key<T> key) {
return options.getOption(key);
}
public HttpJsonChannel getChannel() {
return channel;
}
public Instant getDeadline() {
return deadline;
}
public Credentials getCredentials() {
return credentials;
}
@Override
public RetrySettings getRetrySettings() {
return retrySettings;
}
@Override
public HttpJsonCallContext withRetrySettings(RetrySettings retrySettings) {
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
this.credentials,
this.extraHeaders,
this.options,
this.tracer,
retrySettings,
this.retryableCodes);
}
@Override
public Set<StatusCode.Code> getRetryableCodes() {
return retryableCodes;
}
@Override
public HttpJsonCallContext withRetryableCodes(Set<StatusCode.Code> retryableCodes) {
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
this.credentials,
this.extraHeaders,
this.options,
this.tracer,
this.retrySettings,
retryableCodes);
}
public HttpJsonCallContext withChannel(HttpJsonChannel newChannel) {
return new HttpJsonCallContext(
newChannel,
this.timeout,
this.deadline,
this.credentials,
this.extraHeaders,
this.options,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
public HttpJsonCallContext withDeadline(Instant newDeadline) {
return new HttpJsonCallContext(
this.channel,
this.timeout,
newDeadline,
this.credentials,
this.extraHeaders,
this.options,
this.tracer,
this.retrySettings,
this.retryableCodes);
}
@Nonnull
@Override
public ApiTracer getTracer() {
if (tracer == null) {
return BaseApiTracer.getInstance();
}
return tracer;
}
/** {@inheritDoc} */
@Override
public HttpJsonCallContext withTracer(@Nonnull ApiTracer newTracer) {
Preconditions.checkNotNull(newTracer);
return new HttpJsonCallContext(
this.channel,
this.timeout,
this.deadline,
this.credentials,
this.extraHeaders,
this.options,
newTracer,
this.retrySettings,
this.retryableCodes);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
HttpJsonCallContext that = (HttpJsonCallContext) o;
return Objects.equals(this.channel, that.channel)
&& Objects.equals(this.timeout, that.timeout)
&& Objects.equals(this.deadline, that.deadline)
&& Objects.equals(this.credentials, that.credentials)
&& Objects.equals(this.extraHeaders, that.extraHeaders)
&& Objects.equals(this.options, that.options)
&& Objects.equals(this.tracer, that.tracer)
&& Objects.equals(this.retrySettings, that.retrySettings)
&& Objects.equals(this.retryableCodes, that.retryableCodes);
}
@Override
public int hashCode() {
return Objects.hash(
channel,
timeout,
deadline,
credentials,
extraHeaders,
options,
tracer,
retrySettings,
retryableCodes);
}
}