You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ja...@apache.org on 2024/01/21 01:13:19 UTC
(solr) branch branch_9x updated: SOLR-15960: Rename getProp as getProperty (#2194)
This is an automated email from the ASF dual-hosted git repository.
janhoy pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new 390f5ca3531 SOLR-15960: Rename getProp as getProperty (#2194)
390f5ca3531 is described below
commit 390f5ca35313c7f8636f871ed5b2624632919349
Author: Jan Høydahl <ja...@apache.org>
AuthorDate: Sun Jan 21 02:10:05 2024 +0100
SOLR-15960: Rename getProp as getProperty (#2194)
(cherry picked from commit 750a409ab2cf3cc2c9594f541d04a3a5bd8020ca)
---
.../org/apache/solr/api/ClusterPluginsSource.java | 2 +-
.../org/apache/solr/core/TracerConfigurator.java | 4 +-
.../src/java/org/apache/solr/pkg/PackageAPI.java | 2 +-
.../src/java/org/apache/solr/util/ModuleUtils.java | 2 +-
.../org/apache/solr/util/StartupLoggingUtils.java | 2 +-
.../circuitbreaker/CircuitBreakerRegistry.java | 2 +-
.../java/org/apache/solr/common/util/EnvUtils.java | 44 +++++++++---------
.../apache/solr/common/util/PropertiesUtil.java | 2 +-
.../org/apache/solr/common/util/EnvUtilsTest.java | 53 +++++++++++-----------
.../src/java/org/apache/solr/SolrTestCase.java | 2 +-
10 files changed, 58 insertions(+), 57 deletions(-)
diff --git a/solr/core/src/java/org/apache/solr/api/ClusterPluginsSource.java b/solr/core/src/java/org/apache/solr/api/ClusterPluginsSource.java
index cb3e7af4dc9..0506bece569 100644
--- a/solr/core/src/java/org/apache/solr/api/ClusterPluginsSource.java
+++ b/solr/core/src/java/org/apache/solr/api/ClusterPluginsSource.java
@@ -35,7 +35,7 @@ public interface ClusterPluginsSource {
* @return The name of the class to use as the {@link ClusterPluginsSource}
*/
public static String resolveClassName() {
- return EnvUtils.getPropAsBool(ContainerPluginsRegistry.CLUSTER_PLUGIN_EDIT_ENABLED, true)
+ return EnvUtils.getPropertyAsBool(ContainerPluginsRegistry.CLUSTER_PLUGIN_EDIT_ENABLED, true)
? ZkClusterPluginsSource.class.getName()
: NodeConfigClusterPluginsSource.class.getName();
}
diff --git a/solr/core/src/java/org/apache/solr/core/TracerConfigurator.java b/solr/core/src/java/org/apache/solr/core/TracerConfigurator.java
index bf3acd5281e..c92300c5f8b 100644
--- a/solr/core/src/java/org/apache/solr/core/TracerConfigurator.java
+++ b/solr/core/src/java/org/apache/solr/core/TracerConfigurator.java
@@ -39,10 +39,10 @@ public abstract class TracerConfigurator implements NamedListInitializedPlugin {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
public static final boolean TRACE_ID_GEN_ENABLED =
- Boolean.parseBoolean(EnvUtils.getProp("solr.alwaysOnTraceId", "true"));
+ Boolean.parseBoolean(EnvUtils.getProperty("solr.alwaysOnTraceId", "true"));
private static final String DEFAULT_CLASS_NAME =
- EnvUtils.getProp(
+ EnvUtils.getProperty(
"solr.otelDefaultConfigurator", "org.apache.solr.opentelemetry.OtelTracerConfigurator");
public abstract Tracer getTracer();
diff --git a/solr/core/src/java/org/apache/solr/pkg/PackageAPI.java b/solr/core/src/java/org/apache/solr/pkg/PackageAPI.java
index 647309e42c9..6e264421684 100644
--- a/solr/core/src/java/org/apache/solr/pkg/PackageAPI.java
+++ b/solr/core/src/java/org/apache/solr/pkg/PackageAPI.java
@@ -58,7 +58,7 @@ import org.slf4j.LoggerFactory;
/** This implements the public end points (/api/cluster/package) of package API. */
public class PackageAPI {
- public final boolean enablePackages = EnvUtils.getPropAsBool("enable.packages", false);
+ public final boolean enablePackages = EnvUtils.getPropertyAsBool("enable.packages", false);
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
public static final String ERR_MSG =
diff --git a/solr/core/src/java/org/apache/solr/util/ModuleUtils.java b/solr/core/src/java/org/apache/solr/util/ModuleUtils.java
index 51826681234..4ff0836b562 100644
--- a/solr/core/src/java/org/apache/solr/util/ModuleUtils.java
+++ b/solr/core/src/java/org/apache/solr/util/ModuleUtils.java
@@ -56,7 +56,7 @@ public class ModuleUtils {
* @return set of raw volume names from sysprop and/or env.var
*/
static Set<String> resolveFromSyspropOrEnv() {
- return Set.copyOf(EnvUtils.getPropAsList("solr.modules", Collections.emptyList()));
+ return Set.copyOf(EnvUtils.getPropertyAsList("solr.modules", Collections.emptyList()));
}
/** Returns true if a module name is valid and exists in the system */
diff --git a/solr/core/src/java/org/apache/solr/util/StartupLoggingUtils.java b/solr/core/src/java/org/apache/solr/util/StartupLoggingUtils.java
index 4ef8110db36..aeda7757593 100644
--- a/solr/core/src/java/org/apache/solr/util/StartupLoggingUtils.java
+++ b/solr/core/src/java/org/apache/solr/util/StartupLoggingUtils.java
@@ -45,7 +45,7 @@ public final class StartupLoggingUtils {
/** Checks whether mandatory log dir is given */
public static void checkLogDir() {
- if (EnvUtils.getProp("solr.log.dir") == null) {
+ if (EnvUtils.getProperty("solr.log.dir") == null) {
log.error("Missing Java Option solr.log.dir. Logging may be missing or incomplete.");
}
}
diff --git a/solr/core/src/java/org/apache/solr/util/circuitbreaker/CircuitBreakerRegistry.java b/solr/core/src/java/org/apache/solr/util/circuitbreaker/CircuitBreakerRegistry.java
index 1168d31e92d..1b7b2def483 100644
--- a/solr/core/src/java/org/apache/solr/util/circuitbreaker/CircuitBreakerRegistry.java
+++ b/solr/core/src/java/org/apache/solr/util/circuitbreaker/CircuitBreakerRegistry.java
@@ -69,7 +69,7 @@ public class CircuitBreakerRegistry implements Closeable {
private static void initGlobal(CoreContainer coreContainer) {
// Read system properties to register global circuit breakers for update and query:
// Example: solr.circuitbreaker.update.cpu = 50
- EnvUtils.getProps().keySet().stream()
+ EnvUtils.getProperties().keySet().stream()
.map(SYSPROP_REGEX::matcher)
.filter(Matcher::matches)
.collect(Collectors.groupingBy(m -> m.group(2) + ":" + System.getProperty(m.group(0))))
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/EnvUtils.java b/solr/solrj/src/java/org/apache/solr/common/util/EnvUtils.java
index 48f44754c48..29c9586ca96 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/EnvUtils.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/EnvUtils.java
@@ -129,7 +129,7 @@ public class EnvUtils {
}
/** Get all Solr system properties as a sorted map */
- public static SortedMap<String, String> getProps() {
+ public static SortedMap<String, String> getProperties() {
return System.getProperties().entrySet().stream()
.collect(
Collectors.toMap(
@@ -140,18 +140,18 @@ public class EnvUtils {
}
/** Get a property as string */
- public static String getProp(String key) {
- return getProp(key, null);
+ public static String getProperty(String key) {
+ return getProperty(key, null);
}
/**
- * Get a property as string with a fallback value. All other getProp* methods use this.
+ * Get a property as string with a fallback value. All other getProperty* methods use this.
*
* @param key property key, which treats 'camelCase' the same as 'camel.case'
* @param defaultValue fallback value if property is not found
*/
- public static String getProp(String key, String defaultValue) {
- String value = getPropWithCamelCaseFallback(key);
+ public static String getProperty(String key, String defaultValue) {
+ String value = getPropertyWithCamelCaseFallback(key);
return value != null ? value : defaultValue;
}
@@ -160,7 +160,7 @@ public class EnvUtils {
*
* @return property value or value of dot-separated alias key or null if not found
*/
- private static String getPropWithCamelCaseFallback(String key) {
+ private static String getPropertyWithCamelCaseFallback(String key) {
String value = System.getProperty(key);
if (value != null) {
return value;
@@ -178,13 +178,13 @@ public class EnvUtils {
}
/** Get property as integer */
- public static Long getPropAsLong(String key) {
- return getPropAsLong(key, null);
+ public static Long getPropertyAsLong(String key) {
+ return getPropertyAsLong(key, null);
}
/** Get property as long, or default value */
- public static Long getPropAsLong(String key, Long defaultValue) {
- String value = getProp(key);
+ public static Long getPropertyAsLong(String key, Long defaultValue) {
+ String value = getProperty(key);
if (value == null) {
return defaultValue;
}
@@ -192,13 +192,13 @@ public class EnvUtils {
}
/** Get property as boolean */
- public static Boolean getPropAsBool(String key) {
- return getPropAsBool(key, null);
+ public static Boolean getPropertyAsBool(String key) {
+ return getPropertyAsBool(key, null);
}
/** Get property as boolean, or default value */
- public static Boolean getPropAsBool(String key, Boolean defaultValue) {
- String value = getProp(key);
+ public static Boolean getPropertyAsBool(String key, Boolean defaultValue) {
+ String value = getProperty(key);
if (value == null) {
return defaultValue;
}
@@ -210,8 +210,8 @@ public class EnvUtils {
*
* @return list of strings, or null if not found
*/
- public static List<String> getPropAsList(String key) {
- return getPropAsList(key, null);
+ public static List<String> getPropertyAsList(String key) {
+ return getPropertyAsList(key, null);
}
/**
@@ -219,12 +219,12 @@ public class EnvUtils {
*
* @return list of strings, or provided default if not found
*/
- public static List<String> getPropAsList(String key, List<String> defaultValue) {
- return getProp(key) != null ? stringValueToList(getProp(key)) : defaultValue;
+ public static List<String> getPropertyAsList(String key, List<String> defaultValue) {
+ return getProperty(key) != null ? stringValueToList(getProperty(key)) : defaultValue;
}
/** Set a system property. Shim to {@link System#setProperty(String, String)} */
- public static void setProp(String key, String value) {
+ public static void setProperty(String key, String value) {
System.setProperty(key, value);
System.setProperty(camelCaseToDotSeparated(key), value);
}
@@ -240,8 +240,8 @@ public class EnvUtils {
if (key.startsWith("SOLR_") || CUSTOM_MAPPINGS.containsKey(key)) {
String sysPropKey = envNameToSyspropName(key);
// Existing system properties take precedence
- if (!sysPropKey.isBlank() && (overwrite || getProp(sysPropKey, null) == null)) {
- setProp(sysPropKey, ENV.get(key));
+ if (!sysPropKey.isBlank() && (overwrite || getProperty(sysPropKey, null) == null)) {
+ setProperty(sysPropKey, ENV.get(key));
}
}
}
diff --git a/solr/solrj/src/java/org/apache/solr/common/util/PropertiesUtil.java b/solr/solrj/src/java/org/apache/solr/common/util/PropertiesUtil.java
index abc5ee98fa9..3e00414408d 100644
--- a/solr/solrj/src/java/org/apache/solr/common/util/PropertiesUtil.java
+++ b/solr/solrj/src/java/org/apache/solr/common/util/PropertiesUtil.java
@@ -65,7 +65,7 @@ public class PropertiesUtil {
fragment = coreProperties.apply(propertyName);
}
if (fragment == null) {
- fragment = EnvUtils.getProp(propertyName, defaultValue);
+ fragment = EnvUtils.getProperty(propertyName, defaultValue);
}
if (fragment == null) {
throw new SolrException(
diff --git a/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java b/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java
index 1bbcc3cc4a3..b6af3f56d40 100644
--- a/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java
+++ b/solr/solrj/src/test/org/apache/solr/common/util/EnvUtilsTest.java
@@ -65,55 +65,56 @@ public class EnvUtilsTest extends SolrTestCase {
@Test
public void testGetProp() {
- assertEquals("INFO", EnvUtils.getProp("solr.log.level"));
+ assertEquals("INFO", EnvUtils.getProperty("solr.log.level"));
- assertNull(EnvUtils.getProp("solr.nonexist"));
- assertEquals("myString", EnvUtils.getProp("solr.nonexist", "myString"));
+ assertNull(EnvUtils.getProperty("solr.nonexist"));
+ assertEquals("myString", EnvUtils.getProperty("solr.nonexist", "myString"));
- assertTrue(EnvUtils.getPropAsBool("solr.boolean"));
- assertFalse(EnvUtils.getPropAsBool("solr.boolean.nonexist", false));
+ assertTrue(EnvUtils.getPropertyAsBool("solr.boolean"));
+ assertFalse(EnvUtils.getPropertyAsBool("solr.boolean.nonexist", false));
- assertEquals("1234567890", EnvUtils.getProp("solr.long"));
- assertEquals(Long.valueOf(1234567890L), EnvUtils.getPropAsLong("solr.long"));
- assertEquals(Long.valueOf(987L), EnvUtils.getPropAsLong("solr.long.nonexist", 987L));
+ assertEquals("1234567890", EnvUtils.getProperty("solr.long"));
+ assertEquals(Long.valueOf(1234567890L), EnvUtils.getPropertyAsLong("solr.long"));
+ assertEquals(Long.valueOf(987L), EnvUtils.getPropertyAsLong("solr.long.nonexist", 987L));
- assertEquals("one,two, three", EnvUtils.getProp("solr.commasep"));
- assertEquals(List.of("one", "two", "three"), EnvUtils.getPropAsList("solr.commasep"));
- assertEquals(List.of("one", "two", "three"), EnvUtils.getPropAsList("solr.json.list"));
- assertEquals(List.of("fallback"), EnvUtils.getPropAsList("SOLR_MISSING", List.of("fallback")));
+ assertEquals("one,two, three", EnvUtils.getProperty("solr.commasep"));
+ assertEquals(List.of("one", "two", "three"), EnvUtils.getPropertyAsList("solr.commasep"));
+ assertEquals(List.of("one", "two", "three"), EnvUtils.getPropertyAsList("solr.json.list"));
+ assertEquals(
+ List.of("fallback"), EnvUtils.getPropertyAsList("SOLR_MISSING", List.of("fallback")));
}
@Test
public void getPropWithCamelCase() {
- assertEquals("INFO", EnvUtils.getProp("solr.logLevel"));
- assertEquals("INFO", EnvUtils.getProp("solr.LogLevel"));
- assertEquals(Long.valueOf(1234567890L), EnvUtils.getPropAsLong("solrLong"));
- assertEquals(Boolean.TRUE, EnvUtils.getPropAsBool("solr.alwaysOnTraceId"));
- assertEquals(Boolean.TRUE, EnvUtils.getPropAsBool("solr.always.on.trace.id"));
+ assertEquals("INFO", EnvUtils.getProperty("solr.logLevel"));
+ assertEquals("INFO", EnvUtils.getProperty("solr.LogLevel"));
+ assertEquals(Long.valueOf(1234567890L), EnvUtils.getPropertyAsLong("solrLong"));
+ assertEquals(Boolean.TRUE, EnvUtils.getPropertyAsBool("solr.alwaysOnTraceId"));
+ assertEquals(Boolean.TRUE, EnvUtils.getPropertyAsBool("solr.always.on.trace.id"));
}
@Test
public void testEnvsWithCustomKeyNameMappings() {
// These have different names than the environment variables
- assertEquals(EnvUtils.getEnv("SOLR_HOME"), EnvUtils.getProp("solr.solr.home"));
- assertEquals(EnvUtils.getEnv("SOLR_PORT"), EnvUtils.getProp("jetty.port"));
- assertEquals(EnvUtils.getEnv("SOLR_HOST"), EnvUtils.getProp("host"));
- assertEquals(EnvUtils.getEnv("SOLR_LOGS_DIR"), EnvUtils.getProp("solr.log.dir"));
+ assertEquals(EnvUtils.getEnv("SOLR_HOME"), EnvUtils.getProperty("solr.solr.home"));
+ assertEquals(EnvUtils.getEnv("SOLR_PORT"), EnvUtils.getProperty("jetty.port"));
+ assertEquals(EnvUtils.getEnv("SOLR_HOST"), EnvUtils.getProperty("host"));
+ assertEquals(EnvUtils.getEnv("SOLR_LOGS_DIR"), EnvUtils.getProperty("solr.log.dir"));
}
@Test
public void testNotMapped() {
- assertFalse(EnvUtils.getProps().containsKey("solr.ssl.key.store.password"));
- assertFalse(EnvUtils.getProps().containsKey("gc.log.opts"));
+ assertFalse(EnvUtils.getProperties().containsKey("solr.ssl.key.store.password"));
+ assertFalse(EnvUtils.getProperties().containsKey("gc.log.opts"));
}
@Test
public void testOverwrite() {
- EnvUtils.setProp("solr.overwrite", "original");
+ EnvUtils.setProperty("solr.overwrite", "original");
EnvUtils.setEnv("SOLR_OVERWRITE", "overwritten");
EnvUtils.init(false);
- assertEquals("original", EnvUtils.getProp("solr.overwrite"));
+ assertEquals("original", EnvUtils.getProperty("solr.overwrite"));
EnvUtils.init(true);
- assertEquals("overwritten", EnvUtils.getProp("solr.overwrite"));
+ assertEquals("overwritten", EnvUtils.getProperty("solr.overwrite"));
}
}
diff --git a/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java b/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
index fbacb652eea..4b0bb66ae9d 100644
--- a/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
+++ b/solr/test-framework/src/java/org/apache/solr/SolrTestCase.java
@@ -122,7 +122,7 @@ public class SolrTestCase extends LuceneTestCase {
@BeforeClass
public static void beforeSolrTestCase() {
final String existingValue =
- EnvUtils.getProp(SolrDispatchFilter.SOLR_DEFAULT_CONFDIR_ATTRIBUTE);
+ EnvUtils.getProperty(SolrDispatchFilter.SOLR_DEFAULT_CONFDIR_ATTRIBUTE);
if (null != existingValue) {
log.info(
"Test env includes configset dir system property '{}'='{}'",