Skip to content

Commit 61fe715

Browse files
chillaqchillaq
committed
Rename config field
1 parent 4662ee7 commit 61fe715

File tree

9 files changed

+421
-33
lines changed

9 files changed

+421
-33
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@
77

88
class HttpClientDynamicCredentials implements org.apache.hc.client5.http.auth.CredentialsProvider {
99

10-
private final ProxyRuntimeProvider _proxyRuntimeProvider;
10+
private final ProxyCredentialsProvider _proxyCredentialsProvider;
1111

12-
public HttpClientDynamicCredentials (ProxyRuntimeProvider proxyRuntimeProvider) {
13-
_proxyRuntimeProvider = proxyRuntimeProvider;
12+
public HttpClientDynamicCredentials (ProxyCredentialsProvider proxyCredentialsProvider) {
13+
_proxyCredentialsProvider = proxyCredentialsProvider;
1414
}
1515

1616
@Override
1717
public Credentials getCredentials(AuthScope authScope, HttpContext context) {
1818

1919
// This Provider is invoked every time a request is made.
2020
// This should invoke a user-custom provider responsible for:
21-
return new BearerToken(_proxyRuntimeProvider.getJwtToken());
21+
return new BearerToken(_proxyCredentialsProvider.getJwtToken());
2222
}
2323

2424
}

client/src/main/java/io/split/client/ProxyRuntimeProvider.java renamed to client/src/main/java/io/split/client/ProxyCredentialsProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.split.client;
22

3-
public interface ProxyRuntimeProvider
3+
public interface ProxyCredentialsProvider
44
{
55
/**
66
* Get the additional headers needed for all http operations

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public static class HttpScheme {
9191
private final HttpHost _proxy;
9292
private final String _proxyUsername;
9393
private final String _proxyPassword;
94-
private final ProxyRuntimeProvider _proxyRuntimeProvider;
94+
private final ProxyCredentialsProvider _proxyCredentialsProvider;
9595
private final ProxyMTLSAuth _proxyMtlsAuth;
9696

9797
// To be set during startup
@@ -126,7 +126,7 @@ private SplitClientConfig(String endpoint,
126126
HttpHost proxy,
127127
String proxyUsername,
128128
String proxyPassword,
129-
ProxyRuntimeProvider proxyRuntimeProvider,
129+
ProxyCredentialsProvider proxyCredentialsProvider,
130130
ProxyMTLSAuth proxyMtlsAuth,
131131
int eventsQueueSize,
132132
long eventSendIntervalInMillis,
@@ -181,7 +181,7 @@ private SplitClientConfig(String endpoint,
181181
_proxy = proxy;
182182
_proxyUsername = proxyUsername;
183183
_proxyPassword = proxyPassword;
184-
_proxyRuntimeProvider = proxyRuntimeProvider;
184+
_proxyCredentialsProvider = proxyCredentialsProvider;
185185
_proxyMtlsAuth = proxyMtlsAuth;
186186
_eventsQueueSize = eventsQueueSize;
187187
_eventSendIntervalInMillis = eventSendIntervalInMillis;
@@ -314,8 +314,8 @@ public String proxyPassword() {
314314
return _proxyPassword;
315315
}
316316

317-
public ProxyRuntimeProvider proxyRuntimeProvider() {
318-
return _proxyRuntimeProvider;
317+
public ProxyCredentialsProvider proxyCredentialsProvider() {
318+
return _proxyCredentialsProvider;
319319
}
320320

321321
public ProxyMTLSAuth proxyMTLSAuth() {
@@ -463,7 +463,7 @@ public static final class Builder {
463463
private String _proxyScheme = HttpScheme.HTTP;
464464
private String _proxyUsername;
465465
private String _proxyPassword;
466-
private ProxyRuntimeProvider _proxyRuntimeProvider;
466+
private ProxyCredentialsProvider _proxyCredentialsProvider;
467467
private ProxyMTLSAuth _proxyMtlsAuth;
468468
private int _eventsQueueSize = 500;
469469
private long _eventSendIntervalInMillis = 30 * (long)1000;
@@ -813,11 +813,11 @@ public Builder proxyPassword(String proxyPassword) {
813813
/**
814814
* Set the token for authentication against the proxy (if proxy settings are enabled). (Optional).
815815
*
816-
* @param proxyRuntimeProvider
816+
* @param proxyCredentialsProvider
817817
* @return this builder
818818
*/
819-
public Builder proxyRuntimeProvider(ProxyRuntimeProvider proxyRuntimeProvider) {
820-
_proxyRuntimeProvider = proxyRuntimeProvider;
819+
public Builder proxyCredentialsProvider(ProxyCredentialsProvider proxyCredentialsProvider) {
820+
_proxyCredentialsProvider = proxyCredentialsProvider;
821821
return this;
822822
}
823823

@@ -1161,19 +1161,19 @@ private void verifyProxy() {
11611161
throw new IllegalArgumentException("Proxy scheme must be either http or https.");
11621162
}
11631163

1164-
if (_proxyUsername == null && _proxyRuntimeProvider == null && _proxyMtlsAuth == null) {
1164+
if (_proxyUsername == null && _proxyCredentialsProvider == null && _proxyMtlsAuth == null) {
11651165
return;
11661166
}
11671167

1168-
if (_proxyUsername != null && _proxyRuntimeProvider != null) {
1168+
if (_proxyUsername != null && _proxyCredentialsProvider != null) {
11691169
throw new IllegalArgumentException("Proxy user and Proxy token params are updated, set only one param.");
11701170
}
11711171

11721172
if (_proxyUsername != null && _proxyMtlsAuth != null) {
11731173
throw new IllegalArgumentException("Proxy user and Proxy mTLS params are updated, set only one param.");
11741174
}
11751175

1176-
if (_proxyRuntimeProvider != null && _proxyMtlsAuth != null) {
1176+
if (_proxyCredentialsProvider != null && _proxyMtlsAuth != null) {
11771177
throw new IllegalArgumentException("Proxy token and Proxy mTLS params are updated, set only one param.");
11781178
}
11791179

@@ -1223,7 +1223,7 @@ public SplitClientConfig build() {
12231223
proxy(),
12241224
_proxyUsername,
12251225
_proxyPassword,
1226-
_proxyRuntimeProvider,
1226+
_proxyCredentialsProvider,
12271227
_proxyMtlsAuth,
12281228
_eventsQueueSize,
12291229
_eventSendIntervalInMillis,

‎client/src/main/java/io/split/client/SplitFactoryImpl.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,9 +634,9 @@ private static HttpClientBuilder setupProxy(HttpClientBuilder httpClientbuilder,
634634
httpClientbuilder.setDefaultCredentialsProvider(credsProvider);
635635
}
636636

637-
if (config.proxyRuntimeProvider() != null) {
637+
if (config.proxyCredentialsProvider() != null) {
638638
_log.debug("Proxy setup using token");
639-
httpClientbuilder.setDefaultCredentialsProvider(new HttpClientDynamicCredentials(config.proxyRuntimeProvider()));
639+
httpClientbuilder.setDefaultCredentialsProvider(new HttpClientDynamicCredentials(config.proxyCredentialsProvider()));
640640
}
641641

642642
return httpClientbuilder;

‎client/src/test/java/io/split/client/SplitClientConfigTest.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ public void checkProxyParams() {
273273
Assert.assertEquals("user", config.proxyUsername());
274274
Assert.assertEquals("pass", config.proxyPassword());
275275

276-
ProxyRuntimeProvider proxyRuntimeProvider = new ProxyRuntimeProvider() {
276+
ProxyCredentialsProvider proxyCredentialsProvider = new ProxyCredentialsProvider() {
277277
@Override
278278
public String getJwtToken() {
279279
return "my-token";
@@ -283,9 +283,9 @@ public String getJwtToken() {
283283
config = SplitClientConfig.builder()
284284
.proxyHost("proxy-host")
285285
.proxyPort(8888)
286-
.proxyRuntimeProvider(proxyRuntimeProvider)
286+
.proxyCredentialsProvider(proxyCredentialsProvider)
287287
.build();
288-
Assert.assertEquals(proxyRuntimeProvider, config.proxyRuntimeProvider());
288+
Assert.assertEquals(proxyCredentialsProvider, config.proxyCredentialsProvider());
289289

290290
config = SplitClientConfig.builder()
291291
.proxyHost("proxy-host")
@@ -307,7 +307,7 @@ public void cannotUseInvalidHttpScheme() {
307307

308308
@Test(expected = IllegalArgumentException.class)
309309
public void cannotUseProxyTokenAndProxyUsername() {
310-
ProxyRuntimeProvider proxyRuntimeProvider = new ProxyRuntimeProvider() {
310+
ProxyCredentialsProvider proxyCredentialsProvider = new ProxyCredentialsProvider() {
311311
@Override
312312
public String getJwtToken() {
313313
return "my-token";
@@ -319,7 +319,7 @@ public String getJwtToken() {
319319
.proxyPort(8888)
320320
.proxyUsername("user")
321321
.proxyPassword("pass")
322-
.proxyRuntimeProvider(proxyRuntimeProvider)
322+
.proxyCredentialsProvider(proxyCredentialsProvider)
323323
.build();
324324
}
325325

@@ -336,7 +336,7 @@ public void cannotUseProxyUserAndProxyMtls() {
336336

337337
@Test(expected = IllegalArgumentException.class)
338338
public void cannotUseProxyTokenAndProxyMtls() {
339-
ProxyRuntimeProvider proxyRuntimeProvider = new ProxyRuntimeProvider() {
339+
ProxyCredentialsProvider proxyCredentialsProvider = new ProxyCredentialsProvider() {
340340
@Override
341341
public String getJwtToken() {
342342
return "my-token";
@@ -346,7 +346,7 @@ public String getJwtToken() {
346346
SplitClientConfig.builder()
347347
.proxyHost("proxy-host")
348348
.proxyPort(8888)
349-
.proxyRuntimeProvider(proxyRuntimeProvider)
349+
.proxyCredentialsProvider(proxyCredentialsProvider)
350350
.proxyMtlsAuth(new ProxyMTLSAuth.Builder().proxyP12File("path/to/file").proxyP12FilePassKey("pass-key").build())
351351
.build();
352352
}

‎client/src/test/java/io/split/client/SplitFactoryImplTest.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
import io.split.telemetry.synchronizer.TelemetrySynchronizer;
1212
import junit.framework.TestCase;
1313
import org.apache.hc.client5.http.auth.AuthScope;
14-
import org.apache.hc.client5.http.auth.BearerToken;
1514
import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
1615
import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
1716
import org.apache.hc.client5.http.impl.io.DefaultHttpClientConnectionOperator;
@@ -21,7 +20,6 @@
2120
import org.apache.hc.core5.http.config.Registry;
2221
import org.awaitility.Awaitility;
2322
import org.junit.Assert;
24-
import org.junit.Ignore;
2523
import org.junit.Test;
2624
import org.mockito.Mockito;
2725
import static org.mockito.Mockito.when;
@@ -154,7 +152,7 @@ public void testFactoryInstantiationWithProxyCredentials() throws Exception {
154152

155153
@Test
156154
public void testFactoryInstantiationWithProxyToken() throws Exception {
157-
class MyProxyRuntimeProvider implements ProxyRuntimeProvider {
155+
class MyProxyCredentialsProvider implements ProxyCredentialsProvider {
158156
@Override
159157
public String getJwtToken() {
160158
return "123456789";
@@ -170,7 +168,7 @@ public String getJwtToken() {
170168
.authServiceURL(AUTH_SERVICE)
171169
.setBlockUntilReadyTimeout(1000)
172170
.proxyPort(6060)
173-
.proxyRuntimeProvider(new MyProxyRuntimeProvider())
171+
.proxyCredentialsProvider(new MyProxyCredentialsProvider())
174172
.proxyHost(ENDPOINT)
175173
.build();
176174
SplitFactoryImpl splitFactory2 = new SplitFactoryImpl(API_KEY, splitClientConfig);
@@ -189,9 +187,9 @@ public String getJwtToken() {
189187
credentialsProviderField2.setAccessible(true);
190188
HttpClientDynamicCredentials credentialsProvider2 = (HttpClientDynamicCredentials) credentialsProviderField2.get(InternalHttp2.cast(httpClientField2.get(client2)));
191189

192-
Field proxyRuntimeField = HttpClientDynamicCredentials.class.getDeclaredField("_proxyRuntimeProvider");
190+
Field proxyRuntimeField = HttpClientDynamicCredentials.class.getDeclaredField("_proxyCredentialsProvider");
193191
proxyRuntimeField.setAccessible(true);
194-
MyProxyRuntimeProvider proxyRuntime = (MyProxyRuntimeProvider) proxyRuntimeField.get(credentialsProvider2);
192+
MyProxyCredentialsProvider proxyRuntime = (MyProxyCredentialsProvider) proxyRuntimeField.get(credentialsProvider2);
195193

196194
assertNotNull("123456789", proxyRuntime.getJwtToken());
197195

‎testing/.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @splitio/sdk

‎testing/.github/linter/checkstyle-suppressions.xml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0"?>
2+
3+
<!DOCTYPE suppressions PUBLIC
4+
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
5+
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
6+
7+
<suppressions>
8+
<suppress checks="LineLength" files=".*(test|it)[\\/]"/>
9+
</suppressions>

0 commit comments

Comments
 (0)