-
Notifications
You must be signed in to change notification settings - Fork 48
/
ApiClientHeaderProvider.java
241 lines (199 loc) · 7.51 KB
/
ApiClientHeaderProvider.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
/*
* 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.rpc;
import com.google.api.gax.core.GaxProperties;
import com.google.common.collect.ImmutableMap;
import java.io.Serializable;
import java.util.Map;
/**
* Implementation of HeaderProvider that provides headers describing the API client library making
* API calls.
*/
public class ApiClientHeaderProvider implements HeaderProvider, Serializable {
private static final long serialVersionUID = -8876627296793342119L;
static final String QUOTA_PROJECT_ID_HEADER_KEY = "x-goog-user-project";
public static final String API_VERSION_HEADER_KEY = "x-goog-api-version";
private final Map<String, String> headers;
protected ApiClientHeaderProvider(Builder builder) {
ImmutableMap.Builder<String, String> headersBuilder = ImmutableMap.builder();
if (builder.getApiClientHeaderKey() != null) {
StringBuilder apiClientHeaderValue = new StringBuilder();
// Order of tokens matters!!!
appendToken(apiClientHeaderValue, builder.getJvmToken());
appendToken(apiClientHeaderValue, builder.getClientLibToken());
appendToken(apiClientHeaderValue, builder.getGeneratedLibToken());
appendToken(apiClientHeaderValue, builder.getGeneratedRuntimeToken());
appendToken(apiClientHeaderValue, builder.getTransportToken());
if (apiClientHeaderValue.length() > 0) {
headersBuilder.put(builder.getApiClientHeaderKey(), apiClientHeaderValue.toString());
}
}
if (builder.getResourceHeaderKey() != null && builder.getResourceToken() != null) {
headersBuilder.put(builder.getResourceHeaderKey(), builder.getResourceToken());
}
if (builder.getQuotaProjectIdToken() != null) {
headersBuilder.put(QUOTA_PROJECT_ID_HEADER_KEY, builder.getQuotaProjectIdToken());
}
if (builder.getApiVersionToken() != null) {
headersBuilder.put(API_VERSION_HEADER_KEY, builder.getApiVersionToken());
}
this.headers = headersBuilder.build();
}
@Override
public Map<String, String> getHeaders() {
return headers;
}
protected static void appendToken(StringBuilder sb, String token) {
if (token != null) {
if (sb.length() > 0) {
sb.append(' ');
}
sb.append(token);
}
}
public static Builder newBuilder() {
return new Builder();
}
public static String getDefaultApiClientHeaderKey() {
return "x-goog-api-client";
}
public static String getDefaultResourceHeaderKey() {
return "google-cloud-resource-prefix";
}
public static class Builder {
private String apiClientHeaderKey;
private String jvmToken;
private String clientLibToken;
private String generatedLibToken;
private String generatedRuntimeToken;
private String transportToken;
private String quotaProjectIdToken;
private String resourceHeaderKey;
private String resourceToken;
private String apiVersionToken;
protected Builder() {
// Initialize with default values
apiClientHeaderKey = getDefaultApiClientHeaderKey();
setJvmToken(GaxProperties.getJavaVersion());
clientLibToken = null;
generatedLibToken = null;
setClientRuntimeToken(GaxProperties.getGaxVersion());
transportToken = null;
quotaProjectIdToken = null;
resourceHeaderKey = getDefaultResourceHeaderKey();
resourceToken = null;
apiVersionToken = null;
}
public String getApiClientHeaderKey() {
return apiClientHeaderKey;
}
public Builder setApiClientHeaderKey(String apiClientHeaderKey) {
this.apiClientHeaderKey = apiClientHeaderKey;
return this;
}
public String getJvmToken() {
return jvmToken;
}
public Builder setJvmToken(String version) {
this.jvmToken = constructToken("gl-java", version);
return this;
}
public String getClientLibToken() {
return clientLibToken;
}
public Builder setClientLibToken(String name, String version) {
this.clientLibToken = constructToken(name, version);
return this;
}
public String getGeneratedLibToken() {
return generatedLibToken;
}
public Builder setGeneratedLibToken(String name, String version) {
this.generatedLibToken = constructToken(name, version);
return this;
}
public String getGeneratedRuntimeToken() {
return generatedRuntimeToken;
}
public Builder setClientRuntimeToken(String version) {
this.generatedRuntimeToken = constructToken("gax", version);
return this;
}
public String getTransportToken() {
return transportToken;
}
public Builder setTransportToken(String name, String version) {
this.transportToken = constructToken(name, version);
return this;
}
/** @return the quotaProjectIdToken used for quota and billing purposes. */
public String getQuotaProjectIdToken() {
return quotaProjectIdToken;
}
/** Sets the project ID used for quota and billing purposes. */
public Builder setQuotaProjectIdToken(String quotaProjectIdToken) {
this.quotaProjectIdToken = quotaProjectIdToken;
return this;
}
public String getResourceHeaderKey() {
return resourceHeaderKey;
}
public Builder setResourceHeaderKey(String resourceHeaderKey) {
this.resourceHeaderKey = resourceHeaderKey;
return this;
}
public String getResourceToken() {
return resourceToken;
}
public Builder setResourceToken(String resourceToken) {
this.resourceToken = resourceToken;
return this;
}
public String getApiVersionToken() {
return apiVersionToken;
}
public Builder setApiVersionToken(String apiVersionToken) {
this.apiVersionToken = apiVersionToken;
return this;
}
private String constructToken(String name, String version) {
if (version == null) {
return null;
}
if (name == null) {
throw new IllegalArgumentException("Token name cannot be null");
}
return name + '/' + version;
}
public ApiClientHeaderProvider build() {
return new ApiClientHeaderProvider(this);
}
}
}