• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

box / box-java-sdk / #4743

06 Aug 2025 12:44PM UTC coverage: 38.165% (-0.1%) from 38.272%
#4743

push

github

web-flow
chore: Adjust `github` workflows for legacy repos (box/box-codegen#772) (#1331)

18979 of 49729 relevant lines covered (38.16%)

0.38 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.49
/src/main/java/com/box/sdkgen/networking/boxnetworkclient/BoxNetworkClient.java
1
package com.box.sdkgen.networking.boxnetworkclient;
2

3
import static com.box.sdkgen.box.BoxConstants.USER_AGENT_HEADER;
4
import static com.box.sdkgen.box.BoxConstants.X_BOX_UA_HEADER;
5
import static com.box.sdkgen.internal.utils.UtilsManager.readByteStream;
6
import static com.box.sdkgen.serialization.json.JsonManager.jsonToSerializedData;
7
import static com.box.sdkgen.serialization.json.JsonManager.sdToJson;
8
import static com.box.sdkgen.serialization.json.JsonManager.sdToUrlParams;
9
import static java.util.Collections.singletonList;
10
import static okhttp3.ConnectionSpec.MODERN_TLS;
11

12
import com.box.sdkgen.box.errors.BoxAPIError;
13
import com.box.sdkgen.box.errors.BoxSDKError;
14
import com.box.sdkgen.internal.logging.DataSanitizer;
15
import com.box.sdkgen.networking.fetchoptions.FetchOptions;
16
import com.box.sdkgen.networking.fetchoptions.MultipartItem;
17
import com.box.sdkgen.networking.fetchoptions.ResponseFormat;
18
import com.box.sdkgen.networking.fetchresponse.FetchResponse;
19
import com.box.sdkgen.networking.network.NetworkSession;
20
import com.box.sdkgen.networking.networkclient.NetworkClient;
21
import com.fasterxml.jackson.databind.JsonNode;
22
import java.io.IOException;
23
import java.net.URI;
24
import java.util.Locale;
25
import java.util.Map;
26
import java.util.Objects;
27
import java.util.TreeMap;
28
import java.util.concurrent.TimeUnit;
29
import java.util.stream.Collectors;
30
import okhttp3.Call;
31
import okhttp3.Headers;
32
import okhttp3.HttpUrl;
33
import okhttp3.MediaType;
34
import okhttp3.MultipartBody;
35
import okhttp3.OkHttpClient;
36
import okhttp3.Request;
37
import okhttp3.RequestBody;
38
import okhttp3.Response;
39
import okio.BufferedSink;
40
import okio.Okio;
41
import okio.Source;
42

43
public class BoxNetworkClient implements NetworkClient {
44

45
  private static final int BASE_TIMEOUT = 1;
46
  private static final double RANDOM_FACTOR = 0.5;
47

48
  protected OkHttpClient httpClient;
49

50
  public BoxNetworkClient(OkHttpClient httpClient) {
×
51
    this.httpClient = httpClient;
×
52
  }
×
53

54
  public BoxNetworkClient() {
1✔
55
    OkHttpClient.Builder builder =
1✔
56
        new OkHttpClient.Builder()
57
            .followSslRedirects(true)
1✔
58
            .followRedirects(false)
1✔
59
            .connectionSpecs(singletonList(MODERN_TLS));
1✔
60
    httpClient = builder.build();
1✔
61
  }
1✔
62

63
  public OkHttpClient getHttpClient() {
64
    return httpClient;
×
65
  }
66

67
  public FetchResponse fetch(FetchOptions options) {
68
    NetworkSession networkSession =
1✔
69
        options.getNetworkSession() == null ? new NetworkSession() : options.getNetworkSession();
1✔
70

71
    FetchOptions fetchOptions =
1✔
72
        networkSession.getInterceptors().stream()
1✔
73
            .reduce(
1✔
74
                options,
75
                (modifiedOptions, interceptor) -> interceptor.beforeRequest(modifiedOptions),
1✔
76
                (o1, o2) -> o2);
×
77

78
    boolean authenticationNeeded = false;
1✔
79
    Request request;
80
    FetchResponse fetchResponse = null;
1✔
81
    Exception exceptionThrown = null;
1✔
82

83
    int attemptNumber = 1;
1✔
84
    int numberOfRetriesOnException = 0;
1✔
85
    int attemptForRetry = 0;
1✔
86
    boolean shouldRetry = false;
1✔
87

88
    while (true) {
89
      request = prepareRequest(fetchOptions, authenticationNeeded, networkSession);
1✔
90

91
      Response response = null;
1✔
92
      String rawResponseBody = null;
1✔
93

94
      try {
95
        response = executeOnClient(request);
1✔
96

97
        Map<String, String> headersMap =
1✔
98
            response.headers().toMultimap().entrySet().stream()
1✔
99
                .collect(
1✔
100
                    Collectors.toMap(
1✔
101
                        Map.Entry::getKey,
102
                        e -> e.getValue().get(0),
1✔
103
                        (existing, replacement) -> existing,
×
104
                        () -> new TreeMap<>(String.CASE_INSENSITIVE_ORDER)));
1✔
105

106
        String responseUrl =
1✔
107
            response.networkResponse() != null
1✔
108
                ? response.networkResponse().request().url().toString()
1✔
109
                : response.request().url().toString();
1✔
110

111
        attemptForRetry = attemptNumber;
1✔
112

113
        if (Objects.equals(
1✔
114
            fetchOptions.getResponseFormat().getEnumValue(), ResponseFormat.BINARY)) {
1✔
115
          fetchResponse =
1✔
116
              new FetchResponse.Builder(response.code(), headersMap)
1✔
117
                  .content(response.body().byteStream())
1✔
118
                  .url(responseUrl)
1✔
119
                  .build();
1✔
120
        } else {
121
          rawResponseBody = response.body() != null ? response.body().string() : null;
1✔
122
          fetchResponse =
1✔
123
              new FetchResponse.Builder(response.code(), headersMap)
1✔
124
                  .data(readJsonFromRawBody(rawResponseBody))
1✔
125
                  .url(responseUrl)
1✔
126
                  .build();
1✔
127
        }
128

129
        fetchResponse =
1✔
130
            networkSession.getInterceptors().stream()
1✔
131
                .reduce(
1✔
132
                    fetchResponse,
133
                    (modifiedResponse, interceptor) -> interceptor.afterRequest(modifiedResponse),
1✔
134
                    (o1, o2) -> o2);
×
135

136
      } catch (Exception e) {
×
137
        exceptionThrown = e;
×
138
        numberOfRetriesOnException++;
×
139
        attemptForRetry = numberOfRetriesOnException;
×
140
        if (response != null) {
×
141
          response.close();
×
142
        }
143

144
        fetchResponse =
×
145
            new FetchResponse.Builder(0, new TreeMap<>(String.CASE_INSENSITIVE_ORDER)).build();
×
146
      }
1✔
147

148
      shouldRetry =
1✔
149
          networkSession
150
              .getRetryStrategy()
1✔
151
              .shouldRetry(fetchOptions, fetchResponse, attemptForRetry);
1✔
152

153
      if (shouldRetry) {
1✔
154
        double retryDelay =
×
155
            networkSession
156
                .getRetryStrategy()
×
157
                .retryAfter(fetchOptions, fetchResponse, attemptForRetry);
×
158
        if (retryDelay > 0) {
×
159
          try {
160
            TimeUnit.SECONDS.sleep((long) retryDelay);
×
161
          } catch (InterruptedException ie) {
×
162
            Thread.currentThread().interrupt();
×
163
            throw new BoxSDKError("Retry interrupted", ie);
×
164
          }
×
165
        }
166
        attemptNumber++;
×
167
        continue;
×
168
      }
169

170
      if (fetchResponse != null
1✔
171
          && fetchResponse.getStatus() >= 300
1✔
172
          && fetchResponse.getStatus() < 400
1✔
173
          && fetchOptions.followRedirects) {
1✔
174
        if (!fetchResponse.getHeaders().containsKey("Location")) {
1✔
175
          throw new BoxSDKError(
1✔
176
              "Redirect response missing Location header for " + fetchOptions.getUrl());
1✔
177
        }
178
        URI originalUri = URI.create(fetchOptions.getUrl());
1✔
179
        URI redirectUri = URI.create(fetchResponse.getHeaders().get("Location"));
1✔
180
        boolean sameOrigin =
1✔
181
            originalUri.getHost().equals(redirectUri.getHost())
1✔
182
                && originalUri.getPort() == redirectUri.getPort()
1✔
183
                && originalUri.getScheme().equals(redirectUri.getScheme());
1✔
184
        return fetch(
1✔
185
            new FetchOptions.Builder(fetchResponse.getHeaders().get("Location"), "GET")
1✔
186
                .responseFormat(fetchOptions.getResponseFormat())
1✔
187
                .auth(sameOrigin ? fetchOptions.getAuth() : null)
1✔
188
                .networkSession(networkSession)
1✔
189
                .build());
1✔
190
      }
191

192
      if (fetchResponse != null
1✔
193
          && fetchResponse.getStatus() >= 200
1✔
194
          && fetchResponse.getStatus() < 400) {
1✔
195
        return fetchResponse;
1✔
196
      }
197

198
      throwOnUnsuccessfulResponse(
1✔
199
          request,
200
          fetchResponse,
201
          rawResponseBody,
202
          exceptionThrown,
203
          networkSession.getDataSanitizer());
1✔
204
    }
×
205
  }
206

207
  private static Request prepareRequest(
208
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
209
    Request.Builder requestBuilder = new Request.Builder().url(options.getUrl());
1✔
210
    Headers headers = prepareHeaders(options, reauthenticate, networkSession);
1✔
211
    HttpUrl url = prepareUrl(options);
1✔
212
    RequestBody body = prepareRequestBody(options);
1✔
213

214
    requestBuilder.headers(headers);
1✔
215
    requestBuilder.url(url);
1✔
216
    requestBuilder.method(options.getMethod().toUpperCase(Locale.ROOT), body);
1✔
217
    return requestBuilder.build();
1✔
218
  }
219

220
  private static Headers prepareHeaders(
221
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
222
    Headers.Builder headersBuilder = new Headers.Builder();
1✔
223

224
    networkSession.getAdditionalHeaders().forEach(headersBuilder::add);
1✔
225

226
    if (options.getHeaders() != null) {
1✔
227
      options.getHeaders().forEach(headersBuilder::add);
1✔
228
    }
229
    if (options.getAuth() != null) {
1✔
230
      if (reauthenticate) {
1✔
231
        options.getAuth().refreshToken(networkSession);
×
232
      }
233
      headersBuilder.add(
1✔
234
          "Authorization", options.getAuth().retrieveAuthorizationHeader(networkSession));
1✔
235
    }
236
    headersBuilder.add("User-Agent", USER_AGENT_HEADER);
1✔
237
    headersBuilder.add("X-Box-UA", X_BOX_UA_HEADER);
1✔
238
    return headersBuilder.build();
1✔
239
  }
240

241
  private static HttpUrl prepareUrl(FetchOptions options) {
242

243
    HttpUrl baseUrl = HttpUrl.parse(options.getUrl());
1✔
244
    if (baseUrl == null) {
1✔
245
      throw new IllegalArgumentException("Invalid URL " + options.getUrl());
×
246
    }
247
    HttpUrl.Builder urlBuilder = baseUrl.newBuilder();
1✔
248
    if (options.getParams() != null) {
1✔
249
      options.getParams().forEach(urlBuilder::addQueryParameter);
1✔
250
    }
251
    return urlBuilder.build();
1✔
252
  }
253

254
  private static RequestBody prepareRequestBody(FetchOptions options) {
255
    if (options.getMethod().equalsIgnoreCase("GET")) {
1✔
256
      return null;
1✔
257
    }
258
    String contentType = options.getContentType();
1✔
259
    MediaType mediaType = MediaType.parse(contentType);
1✔
260
    switch (contentType) {
1✔
261
      case "application/json":
262
      case "application/json-patch+json":
263
        return options.getData() != null
1✔
264
            ? RequestBody.create(sdToJson(options.getData()), mediaType)
1✔
265
            : RequestBody.create("", mediaType);
1✔
266
      case "application/x-www-form-urlencoded":
267
        return options.getData() != null
1✔
268
            ? RequestBody.create(sdToUrlParams(options.getData()), mediaType)
1✔
269
            : RequestBody.create("", mediaType);
×
270
      case "multipart/form-data":
271
        MultipartBody.Builder bodyBuilder = new MultipartBody.Builder().setType(MultipartBody.FORM);
1✔
272
        for (MultipartItem part : options.multipartData) {
1✔
273
          if (part.getData() != null) {
1✔
274
            bodyBuilder.addFormDataPart(part.getPartName(), sdToJson(part.getData()));
1✔
275
          } else {
276
            bodyBuilder.addFormDataPart(
1✔
277
                part.getPartName(),
1✔
278
                part.getFileName() != null ? part.getFileName() : "file",
1✔
279
                createMultipartRequestBody(part));
1✔
280
          }
281
        }
1✔
282
        return bodyBuilder.build();
1✔
283
      case "application/octet-stream":
284
        return RequestBody.create(readByteStream(options.getFileStream()), mediaType);
1✔
285
      default:
286
        throw new IllegalArgumentException("Unsupported content type " + contentType);
×
287
    }
288
  }
289

290
  protected Call createNewCall(Request request) {
291
    return this.httpClient.newCall(request);
1✔
292
  }
293

294
  private Response executeOnClient(Request request) throws IOException {
295
    return createNewCall(request).execute();
1✔
296
  }
297

298
  private static JsonNode readJsonFromRawBody(String rawResponseBody) {
299
    if (rawResponseBody == null) {
1✔
300
      return null;
×
301
    }
302

303
    try {
304
      return jsonToSerializedData(rawResponseBody);
1✔
305
    } catch (Exception e) {
1✔
306
      return null;
1✔
307
    }
308
  }
309

310
  private static void throwOnUnsuccessfulResponse(
311
      Request request,
312
      FetchResponse fetchResponse,
313
      String rawResponseBody,
314
      Exception exceptionThrown,
315
      DataSanitizer dataSanitizer) {
316
    if (fetchResponse == null) {
1✔
317
      throw new BoxSDKError(exceptionThrown.getMessage(), exceptionThrown);
×
318
    }
319
    try {
320
      throw BoxAPIError.fromAPICall(request, fetchResponse, rawResponseBody, dataSanitizer);
1✔
321
    } finally {
322
      try {
323
        if (fetchResponse.getContent() != null) {
1✔
324
          fetchResponse.getContent().close();
1✔
325
        }
326
      } catch (IOException ignored) {
×
327
      }
1✔
328
    }
329
  }
330

331
  private static int getRetryAfterTimeInSeconds(int attemptNumber, String retryAfterHeader) {
332

333
    if (retryAfterHeader != null) {
×
334
      return Integer.parseInt(retryAfterHeader);
×
335
    }
336

337
    double minWindow = 1 - RANDOM_FACTOR;
×
338
    double maxWindow = 1 + RANDOM_FACTOR;
×
339
    double jitter = (Math.random() * (maxWindow - minWindow)) + minWindow;
×
340
    return (int) (Math.pow(2, attemptNumber) * BASE_TIMEOUT * jitter);
×
341
  }
342

343
  public static RequestBody createMultipartRequestBody(MultipartItem part) {
344
    return new RequestBody() {
1✔
345
      @Override
346
      public MediaType contentType() {
347
        if (part.contentType != null) {
1✔
348
          return MediaType.parse(part.contentType);
1✔
349
        }
350
        return MediaType.parse("application/octet-stream");
1✔
351
      }
352

353
      @Override
354
      public void writeTo(BufferedSink sink) throws IOException {
355
        try (Source source = Okio.source(part.getFileStream())) {
1✔
356
          sink.writeAll(source);
1✔
357
        }
358
      }
1✔
359
    };
360
  }
361
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc