Allow to modify the underlying okHttpClient from the BoxDeveloperEditionAPIConnection when using factory method

[davigotxi]

The BoxApiConnection class has a protected method modifyHttpClientBuilder that allows to modify the underlying okHttpClient by overriding the method from a subclass. This is useful for a variety of reasons (i.e. on our particular case to add some logging interceptors to debug what is going on at different stages of an http request).

When trying to extend the BoxDeveloperEditionAPIConnection subclass to preserve behavior we want to use one of the getAppEnterpriseConnection methods that internally using a private method tryRestoreUsingAccessTokenCache. However we cannot call this method unless using reflection.

A nicer solution would be to have that method as public or protected.

[congminh1254]

Hi @davigotxi

Have you tried something like this:

public class ModifiedBoxDeveloperEditionAPIConnection extends BoxDeveloperEditionAPIConnection {

    // Initialize class

    /**
     * {@inheritDoc}
     */
    @Override
    protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder) {
        return super.modifyHttpClientBuilder(httpClientBuilder);
    }
}

Bests,
Minh

[davigotxi]

Hi @davigotxi

Have you tried something like this:

public class ModifiedBoxDeveloperEditionAPIConnection extends BoxDeveloperEditionAPIConnection {

    // Initialize class

    /**
     * {@inheritDoc}
     */
    @Override
    protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder) {
        return super.modifyHttpClientBuilder(httpClientBuilder);
    }
}

Bests, Minh

Hi Minh,
thanks for that. Actually you are right, overriding the modifyHttpClientBuilder works; it is another private method we are having an issue trying to do:

public class DxrBoxApiConnection extends BoxDeveloperEditionAPIConnection {

  public DxrBoxApiConnection(String entityId, DeveloperEditionEntityType entityType, String clientID,
      String clientSecret,
      JWTEncryptionPreferences encryptionPref, IAccessTokenCache accessTokenCache) {
    super(entityId, entityType, clientID, clientSecret, encryptionPref, accessTokenCache);
  }

  public static DxrBoxApiConnection getAppEnterpriseConnection(
      String enterpriseId,
      String clientId,
      String clientSecret,
      JWTEncryptionPreferences encryptionPref,
      IAccessTokenCache accessTokenCache
  ) {
    var connection = new DxrBoxApiConnection(enterpriseId,
        DeveloperEditionEntityType.ENTERPRISE, clientId, clientSecret, encryptionPref, accessTokenCache);
    connection.tryRestoreUsingAccessTokenCache();
    return connection;
  }

  @Override
  protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder) {
    var builder = super.modifyHttpClientBuilder(httpClientBuilder);
    builder.addInterceptor(c -> {
      //do something
      return c.proceed(c.request());
    });
    return builder;
  }

}

the actual problem is with tryRestoreUsingAccessTokenCache that is private.

Silly me I was submitting this at last hour of my day and got it backwards.

Let me rewrite the issue and the PR.

[congminh1254]

Hi @davigotxi

Do you need anything else other than Interceptor? We already provided a method named api.setRequestInterceptor for this purpose.

Can you take a look and reuse this function?

[davigotxi]

hi @congminh1254
thanks for your answer, the setRequestInterceptor indeed is useful:

Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.
Params:
interceptor – the RequestInterceptor.

however it is limited on its scope. Even though I gave the example of a logging interceptor, I'm also interested on network interceptors that allow to go a bit deeper in the network stack.

Then again, I would like the ability to do that on the BoxDeveloperEditionAPIConnection without having to copy over a lot of its functionality on a new extending class since there are some methods called on the factory methods that are private (more specifically tryRestoreUsingAccessTokenCache); the simplest solution seems to be to make that method public

[congminh1254]

Hi @davigotxi

I merged your changes to the main branch, and it should be included in the next Java SDK release.

Bests,
Minh