Merge pull request #594 from splitio/development

Release 4.17.0

Author: chillaq

CHANGES.txt

@@ -1,3 +1,7 @@
+4.17.0 (Aug 22, 2025)
+- Added a maximum size payload when posting unique keys telemetry in batches
+- Added ProxyConfiguration parameter to support proxies, including Harness Forward Proxy, allowing also for more secured authentication options: MTLS, Bearer token and user/password authentication. Read more in our docs.
+
 4.16.1 (Jul 21, 2025)
 - Fixed vulnerabilities: 
     - Upgraded org.apache.commons-commons-lang3 to 3.18.0

client/pom.xml

@@ -5,9 +5,9 @@
     <parent>
         <groupId>io.split.client</groupId>
         <artifactId>java-client-parent</artifactId>
-        <version>4.16.1</version>
+        <version>4.17.0</version>
     </parent>
-    <version>4.16.1</version>
+    <version>4.17.0</version>
     <artifactId>java-client</artifactId>
     <packaging>jar</packaging>
     <name>Java Client</name>
@@ -24,7 +24,7 @@
                         <version>0.8.0</version>
                         <extensions>true</extensions>
                         <configuration>
-                            <ignorePublishedComponents>true</ignorePublishedComponents>
+                            <ignorePublishedComponents>false</ignorePublishedComponents>
                             <publishingServerId>central</publishingServerId>
                             <autoPublish>false</autoPublish>
                             <waitUntil>published</waitUntil>

client/src/main/java/io/split/client/HttpClientDynamicCredentials.java

@@ -0,0 +1,26 @@
+package io.split.client;
+
+import io.split.client.dtos.BearerCredentialsProvider;
+import org.apache.hc.client5.http.auth.AuthScope;
+import org.apache.hc.client5.http.auth.BearerToken;
+import org.apache.hc.client5.http.auth.Credentials;
+import org.apache.hc.core5.http.protocol.HttpContext;
+
+class HttpClientDynamicCredentials implements  org.apache.hc.client5.http.auth.CredentialsProvider {
+
+    private final BearerCredentialsProvider _bearerCredentialsProvider;
+
+    public HttpClientDynamicCredentials (BearerCredentialsProvider bearerCredentialsProvider) {
+        _bearerCredentialsProvider = bearerCredentialsProvider;
+    }
+
+    @Override
+    public Credentials getCredentials(AuthScope authScope, HttpContext context) {
+
+        // This Provider is invoked every time a request is made.
+        // This should invoke a user-custom provider responsible for:
+        return new BearerToken(_bearerCredentialsProvider.getToken());
+    }
+
+}
+

client/src/main/java/io/split/client/SplitClientConfig.java

@@ -1,5 +1,6 @@
 package io.split.client;
 
+import io.split.client.dtos.ProxyConfiguration;
 import io.split.client.impressions.ImpressionListener;
 import io.split.client.impressions.ImpressionsManager;
 import io.split.client.utils.FileTypeEnum;
@@ -8,6 +9,7 @@
 import io.split.storages.enums.OperationMode;
 import io.split.storages.enums.StorageMode;
 import org.apache.hc.core5.http.HttpHost;
+import org.slf4j.LoggerFactory;
 import pluggable.CustomStorageWrapper;
 
 import java.io.IOException;
@@ -27,13 +29,22 @@
  */
 public class SplitClientConfig {
 
+    private static final org.slf4j.Logger _log = LoggerFactory.getLogger(SplitClientConfig.class);
     public static final String LOCALHOST_DEFAULT_FILE = "split.yaml";
     public static final String SDK_ENDPOINT = "https://sdk.split.io";
     public static final String EVENTS_ENDPOINT = "https://events.split.io";
     public static final String AUTH_ENDPOINT = "https://auth.split.io/api/v2/auth";
     public static final String STREAMING_ENDPOINT = "https://streaming.split.io/sse";
     public static final String TELEMETRY_ENDPOINT = "https://telemetry.split.io/api/v1";
 
+    public static class HttpScheme {
+        private HttpScheme() {
+            throw new IllegalStateException("Utility class");
+        }
+        public static final String HTTP = "http";
+        public static final String HTTPS = "https";
+    }
+
     private final String _endpoint;
     private final String _eventsEndpoint;
 
@@ -82,6 +93,7 @@ public class SplitClientConfig {
     private final ThreadFactory _threadFactory;
 
     // Proxy configs
+    private final ProxyConfiguration _proxyConfiguration;
     private final HttpHost _proxy;
     private final String _proxyUsername;
     private final String _proxyPassword;
@@ -118,6 +130,7 @@ private SplitClientConfig(String endpoint,
                               HttpHost proxy,
                               String proxyUsername,
                               String proxyPassword,
+                              ProxyConfiguration proxyConfiguration,
                               int eventsQueueSize,
                               long eventSendIntervalInMillis,
                               int maxStringLength,
@@ -171,6 +184,7 @@ private SplitClientConfig(String endpoint,
         _proxy = proxy;
         _proxyUsername = proxyUsername;
         _proxyPassword = proxyPassword;
+        _proxyConfiguration = proxyConfiguration;
         _eventsQueueSize = eventsQueueSize;
         _eventSendIntervalInMillis = eventSendIntervalInMillis;
         _maxStringLength = maxStringLength;
@@ -302,6 +316,10 @@ public String proxyPassword() {
         return _proxyPassword;
     }
 
+    public ProxyConfiguration proxyConfiguration() {
+        return _proxyConfiguration;
+    }
+
     public long eventSendIntervalInMillis() {
         return _eventSendIntervalInMillis;
     }
@@ -417,8 +435,8 @@ public boolean isSdkEndpointOverridden() {
     }
 
     public CustomHttpModule alternativeHTTPModule() { return _alternativeHTTPModule; }
-    public static final class Builder {
 
+    public static final class Builder {
         private String _endpoint = SDK_ENDPOINT;
         private boolean _endpointSet = false;
         private String _eventsEndpoint = EVENTS_ENDPOINT;
@@ -442,6 +460,7 @@ public static final class Builder {
         private int _proxyPort = -1;
         private String _proxyUsername;
         private String _proxyPassword;
+        private ProxyConfiguration _proxyConfiguration;
         private int _eventsQueueSize = 500;
         private long _eventSendIntervalInMillis = 30 * (long)1000;
         private int _maxStringLength = 250;
@@ -734,32 +753,44 @@ public Builder waitBeforeShutdown(int waitTime) {
 
         /**
          * The host location of the proxy. Default is localhost.
+         * @deprecated
+         * This method is deprecated.
+         * <p> Use {@link ProxyConfiguration)} instead.
          *
          * @param proxyHost location of the proxy
          * @return this builder
          */
+        @Deprecated
         public Builder proxyHost(String proxyHost) {
             _proxyHost = proxyHost;
             return this;
         }
 
         /**
          * The port of the proxy. Default is -1.
+         * @deprecated
+         * This method is deprecated.
+         * <p> Use {@link ProxyConfiguration)} instead.
          *
          * @param proxyPort port for the proxy
          * @return this builder
          */
+        @Deprecated
         public Builder proxyPort(int proxyPort) {
             _proxyPort = proxyPort;
             return this;
         }
 
         /**
          * Set the username for authentication against the proxy (if proxy settings are enabled). (Optional).
+         * @deprecated
+         * This method is deprecated.
+         * <p> Use {@link ProxyConfiguration)} instead.
          *
          * @param proxyUsername
          * @return this builder
          */
+        @Deprecated
         public Builder proxyUsername(String proxyUsername) {
             _proxyUsername = proxyUsername;
             return this;
@@ -776,6 +807,17 @@ public Builder proxyPassword(String proxyPassword) {
             return this;
         }
 
+        /**
+         * Set the mtls authentication against the proxy (if proxy settings are enabled). (Optional).
+         *
+         * @param proxyConfiguration
+         * @return this builder
+         */
+        public Builder proxyConfiguration(ProxyConfiguration proxyConfiguration) {
+            _proxyConfiguration = proxyConfiguration;
+            return this;
+        }
+
         /**
          * Disables running destroy() on shutdown by default.
          *
@@ -927,7 +969,7 @@ public Builder operationMode(OperationMode mode) {
 
         /**
          *
-         * @param storage mode
+         * @param mode
          * @return this builder
          */
         public Builder storageMode(StorageMode mode) {
@@ -1096,6 +1138,26 @@ private void verifyAlternativeClient() {
             }
         }
 
+        private void verifyProxy() {
+            if (_proxyConfiguration == null)
+                return;
+
+            if (_proxyPort != -1) {
+                _log.warn("Both the deprecated proxy configuration methods (`proxyHost`, `proxyPort`, `proxyUsername`, or `proxyPassword`) " +
+                        "and the new `ProxyConfiguration` builder are being used. `ProxyConfiguration` will take precedence.");
+            }
+
+            if (!(_proxyConfiguration.getHost().getSchemeName().equals(HttpScheme.HTTP) ||
+                    _proxyConfiguration.getHost().getSchemeName().equals(HttpScheme.HTTPS))) {
+                throw new IllegalArgumentException("Proxy scheme must be either http or https.");
+            }
+
+            if ((_proxyConfiguration.getP12File() != null && _proxyConfiguration.getPassKey() == null) ||
+                    (_proxyConfiguration.getP12File() == null && _proxyConfiguration.getPassKey() != null)) {
+                throw new IllegalArgumentException("Proxy mTLS must have p12 file path and name, and pass phrase.");
+            }
+        }
+
         public SplitClientConfig build() {
 
             verifyRates();
@@ -1108,6 +1170,8 @@ public SplitClientConfig build() {
 
             verifyAlternativeClient();
 
+            verifyProxy();
+
             if (_numThreadsForSegmentFetch <= 0) {
                 throw new IllegalArgumentException("Number of threads for fetching segments MUST be greater than zero");
             }
@@ -1133,6 +1197,7 @@ public SplitClientConfig build() {
                     proxy(),
                     _proxyUsername,
                     _proxyPassword,
+                    _proxyConfiguration,
                     _eventsQueueSize,
                     _eventSendIntervalInMillis,
                     _maxStringLength,