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

box / box-java-sdk / #6309

27 Feb 2026 04:09PM UTC coverage: 34.848% (+0.009%) from 34.839%
#6309

push

github

web-flow
docs: Update description for delete archives endpoint (box/box-openapi#585) (#1733)

Co-authored-by: box-sdk-build <box-sdk-build@box.com>

18722 of 53725 relevant lines covered (34.85%)

0.35 hits per line

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

78.7
/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.box.sdkgen.networking.proxyconfig.ProxyConfig;
22
import com.box.sdkgen.networking.timeoutconfig.TimeoutConfig;
23
import com.fasterxml.jackson.databind.JsonNode;
24
import java.io.IOException;
25
import java.net.InetSocketAddress;
26
import java.net.Proxy;
27
import java.net.URI;
28
import java.nio.charset.StandardCharsets;
29
import java.util.Locale;
30
import java.util.Map;
31
import java.util.Objects;
32
import java.util.Optional;
33
import java.util.TreeMap;
34
import java.util.concurrent.TimeUnit;
35
import java.util.stream.Collectors;
36
import okhttp3.Call;
37
import okhttp3.Credentials;
38
import okhttp3.Headers;
39
import okhttp3.HttpUrl;
40
import okhttp3.MediaType;
41
import okhttp3.MultipartBody;
42
import okhttp3.OkHttpClient;
43
import okhttp3.Request;
44
import okhttp3.RequestBody;
45
import okhttp3.Response;
46
import okio.BufferedSink;
47
import okio.Okio;
48
import okio.Source;
49

50
public class BoxNetworkClient implements NetworkClient {
51

52
  private static final int BASE_TIMEOUT = 1;
53
  private static final double RANDOM_FACTOR = 0.5;
54
  private static final int DEFAULT_HTTP_PORT = 80;
55
  private static final int DEFAULT_HTTPS_PORT = 443;
56

57
  protected OkHttpClient httpClient;
58

59
  public BoxNetworkClient(OkHttpClient httpClient) {
1✔
60
    this.httpClient = httpClient;
1✔
61
  }
1✔
62

63
  public BoxNetworkClient() {
1✔
64
    httpClient = getDefaultOkHttpClientBuilder().build();
1✔
65
  }
1✔
66

67
  public OkHttpClient getHttpClient() {
68
    return httpClient;
×
69
  }
70

71
  public BoxNetworkClient withProxy(ProxyConfig config) {
72
    URI uri = URI.create(config.getUrl());
×
73
    String host = Objects.requireNonNull(uri.getHost(), "Invalid Proxy URL");
×
74

75
    String scheme =
×
76
        Optional.ofNullable(uri.getScheme())
×
77
            .filter(schema -> schema.startsWith("http"))
×
78
            .orElseThrow(() -> new IllegalArgumentException("Invalid Proxy URL: " + uri));
×
79

80
    int port =
×
81
        (uri.getPort() != -1)
×
82
            ? uri.getPort()
×
83
            : ("https".equalsIgnoreCase(scheme) ? DEFAULT_HTTPS_PORT : DEFAULT_HTTP_PORT);
×
84

85
    OkHttpClient.Builder clientBuilder =
×
86
        httpClient
87
            .newBuilder()
×
88
            .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress(host, port)));
×
89

90
    String username = config.getUsername();
×
91
    String password = config.getPassword();
×
92
    if (username != null && !username.trim().isEmpty() && password != null) {
×
93
      String basic = Credentials.basic(username, password, StandardCharsets.UTF_8);
×
94
      clientBuilder.proxyAuthenticator(
×
95
          (route, resp) ->
96
              resp.request().newBuilder().header("Proxy-Authorization", basic).build());
×
97
    }
98
    return new BoxNetworkClient(clientBuilder.build());
×
99
  }
100

101
  public BoxNetworkClient withTimeoutConfig(TimeoutConfig config) {
102
    if (config == null) {
1✔
103
      throw new IllegalArgumentException("TimeoutConfig cannot be null");
×
104
    }
105

106
    OkHttpClient.Builder clientBuilder = httpClient.newBuilder();
1✔
107

108
    Long connectionTimeoutMs = config.getConnectionTimeoutMs();
1✔
109
    if (connectionTimeoutMs != null) {
1✔
110
      if (connectionTimeoutMs < 0) {
×
111
        throw new IllegalArgumentException("connectionTimeoutMs cannot be negative");
×
112
      }
113
      clientBuilder.connectTimeout(connectionTimeoutMs.longValue(), TimeUnit.MILLISECONDS);
×
114
    }
115

116
    Long readTimeoutMs = config.getReadTimeoutMs();
1✔
117
    if (readTimeoutMs != null) {
1✔
118
      if (readTimeoutMs < 0) {
1✔
119
        throw new IllegalArgumentException("readTimeoutMs cannot be negative");
×
120
      }
121
      clientBuilder.readTimeout(readTimeoutMs.longValue(), TimeUnit.MILLISECONDS);
1✔
122
    }
123
    return new BoxNetworkClient(clientBuilder.build());
1✔
124
  }
125

126
  public FetchResponse fetch(FetchOptions options) {
127
    NetworkSession networkSession =
1✔
128
        options.getNetworkSession() == null ? new NetworkSession() : options.getNetworkSession();
1✔
129

130
    FetchOptions fetchOptions =
1✔
131
        networkSession.getInterceptors().stream()
1✔
132
            .reduce(
1✔
133
                options,
134
                (modifiedOptions, interceptor) -> interceptor.beforeRequest(modifiedOptions),
1✔
135
                (o1, o2) -> o2);
×
136

137
    boolean authenticationNeeded = false;
1✔
138
    Request request;
139
    FetchResponse fetchResponse = new FetchResponse.Builder(0, new TreeMap<>()).build();
1✔
140
    Exception exceptionThrown = null;
1✔
141

142
    int attemptNumber = 1;
1✔
143
    int numberOfRetriesOnException = 0;
1✔
144
    int attemptForRetry = 0;
1✔
145
    boolean shouldRetry = false;
1✔
146

147
    while (true) {
148
      request = prepareRequest(fetchOptions, authenticationNeeded, networkSession);
1✔
149

150
      Response response = null;
1✔
151
      String rawResponseBody = null;
1✔
152

153
      try {
154
        response = executeOnClient(request);
1✔
155

156
        Map<String, String> headersMap =
1✔
157
            response.headers().toMultimap().entrySet().stream()
1✔
158
                .collect(
1✔
159
                    Collectors.toMap(
1✔
160
                        Map.Entry::getKey,
161
                        e -> e.getValue().get(0),
1✔
162
                        (existing, replacement) -> existing,
×
163
                        () -> new TreeMap<>(String.CASE_INSENSITIVE_ORDER)));
1✔
164

165
        String responseUrl =
1✔
166
            response.networkResponse() != null
1✔
167
                ? response.networkResponse().request().url().toString()
1✔
168
                : response.request().url().toString();
1✔
169

170
        attemptForRetry = attemptNumber;
1✔
171

172
        if (Objects.equals(
1✔
173
            fetchOptions.getResponseFormat().getEnumValue(), ResponseFormat.BINARY)) {
1✔
174
          fetchResponse =
1✔
175
              new FetchResponse.Builder(response.code(), headersMap)
1✔
176
                  .content(response.body().byteStream())
1✔
177
                  .url(responseUrl)
1✔
178
                  .build();
1✔
179
        } else {
180
          rawResponseBody = response.body() != null ? response.body().string() : null;
1✔
181
          fetchResponse =
1✔
182
              new FetchResponse.Builder(response.code(), headersMap)
1✔
183
                  .data(readJsonFromRawBody(rawResponseBody))
1✔
184
                  .url(responseUrl)
1✔
185
                  .build();
1✔
186
        }
187

188
        fetchResponse =
1✔
189
            networkSession.getInterceptors().stream()
1✔
190
                .reduce(
1✔
191
                    fetchResponse,
192
                    (modifiedResponse, interceptor) -> interceptor.afterRequest(modifiedResponse),
1✔
193
                    (o1, o2) -> o2);
×
194

195
      } catch (Exception e) {
1✔
196
        exceptionThrown = e;
1✔
197
        numberOfRetriesOnException++;
1✔
198
        attemptForRetry = numberOfRetriesOnException;
1✔
199
        if (response != null) {
1✔
200
          response.close();
×
201
        }
202
      }
1✔
203

204
      shouldRetry =
1✔
205
          networkSession
206
              .getRetryStrategy()
1✔
207
              .shouldRetry(fetchOptions, fetchResponse, attemptForRetry);
1✔
208

209
      if (shouldRetry) {
1✔
210
        double retryDelay =
1✔
211
            networkSession
212
                .getRetryStrategy()
1✔
213
                .retryAfter(fetchOptions, fetchResponse, attemptForRetry);
1✔
214
        if (retryDelay > 0) {
1✔
215
          try {
216
            TimeUnit.SECONDS.sleep((long) retryDelay);
1✔
217
          } catch (InterruptedException ie) {
×
218
            Thread.currentThread().interrupt();
×
219
            throw new BoxSDKError("Retry interrupted", ie);
×
220
          }
1✔
221
        }
222
        attemptNumber++;
1✔
223
        continue;
1✔
224
      }
225

226
      if (fetchResponse.getStatus() >= 300
1✔
227
          && fetchResponse.getStatus() < 400
1✔
228
          && fetchOptions.followRedirects) {
1✔
229
        if (!fetchResponse.getHeaders().containsKey("Location")) {
1✔
230
          throw new BoxSDKError(
1✔
231
              "Redirect response missing Location header for " + fetchOptions.getUrl());
1✔
232
        }
233
        URI originalUri = URI.create(fetchOptions.getUrl());
1✔
234
        URI redirectUri = URI.create(fetchResponse.getHeaders().get("Location"));
1✔
235
        boolean sameOrigin =
1✔
236
            originalUri.getHost().equals(redirectUri.getHost())
1✔
237
                && originalUri.getPort() == redirectUri.getPort()
1✔
238
                && originalUri.getScheme().equals(redirectUri.getScheme());
1✔
239
        return fetch(
1✔
240
            new FetchOptions.Builder(fetchResponse.getHeaders().get("Location"), "GET")
1✔
241
                .responseFormat(fetchOptions.getResponseFormat())
1✔
242
                .auth(sameOrigin ? fetchOptions.getAuth() : null)
1✔
243
                .networkSession(networkSession)
1✔
244
                .build());
1✔
245
      }
246

247
      if (fetchResponse.getStatus() >= 200 && fetchResponse.getStatus() < 400) {
1✔
248
        return fetchResponse;
1✔
249
      }
250

251
      throwOnUnsuccessfulResponse(
1✔
252
          request,
253
          fetchResponse,
254
          rawResponseBody,
255
          exceptionThrown,
256
          networkSession.getDataSanitizer());
1✔
257
    }
×
258
  }
259

260
  private static Request prepareRequest(
261
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
262
    Request.Builder requestBuilder = new Request.Builder().url(options.getUrl());
1✔
263
    Headers headers = prepareHeaders(options, reauthenticate, networkSession);
1✔
264
    HttpUrl url = prepareUrl(options);
1✔
265
    RequestBody body = prepareRequestBody(options);
1✔
266

267
    requestBuilder.headers(headers);
1✔
268
    requestBuilder.url(url);
1✔
269
    requestBuilder.method(options.getMethod().toUpperCase(Locale.ROOT), body);
1✔
270
    return requestBuilder.build();
1✔
271
  }
272

273
  private static Headers prepareHeaders(
274
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
275
    Headers.Builder headersBuilder = new Headers.Builder();
1✔
276

277
    networkSession.getAdditionalHeaders().forEach(headersBuilder::add);
1✔
278

279
    if (options.getHeaders() != null) {
1✔
280
      options.getHeaders().forEach(headersBuilder::add);
1✔
281
    }
282
    if (options.getAuth() != null) {
1✔
283
      if (reauthenticate) {
1✔
284
        options.getAuth().refreshToken(networkSession);
×
285
      }
286
      headersBuilder.add(
1✔
287
          "Authorization", options.getAuth().retrieveAuthorizationHeader(networkSession));
1✔
288
    }
289
    headersBuilder.add("User-Agent", USER_AGENT_HEADER);
1✔
290
    headersBuilder.add("X-Box-UA", X_BOX_UA_HEADER);
1✔
291
    return headersBuilder.build();
1✔
292
  }
293

294
  private static HttpUrl prepareUrl(FetchOptions options) {
295

296
    HttpUrl baseUrl = HttpUrl.parse(options.getUrl());
1✔
297
    if (baseUrl == null) {
1✔
298
      throw new IllegalArgumentException("Invalid URL " + options.getUrl());
×
299
    }
300
    HttpUrl.Builder urlBuilder = baseUrl.newBuilder();
1✔
301
    if (options.getParams() != null) {
1✔
302
      options.getParams().forEach(urlBuilder::addQueryParameter);
1✔
303
    }
304
    return urlBuilder.build();
1✔
305
  }
306

307
  private static RequestBody prepareRequestBody(FetchOptions options) {
308
    if (options.getMethod().equalsIgnoreCase("GET")) {
1✔
309
      return null;
1✔
310
    }
311
    String contentType = options.getContentType();
1✔
312
    MediaType mediaType = MediaType.parse(contentType);
1✔
313
    switch (contentType) {
1✔
314
      case "application/json":
315
      case "application/json-patch+json":
316
        return options.getData() != null
1✔
317
            ? RequestBody.create(sdToJson(options.getData()), mediaType)
1✔
318
            : RequestBody.create("", mediaType);
1✔
319
      case "application/x-www-form-urlencoded":
320
        return options.getData() != null
1✔
321
            ? RequestBody.create(sdToUrlParams(options.getData()), mediaType)
1✔
322
            : RequestBody.create("", mediaType);
×
323
      case "multipart/form-data":
324
        MultipartBody.Builder bodyBuilder = new MultipartBody.Builder().setType(MultipartBody.FORM);
1✔
325
        for (MultipartItem part : options.multipartData) {
1✔
326
          if (part.getData() != null) {
1✔
327
            bodyBuilder.addFormDataPart(part.getPartName(), sdToJson(part.getData()));
1✔
328
          } else {
329
            bodyBuilder.addFormDataPart(
1✔
330
                part.getPartName(),
1✔
331
                part.getFileName() != null ? part.getFileName() : "file",
1✔
332
                createMultipartRequestBody(part));
1✔
333
          }
334
        }
1✔
335
        return bodyBuilder.build();
1✔
336
      case "application/octet-stream":
337
        return RequestBody.create(readByteStream(options.getFileStream()), mediaType);
1✔
338
      default:
339
        throw new IllegalArgumentException("Unsupported content type " + contentType);
×
340
    }
341
  }
342

343
  protected Call createNewCall(Request request) {
344
    return this.httpClient.newCall(request);
1✔
345
  }
346

347
  private Response executeOnClient(Request request) throws IOException {
348
    return createNewCall(request).execute();
1✔
349
  }
350

351
  private static JsonNode readJsonFromRawBody(String rawResponseBody) {
352
    if (rawResponseBody == null) {
1✔
353
      return null;
×
354
    }
355

356
    try {
357
      return jsonToSerializedData(rawResponseBody);
1✔
358
    } catch (Exception e) {
1✔
359
      return null;
1✔
360
    }
361
  }
362

363
  private static void throwOnUnsuccessfulResponse(
364
      Request request,
365
      FetchResponse fetchResponse,
366
      String rawResponseBody,
367
      Exception exceptionThrown,
368
      DataSanitizer dataSanitizer) {
369
    if (fetchResponse.getStatus() == 0 && exceptionThrown != null) {
1✔
370
      throw new BoxSDKError(exceptionThrown.getMessage(), exceptionThrown);
1✔
371
    }
372
    try {
373
      throw BoxAPIError.fromAPICall(request, fetchResponse, rawResponseBody, dataSanitizer);
1✔
374
    } finally {
375
      try {
376
        if (fetchResponse.getContent() != null) {
1✔
377
          fetchResponse.getContent().close();
1✔
378
        }
379
      } catch (IOException ignored) {
×
380
      }
1✔
381
    }
382
  }
383

384
  private static int getRetryAfterTimeInSeconds(int attemptNumber, String retryAfterHeader) {
385

386
    if (retryAfterHeader != null) {
×
387
      return Integer.parseInt(retryAfterHeader);
×
388
    }
389

390
    double minWindow = 1 - RANDOM_FACTOR;
×
391
    double maxWindow = 1 + RANDOM_FACTOR;
×
392
    double jitter = (Math.random() * (maxWindow - minWindow)) + minWindow;
×
393
    return (int) (Math.pow(2, attemptNumber) * BASE_TIMEOUT * jitter);
×
394
  }
395

396
  public static RequestBody createMultipartRequestBody(MultipartItem part) {
397
    return new RequestBody() {
1✔
398
      @Override
399
      public MediaType contentType() {
400
        if (part.contentType != null) {
1✔
401
          return MediaType.parse(part.contentType);
1✔
402
        }
403
        return MediaType.parse("application/octet-stream");
1✔
404
      }
405

406
      @Override
407
      public void writeTo(BufferedSink sink) throws IOException {
408
        try (Source source = Okio.source(part.getFileStream())) {
1✔
409
          sink.writeAll(source);
1✔
410
        }
411
      }
1✔
412
    };
413
  }
414

415
  public static OkHttpClient.Builder getDefaultOkHttpClientBuilder() {
416
    return new OkHttpClient.Builder()
1✔
417
        .followSslRedirects(true)
1✔
418
        .followRedirects(false)
1✔
419
        .connectionSpecs(singletonList(MODERN_TLS))
1✔
420
        .retryOnConnectionFailure(false);
1✔
421
  }
422
}
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