feat(java): Introduce ConfigurationOverride class

Author: booniepepper

.openapi-generator/FILES

@@ -83,6 +83,7 @@ src/main/java/dev/openfga/sdk/api/client/BaseConfiguration.java
 src/main/java/dev/openfga/sdk/api/client/ClientCredentials.java
 src/main/java/dev/openfga/sdk/api/client/Configuration.java
 src/main/java/dev/openfga/sdk/api/client/Configuration.java
+src/main/java/dev/openfga/sdk/api/client/ConfigurationOverride.java
 src/main/java/dev/openfga/sdk/api/client/CredentialsMethod.java
 src/main/java/dev/openfga/sdk/api/client/JSON.java
 src/main/java/dev/openfga/sdk/api/client/Pair.java

src/main/java/dev/openfga/sdk/api/OpenFgaApi.java

@@ -49,7 +49,7 @@
  */
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
-        date = "2023-08-21T23:45:26.204414Z[Etc/UTC]")
+        date = "2023-08-22T23:54:43.912230Z[Etc/UTC]")
 public class ApiClient {
 
     private HttpClient.Builder builder;

src/main/java/dev/openfga/sdk/api/client/ApiClient.java

@@ -16,7 +16,7 @@
 
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
-        date = "2023-08-21T23:45:26.204414Z[Etc/UTC]")
+        date = "2023-08-22T23:54:43.912230Z[Etc/UTC]")
 public class ApiException extends Exception {
     private int code = 0;
     private HttpHeaders responseHeaders = null;

src/main/java/dev/openfga/sdk/api/client/ApiException.java

@@ -12,12 +12,9 @@
 
 package dev.openfga.sdk.api.client;
 
-import dev.openfga.sdk.errors.FgaInvalidParameterException;
 import java.time.Duration;
 
 public interface BaseConfiguration {
-    void assertValid() throws FgaInvalidParameterException;
-
     String getApiUrl();
 
     String getUserAgent();

src/main/java/dev/openfga/sdk/api/client/BaseConfiguration.java

@@ -24,7 +24,7 @@
 import java.time.Duration;
 
 /**
- * Configurations for an ApiClient.
+ * Configurations for an api client.
  */
 public class Configuration implements BaseConfiguration {
     public static final String VERSION = "0.0.1";
@@ -49,7 +49,6 @@ public Configuration(String apiUrl) {
     /**
      * Assert that the configuration is valid.
      */
-    @Override
     public void assertValid() throws FgaInvalidParameterException {
         // If apiUrl is null/empty/whitespace it will resolve to
         // DEFAULT_API_URL when getApiUrl is called.
@@ -73,13 +72,39 @@ public void assertValid() throws FgaInvalidParameterException {
         }
     }
 
+    /**
+     * Construct a new {@link Configuration} with any non-null values of a {@link ConfigurationOverride} and remaining values from this {@link Configuration}.
+     *
+     * @param configurationOverride The values to override
+     * @return A new {@link Configuration} with values of this Configuration mixed with non-null values of configurationOverride
+     */
+    public Configuration override(ConfigurationOverride configurationOverride) {
+        Configuration result = new Configuration(apiUrl);
+
+        String overrideApiUrl = configurationOverride.getApiUrl();
+        if (overrideApiUrl != null) {
+            result.apiUrl(overrideApiUrl);
+        }
+
+        String overrideUserAgent = configurationOverride.getUserAgent();
+        result.userAgent(overrideUserAgent != null ? overrideUserAgent : userAgent);
+
+        Duration overrideReadTimeout = configurationOverride.getReadTimeout();
+        result.readTimeout(overrideReadTimeout != null ? overrideReadTimeout : readTimeout);
+
+        Duration overrideConnectTimeout = configurationOverride.getConnectTimeout();
+        result.connectTimeout(overrideConnectTimeout != null ? overrideConnectTimeout : connectTimeout);
+
+        return result;
+    }
+
     /**
      * Set the API URL for the http client.
      *
      * @param apiUrl The URL.
      * @return This object.
      */
-    public BaseConfiguration apiUrl(String apiUrl) {
+    public Configuration apiUrl(String apiUrl) {
         this.apiUrl = apiUrl;
         return this;
     }
@@ -104,7 +129,7 @@ public String getApiUrl() {
      * @param userAgent The user agent.
      * @return This object.
      */
-    public BaseConfiguration userAgent(String userAgent) {
+    public Configuration userAgent(String userAgent) {
         this.userAgent = userAgent;
         return this;
     }
@@ -130,7 +155,7 @@ public String getUserAgent() {
      *                    effectively infinite value.
      * @return This object.
      */
-    public BaseConfiguration readTimeout(Duration readTimeout) {
+    public Configuration readTimeout(Duration readTimeout) {
         this.readTimeout = readTimeout;
         return this;
     }
@@ -162,7 +187,7 @@ public Duration getReadTimeout() {
      * @param connectTimeout connection timeout in milliseconds
      * @return This object.
      */
-    public BaseConfiguration connectTimeout(Duration connectTimeout) {
+    public Configuration connectTimeout(Duration connectTimeout) {
         this.connectTimeout = connectTimeout;
         return this;
     }

src/main/java/dev/openfga/sdk/api/client/Configuration.java

@@ -0,0 +1,138 @@
+/*
+ * OpenFGA
+ * A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.
+ *
+ * The version of the OpenAPI document: 0.1
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+package dev.openfga.sdk.api.client;
+
+import java.net.http.HttpClient;
+import java.net.http.HttpConnectTimeoutException;
+import java.net.http.HttpRequest;
+import java.time.Duration;
+
+/**
+ * Configuration overrides for an api client. Values are initialized to null, and any values unset are intended to fall
+ * through to the values of a {@link Configuration}.
+ * <p>
+ * More details on intended usage of this class can be found in the documentation of the {@link Configuration#override(ConfigurationOverride)} method.
+ */
+public class ConfigurationOverride implements BaseConfiguration {
+    private String apiUrl;
+    private String userAgent;
+    private Duration readTimeout;
+    private Duration connectTimeout;
+
+    public ConfigurationOverride() {
+        this.apiUrl = null;
+        this.userAgent = null;
+        this.readTimeout = null;
+        this.connectTimeout = null;
+    }
+
+    /**
+     * Set the API URL for the http client.
+     *
+     * @param apiUrl The URL.
+     * @return This object.
+     */
+    public BaseConfiguration apiUrl(String apiUrl) {
+        this.apiUrl = apiUrl;
+        return this;
+    }
+
+    /**
+     * Get the API URL that was set.
+     *
+     * @return The url.
+     */
+    @Override
+    public String getApiUrl() {
+        return apiUrl;
+    }
+
+    /**
+     * Set the user agent.
+     *
+     * @param userAgent The user agent.
+     * @return This object.
+     */
+    public BaseConfiguration userAgent(String userAgent) {
+        this.userAgent = userAgent;
+        return this;
+    }
+
+    /**
+     * Get the user agent.
+     *
+     * @return The user agent.
+     */
+    @Override
+    public String getUserAgent() {
+        return userAgent;
+    }
+
+    /**
+     * Set the read timeout for the http client.
+     *
+     * <p>This is the value used by default for each request, though it can be
+     * overridden on a per-request basis with a request interceptor.</p>
+     *
+     * @param readTimeout The read timeout used by default by the http client.
+     *                    Setting this value to null resets the timeout to an
+     *                    effectively infinite value.
+     * @return This object.
+     */
+    public BaseConfiguration readTimeout(Duration readTimeout) {
+        this.readTimeout = readTimeout;
+        return this;
+    }
+
+    /**
+     * Get the read timeout that was set.
+     *
+     * @return The read timeout, or null if no timeout was set. Null represents
+     * an infinite wait time.
+     */
+    @Override
+    public Duration getReadTimeout() {
+        return readTimeout;
+    }
+
+    /**
+     * Sets the connect timeout (in milliseconds) for the http client.
+     *
+     * <p> In the case where a new connection needs to be established, if
+     * the connection cannot be established within the given {@code
+     * duration}, then {@link HttpClient#send(HttpRequest, BodyHandler)
+     * HttpClient::send} throws an {@link HttpConnectTimeoutException}, or
+     * {@link HttpClient#sendAsync(HttpRequest, BodyHandler)
+     * HttpClient::sendAsync} completes exceptionally with an
+     * {@code HttpConnectTimeoutException}. If a new connection does not
+     * need to be established, for example if a connection can be reused
+     * from a previous request, then this timeout duration has no effect.
+     *
+     * @param connectTimeout connection timeout in milliseconds
+     * @return This object.
+     */
+    public BaseConfiguration connectTimeout(Duration connectTimeout) {
+        this.connectTimeout = connectTimeout;
+        return this;
+    }
+
+    /**
+     * Get connection timeout (in milliseconds).
+     *
+     * @return Timeout in milliseconds
+     */
+    @Override
+    public Duration getConnectTimeout() {
+        return connectTimeout;
+    }
+}

src/main/java/dev/openfga/sdk/api/client/ConfigurationOverride.java

@@ -14,7 +14,7 @@
 
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
-        date = "2023-08-21T23:45:26.204414Z[Etc/UTC]")
+        date = "2023-08-22T23:54:43.912230Z[Etc/UTC]")
 public class JSON {
     private ObjectMapper mapper;
 

src/main/java/dev/openfga/sdk/api/client/JSON.java

@@ -14,7 +14,7 @@
 
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
-        date = "2023-08-21T23:45:26.204414Z[Etc/UTC]")
+        date = "2023-08-22T23:54:43.912230Z[Etc/UTC]")
 public class Pair {
     private String name = "";
     private String value = "";

src/main/java/dev/openfga/sdk/api/client/Pair.java

@@ -21,7 +21,7 @@
  */
 @javax.annotation.Generated(
         value = "org.openapitools.codegen.languages.JavaClientCodegen",
-        date = "2023-08-21T23:45:26.204414Z[Etc/UTC]")
+        date = "2023-08-22T23:54:43.912230Z[Etc/UTC]")
 public abstract class AbstractOpenApiSchema {
 
     // store the actual instance of the schema/object