Skip to content

Commit cd6810f

Browse files
hasnain-dbhasnain-db
committed
follow style guide for flag
1 parent f0f058b commit cd6810f

File tree

8 files changed

+31
-31
lines changed

8 files changed

+31
-31
lines changed

‎common/network-common/src/main/java/org/apache/spark/network/TransportContext.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ private SSLFactory createSslFactory() {
270270
conf.sslRpcTrustStore(),
271271
conf.sslRpcTrustStorePassword(),
272272
conf.sslRpcTrustStoreReloadingEnabled(),
273-
conf.sslRpcTrustStoreReloadInterval())
273+
conf.sslRpctrustStoreReloadIntervalMs())
274274
.build();
275275
} else {
276276
if (conf.sslRpcDangerouslyFallbackIfKeysNotPresent()) {

‎common/network-common/src/main/java/org/apache/spark/network/ssl/SSLFactory.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ private void initJdkSslContext(final Builder b)
9191
this.keyManagers = keyManagers(b.keyStore, b.keyStorePassword);
9292
this.trustManagers = trustStoreManagers(
9393
b.trustStore, b.trustStorePassword,
94-
b.trustStoreReloadingEnabled, b.trustStoreReloadInterval
94+
b.trustStoreReloadingEnabled, b.trustStoreReloadIntervalMs
9595
);
9696
this.jdkSslContext = createSSLContext(requestedProtocol, keyManagers, trustManagers);
9797
}
@@ -162,7 +162,7 @@ public static class Builder {
162162
private File trustStore;
163163
private String trustStorePassword;
164164
private boolean trustStoreReloadingEnabled;
165-
private int trustStoreReloadInterval;
165+
private int trustStoreReloadIntervalMs;
166166
private boolean openSslEnabled;
167167

168168
/**
@@ -249,16 +249,16 @@ public Builder openSslEnabled(boolean enabled) {
249249
* @param trustStore
250250
* @param trustStorePassword
251251
* @param trustStoreReloadingEnabled
252-
* @param trustStoreReloadInterval
252+
* @param trustStoreReloadIntervalMs
253253
* @return
254254
*/
255255
public Builder trustStore(
256256
File trustStore, String trustStorePassword,
257-
boolean trustStoreReloadingEnabled, int trustStoreReloadInterval) {
257+
boolean trustStoreReloadingEnabled, int trustStoreReloadIntervalMs) {
258258
this.trustStore = trustStore;
259259
this.trustStorePassword = trustStorePassword;
260260
this.trustStoreReloadingEnabled = trustStoreReloadingEnabled;
261-
this.trustStoreReloadInterval = trustStoreReloadInterval;
261+
this.trustStoreReloadIntervalMs = trustStoreReloadIntervalMs;
262262
return this;
263263
}
264264

@@ -369,7 +369,7 @@ public X509Certificate[] getAcceptedIssuers() {
369369

370370
private static TrustManager[] trustStoreManagers(
371371
File trustStore, String trustStorePassword,
372-
boolean trustStoreReloadingEnabled, int trustStoreReloadInterval)
372+
boolean trustStoreReloadingEnabled, int trustStoreReloadIntervalMs)
373373
throws IOException, GeneralSecurityException {
374374
if (trustStore == null || !trustStore.exists()) {
375375
return credulousTrustStoreManagers();
@@ -380,7 +380,7 @@ private static TrustManager[] trustStoreManagers(
380380

381381
if (trustStoreReloadingEnabled) {
382382
ReloadingX509TrustManager reloading = new ReloadingX509TrustManager(
383-
KeyStore.getDefaultType(), trustStore, trustStorePassword, trustStoreReloadInterval);
383+
KeyStore.getDefaultType(), trustStore, trustStorePassword, trustStoreReloadIntervalMs);
384384
reloading.init();
385385
return new TrustManager[]{reloading};
386386
} else {

‎common/network-common/src/main/java/org/apache/spark/network/util/TransportConf.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,8 @@ public boolean sslRpcTrustStoreReloadingEnabled() {
361361
/**
362362
* The interval, in milliseconds, the trust-store will reload its configuration
363363
*/
364-
public int sslRpcTrustStoreReloadInterval() {
365-
return conf.getInt("spark.ssl.rpc.trustStoreReloadInterval", 10000);
364+
public int sslRpctrustStoreReloadIntervalMs() {
365+
return conf.getInt("spark.ssl.rpc.trustStoreReloadIntervalMs", 10000);
366366
}
367367

368368
/**

‎common/network-common/src/test/java/TransportConfSuite.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public void testSslTrustStorePassword() {
8585
}
8686

8787
@Test
88-
public void testSslTrustStoreReloadInterval() {
89-
assertEquals(10000, transportConf.sslRpcTrustStoreReloadInterval());
88+
public void testSsltrustStoreReloadIntervalMs() {
89+
assertEquals(10000, transportConf.sslRpctrustStoreReloadIntervalMs());
9090
}
9191
}

‎common/network-common/src/test/java/org/apache/spark/network/ssl/SslSampleConfigs.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public static Map<String, String> createDefaultConfigMap() {
6565
confMap.put("spark.ssl.enabled", "true");
6666
confMap.put("spark.ssl.trustStoreReloadingEnabled", "false");
6767
confMap.put("spark.ssl.openSslEnabled", "false");
68-
confMap.put("spark.ssl.trustStoreReloadInterval", "10000");
68+
confMap.put("spark.ssl.trustStoreReloadIntervalMs", "10000");
6969
confMap.put("spark.ssl.keyStore", SslSampleConfigs.keyStorePath);
7070
confMap.put("spark.ssl.keyStorePassword", "password");
7171
confMap.put("spark.ssl.privateKey", SslSampleConfigs.privateKeyPath);
@@ -86,7 +86,7 @@ public static Map<String, String> createDefaultConfigMapForRpcNamespace() {
8686
confMap.put("spark.ssl.rpc.enabled", "true");
8787
confMap.put("spark.ssl.rpc.trustStoreReloadingEnabled", "false");
8888
confMap.put("spark.ssl.rpc.openSslEnabled", "false");
89-
confMap.put("spark.ssl.rpc.trustStoreReloadInterval", "10000");
89+
confMap.put("spark.ssl.rpc.trustStoreReloadIntervalMs", "10000");
9090
confMap.put("spark.ssl.rpc.keyStore", SslSampleConfigs.keyStorePath);
9191
confMap.put("spark.ssl.rpc.keyStorePassword", "password");
9292
confMap.put("spark.ssl.rpc.privateKey", SslSampleConfigs.privateKeyPath);

‎core/src/main/scala/org/apache/spark/SSLOptions.scala‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ import org.apache.spark.network.util.MapConfigProvider
5454
* @param trustStoreType the type of the trust-store
5555
* @param trustStoreReloadingEnabled enables or disables using a trust-store that reloads
5656
* its configuration when the trust-store file on disk changes
57-
* @param trustStoreReloadInterval the interval, in milliseconds,
57+
* @param trustStoreReloadIntervalMs the interval, in milliseconds,
5858
* when the trust-store will reload its configuration
5959
* @param openSslEnabled enables or disables using an OpenSSL implementation
6060
* (if available on host system), requires certChain and keyFile arguments
@@ -79,7 +79,7 @@ private[spark] case class SSLOptions(
7979
trustStorePassword: Option[String] = None,
8080
trustStoreType: Option[String] = None,
8181
trustStoreReloadingEnabled: Boolean = false,
82-
trustStoreReloadInterval: Int = 10000,
82+
trustStoreReloadIntervalMs: Int = 10000,
8383
openSslEnabled: Boolean = false,
8484
protocol: Option[String] = None,
8585
enabledAlgorithms: Set[String] = Set.empty,
@@ -168,7 +168,7 @@ private[spark] case class SSLOptions(
168168
confMap.put(s"$nsp.enabled", enabled.toString)
169169
confMap.put(s"$nsp.trustStoreReloadingEnabled", trustStoreReloadingEnabled.toString)
170170
confMap.put(s"$nsp.openSslEnabled", openSslEnabled.toString)
171-
confMap.put(s"$nsp.trustStoreReloadInterval", trustStoreReloadInterval.toString)
171+
confMap.put(s"$nsp.trustStoreReloadIntervalMs", trustStoreReloadIntervalMs.toString)
172172
keyStore.map(_.getAbsolutePath).foreach(confMap.put(s"$nsp.keyStore", _))
173173
keyStorePassword.foreach(confMap.put(s"$nsp.keyStorePassword", _))
174174
privateKey.map(_.getAbsolutePath).foreach(confMap.put(s"$nsp.privateKey", _))
@@ -191,7 +191,7 @@ private[spark] case class SSLOptions(
191191
s"keyStoreType=$keyStoreType, needClientAuth=$needClientAuth, " +
192192
s"certChain=$certChain, trustStore=$trustStore, " +
193193
s"trustStorePassword=${trustStorePassword.map(_ => "xxx")}, " +
194-
s"trustStoreReloadInterval=$trustStoreReloadInterval, " +
194+
s"trustStoreReloadIntervalMs=$trustStoreReloadIntervalMs, " +
195195
s"trustStoreReloadingEnabled=$trustStoreReloadingEnabled, openSSLEnabled=$openSslEnabled, " +
196196
s"protocol=$protocol, enabledAlgorithms=$enabledAlgorithms}, " +
197197
s"dangerouslyFallbackIfKeysNotPresent=$dangerouslyFallbackIfKeysNotPresent"
@@ -218,7 +218,7 @@ private[spark] object SSLOptions extends Logging {
218218
* $ - `[ns].trustStoreType` - the type of trust-store
219219
* $ - `[ns].trustStoreReloadingEnabled` - enables or disables using a trust-store
220220
* that reloads its configuration when the trust-store file on disk changes
221-
* $ - `[ns].trustStoreReloadInterval` - the interval, in milliseconds, the
221+
* $ - `[ns].trustStoreReloadIntervalMs` - the interval, in milliseconds, the
222222
* trust-store will reload its configuration
223223
* $ - `[ns].openSslEnabled` - enables or disables using an OpenSSL implementation
224224
* (if available on host system), requires certChain and keyFile arguments
@@ -301,8 +301,8 @@ private[spark] object SSLOptions extends Logging {
301301
val trustStoreReloadingEnabled = conf.getBoolean(s"$ns.trustStoreReloadingEnabled",
302302
defaultValue = defaults.exists(_.trustStoreReloadingEnabled))
303303

304-
val trustStoreReloadInterval = conf.getInt(s"$ns.trustStoreReloadInterval",
305-
defaultValue = defaults.map(_.trustStoreReloadInterval).getOrElse(10000))
304+
val trustStoreReloadIntervalMs = conf.getInt(s"$ns.trustStoreReloadIntervalMs",
305+
defaultValue = defaults.map(_.trustStoreReloadIntervalMs).getOrElse(10000))
306306

307307
val openSslEnabled = conf.getBoolean(s"$ns.openSslEnabled",
308308
defaultValue = defaults.exists(_.openSslEnabled))
@@ -334,7 +334,7 @@ private[spark] object SSLOptions extends Logging {
334334
trustStorePassword,
335335
trustStoreType,
336336
trustStoreReloadingEnabled,
337-
trustStoreReloadInterval,
337+
trustStoreReloadIntervalMs,
338338
openSslEnabled,
339339
protocol,
340340
enabledAlgorithms,

‎core/src/test/scala/org/apache/spark/SSLOptionsSuite.scala‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class SSLOptionsSuite extends SparkFunSuite {
5454
conf.set("spark.ssl.trustStore", trustStorePath)
5555
conf.set("spark.ssl.trustStorePassword", "password")
5656
conf.set("spark.ssl.trustStoreReloadingEnabled", "false")
57-
conf.set("spark.ssl.trustStoreReloadInterval", "10000")
57+
conf.set("spark.ssl.trustStoreReloadIntervalMs", "10000")
5858
conf.set("spark.ssl.openSslEnabled", "false")
5959
conf.set("spark.ssl.enabledAlgorithms", algorithms.mkString(","))
6060
conf.set("spark.ssl.protocol", "TLSv1.2")
@@ -70,7 +70,7 @@ class SSLOptionsSuite extends SparkFunSuite {
7070
assert(opts.keyStore.get.getAbsolutePath === keyStorePath)
7171
assert(opts.trustStorePassword === Some("password"))
7272
assert(opts.trustStoreReloadingEnabled === false)
73-
assert(opts.trustStoreReloadInterval === 10000)
73+
assert(opts.trustStoreReloadIntervalMs === 10000)
7474
assert(opts.privateKey.isDefined === true)
7575
assert(opts.privateKey.get.getName === "key.pem")
7676
assert(opts.privateKey.get.getAbsolutePath === privateKeyPath)
@@ -101,7 +101,7 @@ class SSLOptionsSuite extends SparkFunSuite {
101101
conf.set("spark.ssl.trustStore", trustStorePath)
102102
conf.set("spark.ssl.trustStorePassword", "password")
103103
conf.set("spark.ssl.trustStoreReloadingEnabled", "false")
104-
conf.set("spark.ssl.trustStoreReloadInterval", "10000")
104+
conf.set("spark.ssl.trustStoreReloadIntervalMs", "10000")
105105
conf.set("spark.ssl.openSslEnabled", "false")
106106
conf.set("spark.ssl.enabledAlgorithms",
107107
"TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA")
@@ -128,7 +128,7 @@ class SSLOptionsSuite extends SparkFunSuite {
128128
assert(opts.keyPassword === Some("password"))
129129
assert(opts.trustStorePassword === Some("password"))
130130
assert(opts.trustStoreReloadingEnabled === false)
131-
assert(opts.trustStoreReloadInterval === 10000)
131+
assert(opts.trustStoreReloadIntervalMs === 10000)
132132
assert(opts.openSslEnabled === false)
133133
assert(opts.protocol === Some("SSLv3"))
134134
assert(opts.enabledAlgorithms ===
@@ -155,7 +155,7 @@ class SSLOptionsSuite extends SparkFunSuite {
155155
conf.set("spark.ssl.trustStore", trustStorePath)
156156
conf.set("spark.ssl.trustStorePassword", "password")
157157
conf.set("spark.ssl.ui.trustStoreReloadingEnabled", "true")
158-
conf.set("spark.ssl.ui.trustStoreReloadInterval", "20000")
158+
conf.set("spark.ssl.ui.trustStoreReloadIntervalMs", "20000")
159159
conf.set("spark.ssl.ui.openSslEnabled", "true")
160160
conf.set("spark.ssl.enabledAlgorithms",
161161
"TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA")
@@ -183,7 +183,7 @@ class SSLOptionsSuite extends SparkFunSuite {
183183
assert(opts.keyStorePassword === Some("12345"))
184184
assert(opts.keyPassword === Some("password"))
185185
assert(opts.trustStoreReloadingEnabled === true)
186-
assert(opts.trustStoreReloadInterval === 20000)
186+
assert(opts.trustStoreReloadIntervalMs === 20000)
187187
assert(opts.openSslEnabled === true)
188188
assert(opts.protocol === Some("SSLv3"))
189189
assert(opts.enabledAlgorithms === Set("ABC", "DEF"))
@@ -208,7 +208,7 @@ class SSLOptionsSuite extends SparkFunSuite {
208208
conf.set("spark.ssl.trustStore", trustStorePath)
209209
conf.set("spark.ssl.trustStorePassword", "password")
210210
conf.set("spark.ssl.rpc.trustStoreReloadingEnabled", "true")
211-
conf.set("spark.ssl.rpc.trustStoreReloadInterval", "20000")
211+
conf.set("spark.ssl.rpc.trustStoreReloadIntervalMs", "20000")
212212
conf.set("spark.ssl.rpc.openSslEnabled", "true")
213213
conf.set("spark.ssl.enabledAlgorithms",
214214
"TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA")
@@ -245,7 +245,7 @@ class SSLOptionsSuite extends SparkFunSuite {
245245
assert(opts.keyStorePassword === Some("12345"))
246246
assert(opts.keyPassword === Some("password"))
247247
assert(opts.trustStoreReloadingEnabled === true)
248-
assert(opts.trustStoreReloadInterval === 20000)
248+
assert(opts.trustStoreReloadIntervalMs === 20000)
249249
assert(opts.openSslEnabled === true)
250250
assert(opts.protocol === Some("SSLv3"))
251251
assert(opts.enabledAlgorithms === Set("ABC", "DEF"))

‎docs/security.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -629,7 +629,7 @@ replaced with one of the above namespaces.
629629
</td>
630630
</tr>
631631
<tr>
632-
<td><code>${ns}.trustStoreReloadInterval</code></td>
632+
<td><code>${ns}.trustStoreReloadIntervalMs</code></td>
633633
<td>None</td>
634634
<td>
635635
The interval at which the trust store should be reloaded (in milliseconds).

0 commit comments

Comments
 (0)