Merge pull request #25732 from OndroMih/ondromih-fix-prefer-env-vars

Fixes in env vars references

Author: dmatej

docs/administration-guide/src/main/asciidoc/overview.adoc

@@ -313,8 +313,8 @@ If a variable reference is not resolved, the reference will not be replaced. So,
 
 **System properties that adjust variable resolution:**
 
-* `org.glassfish.variableexpansion.envvars.disabled` -  disables resolution from environment variables and allows only resolving from system properties. This allows keeping the behavior of older versions of {productName}
-* `org.glassfish.variableexpansion.envvars.preferred` - changes the priority - values are resolved first from environment variables and then from system properties
+* `org.glassfish.variableExpansion.envDisabled` -  disables resolution from environment variables and allows only resolving from system properties. This allows keeping the behavior of older versions of {productName}
+* `org.glassfish.variableExpansion.envPreferred` - changes the priority - values are resolved first from environment variables and then from system properties
 
 The following is a list of variables defined by {productName} that can be used in variable references:
 

docs/reference-manual/src/main/asciidoc/create-jvm-options.adoc

@@ -70,7 +70,7 @@ Variable references, e.g. `${variable}`, can be used anywhere in JVM options. In
 5. `asenv` properties
 6. Environment variables
 
-If a property `org.glassfish.envPreferredToProperties` is defined as `true` (in any source except environment variables), then environment variables take precedence over other sources, instead of being the last resolved source. It's also possible to override options and system properties defined in JVM options with an environment variable that either has the same name, or same name if case is ignored and non-alphanumeric characters are replaced with the `_` character. For example, a property `-Dmy.name` can be defined by redefined by environment variables `my.name`, `my_name`, or `MY_NAME`.
+If a property `org.glassfish.variableExpansion.envPreferred` is defined as `true` (in any source except environment variables), then environment variables take precedence over other sources, instead of being the last resolved source. It's also possible to override options and system properties defined in JVM options with an environment variable that either has the same name, or same name if case is ignored and non-alphanumeric characters are replaced with the `_` character. For example, a property `-Dmy.name` can be defined by redefined by environment variables `my.name`, `my_name`, or `MY_NAME`. If a property `org.glassfish.variableExpansion.envDisabled` is defined as `true`, then environment variables are ignored.
 
 [CAUTION]
 ====

nucleus/admin/config-api/src/main/java/org/glassfish/config/support/TranslatedConfigView.java

@@ -17,6 +17,7 @@
 package org.glassfish.config.support;
 
 import com.sun.enterprise.security.store.DomainScopedPasswordAliasStore;
+import com.sun.enterprise.util.SystemPropertyConstants;
 
 import java.io.IOException;
 import java.lang.reflect.Method;
@@ -47,8 +48,6 @@ public class TranslatedConfigView implements ConfigView {
 
     private static final String ALIAS_TOKEN = "ALIAS";
     private static final int MAX_SUBSTITUTION_DEPTH = 100;
-    private static final String DISABLE_ENV_VAR_EXPANSION_PROPERTY = "org.glassfish.variableexpansion.envvars.disabled";
-    private static final String ENV_VAR_EXPANSION_PREFERRED_PROPERTY = "org.glassfish.variableexpansion.envvars.preferred";
 
     public static String expandValue(String value) {
         return (String) getTranslatedValue(value);
@@ -113,10 +112,10 @@ public static Object getTranslatedValue(Object value) {
             // such as a=${a} or a=foo ${b} and b=bar {$a}
             Matcher m = p.matcher(stringValue);
             String origValue = stringValue;
-            boolean useEnvVars = !Boolean.getBoolean(DISABLE_ENV_VAR_EXPANSION_PROPERTY);
+            boolean useEnvVars = !Boolean.getBoolean(SystemPropertyConstants.DISABLE_ENV_VAR_EXPANSION_PROPERTY);
             boolean preferEnvVars = false;
             if (useEnvVars) {
-                preferEnvVars = Boolean.getBoolean(ENV_VAR_EXPANSION_PREFERRED_PROPERTY);
+                preferEnvVars = Boolean.getBoolean(SystemPropertyConstants.PREFER_ENV_VARS_OVER_PROPERTIES);
             }
             int i = 0;
             while (m.find() && i < MAX_SUBSTITUTION_DEPTH) {
@@ -146,12 +145,12 @@ private static String getPropertyValue(String variableName, boolean useEnvVars,
         if (value == null && useEnvVars) {
             value = System.getenv(variableName);
             if (value == null) {
-                variableName = INVALID_ENV_VAR_CHARS_PATTERN.matcher(variableName)
+                String modifiedVariableName = INVALID_ENV_VAR_CHARS_PATTERN.matcher(variableName)
                         .replaceAll("_");
-                value = System.getenv(variableName);
+                value = System.getenv(modifiedVariableName);
                 if (value == null) {
-                    variableName = variableName.toUpperCase();
-                    value = System.getenv(variableName);
+                    modifiedVariableName = modifiedVariableName.toUpperCase();
+                    value = System.getenv(modifiedVariableName);
                 }
                 if (value == null && preferEnvVars) {
                     value = System.getProperty(variableName);

nucleus/admin/launcher/src/main/java/com/sun/enterprise/admin/launcher/GFLauncher.java

@@ -60,6 +60,7 @@
 import static com.sun.enterprise.universal.process.ProcessStreamDrainer.save;
 import static com.sun.enterprise.util.OS.isDarwin;
 import static com.sun.enterprise.util.SystemPropertyConstants.DEBUG_MODE_PROPERTY;
+import static com.sun.enterprise.util.SystemPropertyConstants.DISABLE_ENV_VAR_EXPANSION_PROPERTY;
 import static com.sun.enterprise.util.SystemPropertyConstants.DROP_INTERRUPTED_COMMANDS;
 import static com.sun.enterprise.util.SystemPropertyConstants.PREFER_ENV_VARS_OVER_PROPERTIES;
 import static java.lang.Boolean.TRUE;
@@ -640,15 +641,17 @@ private void resolveAllTokens() {
         all.putAll(domainXMLjvmOptions.getCombinedMap());
         all.putAll(domainXMLJavaConfigProfiler.getConfig());
 
-        if (isPreferEnvOverProperties(all)) {
-            all.putAll(System.getenv());
-            replacePropertiesWithEnvVars(domainXMLjvmOptions.xProps);
-            replacePropertiesWithEnvVars(domainXMLjvmOptions.xxProps);
-            replacePropertiesWithEnvVars(domainXMLjvmOptions.plainProps);
-            replacePropertiesWithEnvVars(domainXMLjvmOptions.longProps);
-            replacePropertiesWithEnvVars(domainXMLjvmOptions.sysProps);
-        } else {
-            System.getenv().forEach((name, value) -> all.putIfAbsent(name, value));
+        if (!isEnvVarExpansionDisabled(all)) {
+            if (isPreferEnvOverProperties(all)) {
+                all.putAll(System.getenv());
+                replacePropertiesWithEnvVars(domainXMLjvmOptions.xProps);
+                replacePropertiesWithEnvVars(domainXMLjvmOptions.xxProps);
+                replacePropertiesWithEnvVars(domainXMLjvmOptions.plainProps);
+                replacePropertiesWithEnvVars(domainXMLjvmOptions.longProps);
+                replacePropertiesWithEnvVars(domainXMLjvmOptions.sysProps);
+            } else {
+                System.getenv().forEach((name, value) -> all.putIfAbsent(name, value));
+            }
         }
 
         TokenResolver resolver = new TokenResolver(all);
@@ -693,6 +696,10 @@ private static Boolean isPreferEnvOverProperties(Map<String, String> properties)
         return Boolean.parseBoolean(properties.get(PREFER_ENV_VARS_OVER_PROPERTIES));
     }
 
+    private static boolean isEnvVarExpansionDisabled(Map<String, String> all) {
+        return Boolean.parseBoolean(all.get(DISABLE_ENV_VAR_EXPANSION_PROPERTY));
+    }
+
     private void fixLogFilename() throws GFLauncherException {
         if (!ok(logFilename)) {
             logFilename = DEFAULT_LOGFILE;

nucleus/common/common-util/src/main/java/com/sun/enterprise/util/SystemPropertyConstants.java

@@ -77,7 +77,8 @@ public class SystemPropertyConstants {
     public static final String DEFAULT_ADMIN_TIMEOUT_PROPERTY = "org.glassfish.admin.timeout";
     private static final int DEFAULT_ADMIN_TIMEOUT_VALUE = 5000;
 
-    public static final String PREFER_ENV_VARS_OVER_PROPERTIES = "org.glassfish.envPreferredToProperties";
+    public static final String PREFER_ENV_VARS_OVER_PROPERTIES = "org.glassfish.variableExpansion.envPreferred";
+    public static final String DISABLE_ENV_VAR_EXPANSION_PROPERTY = "org.glassfish.variableExpansion.envDisabled";
 
     public static final String TRUSTSTORE_FILENAME_DEFAULT = "cacerts.p12";
     public static final String KEYSTORE_FILENAME_DEFAULT = "keystore.p12";