Add config resolver

modules/commons/src/main/java/org/apache/synapse/commons/property/PropertyLoader.java

@@ -0,0 +1,71 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ *
+ *  WSO2 LLC. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.synapse.commons.property;
+
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * Property Loader is the class used to store the properties in the map
+ */
+public class PropertyLoader {
+
+    private ConcurrentHashMap<String, String> properties;
+
+    private static class PropertyLoaderHelper {
+        private static final PropertyLoader INSTANCE = new PropertyLoader();
+    }
+
+    private PropertyLoader() {}
+
+    public static PropertyLoader getInstance() {
+        return PropertyLoaderHelper.INSTANCE;
+    }
+
+    public void setProperty(String key, String value) {
+        if (properties == null) {
+            this.properties = createPropertyInstance();
+        }
+        this.properties.put(key, value);
+    }
+
+    private ConcurrentHashMap<String, String> createPropertyInstance() {
+        if (properties == null) {
+            this.properties = new ConcurrentHashMap<>();
+        }
+        return this.properties;
+    }
+
+
+    public String getPropertyValue(String key) {
+        if (properties == null) {
+            this.properties = new ConcurrentHashMap<>();
+        }
+        return this.properties.get(key);
+    }
+
+    public Boolean hasKey(String key) {
+        if (properties == null) {
+            this.properties = new ConcurrentHashMap<>();
+        }
+        return properties.containsKey(key);
+    }
+
+    public ConcurrentHashMap<String, String> getProperties() {
+        return this.properties;
+    }
+}

modules/commons/src/main/java/org/apache/synapse/commons/resolvers/ConfigResolver.java

@@ -0,0 +1,49 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ *
+ *  WSO2 LLC. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.synapse.commons.resolvers;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.synapse.commons.property.PropertyLoader;
+
+/**
+ * Config Resolver can be used to resolve configurable property variables in the synapse config.
+ */
+public class ConfigResolver implements Resolver {
+
+    private static final Log LOG = LogFactory.getLog(FilePropertyResolver.class);
+
+    private String input;
+
+    @Override
+    public void setVariable(String input) {
+        this.input = input;
+    }
+
+    @Override
+    public String resolve() {
+        String propertyValue = PropertyLoader.getInstance().getPropertyValue(this.input);
+        if (propertyValue == null) {
+            throw new ResolverException("Parameter key: " + input + " could not be found");
+        }
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Resolving parameter key: "+ input + " value: " + propertyValue);
+        }
+        return propertyValue;
+    }
+}

modules/commons/src/main/java/org/apache/synapse/commons/resolvers/ResolverFactory.java

@@ -30,13 +30,14 @@ public class ResolverFactory {
 
     private static final Log LOG = LogFactory.getLog(ResolverFactory.class);
     private static final int RESOLVER_INDEX = 2;
-    private static ResolverFactory resolverFactory = new ResolverFactory();
+    private static final ResolverFactory resolverFactory = new ResolverFactory();
     private final Pattern rePattern = Pattern.compile("(\\$)([_a-zA-Z0-9]+):([_a-zA-Z0-9]+)");
     private static final String SYSTEM_VARIABLE_PREFIX = "$SYSTEM";
     private static final String FILE_PROPERTY_VARIABLE_PREFIX = "$FILE";
     private static final String CUSTOM_PROPERTY_VARIABLE_PREFIX = "$CUSTOM_";
+    private static final String CONFIGURABLE_VARIABLE_PREFIX = "$config:";
 
-    private Map<String, Class<? extends Resolver>> resolverMap = new HashMap<>();
+    private final Map<String, Class<? extends Resolver>> resolverMap = new HashMap<>();
 
     /**
      * This function return an object of Resolver factory
@@ -61,56 +62,41 @@ public Resolver getResolver(String input) {
         if (input == null) {
             return null;
         }
-
-        if (input.startsWith(SYSTEM_VARIABLE_PREFIX)) {
-            Matcher matcher = rePattern.matcher(input);
-            Resolver resolverObject = null;
+        Matcher matcher = rePattern.matcher(input);
+        if (input.startsWith(CONFIGURABLE_VARIABLE_PREFIX)) {
             if (matcher.find()) {
                 Class<? extends Resolver> resolverClass = resolverMap.get(matcher.group(RESOLVER_INDEX).toLowerCase());
                 if (resolverClass != null) {
-                    try {
-                        resolverObject = resolverClass.newInstance();
-                        resolverObject.setVariable(matcher.group(3));
-                        return resolverObject;
-                    } catch (IllegalAccessException | InstantiationException e) {
-                        throw new ResolverException("Resolver could not be found");
-                    }
+                    return getResolver(resolverClass, matcher);
                 } else {
                     throw new ResolverException("Resolver could not be found");
                 }
             }
-        } else if(input.startsWith(FILE_PROPERTY_VARIABLE_PREFIX)){
-            Matcher matcher = rePattern.matcher(input);
-            Resolver resolverObject = null;
+        } else if (input.startsWith(SYSTEM_VARIABLE_PREFIX)) {
+            if (matcher.find()) {
+                Class<? extends Resolver> resolverClass = resolverMap.get(matcher.group(RESOLVER_INDEX).toLowerCase());
+                if (resolverClass != null) {
+                    return getResolver(resolverClass, matcher);
+                } else {
+                    throw new ResolverException("Resolver could not be found");
+                }
+            }
+        } else if(input.startsWith(FILE_PROPERTY_VARIABLE_PREFIX)) {
             if (matcher.find()){
                 Class<? extends Resolver> resolverClass = resolverMap.get(matcher.group(RESOLVER_INDEX).toLowerCase());
                 if (resolverClass != null) {
-                    try {
-                        resolverObject = resolverClass.newInstance();
-                        resolverObject.setVariable(matcher.group(3));
-                        return resolverObject;
-                    } catch (IllegalAccessException | InstantiationException e) {
-                        throw new ResolverException("Resolver could not be initialized", e);
-                    }
+                    return getResolver(resolverClass, matcher);
                 } else {
                     throw new ResolverException("Resolver could not be found");
                 }
             }
         } else if(input.startsWith(CUSTOM_PROPERTY_VARIABLE_PREFIX)) {
-            Matcher matcher = rePattern.matcher(input);
-            Resolver resolverObject = null;
             if (matcher.find()){
                 String nameWithPlaceholder = matcher.group(RESOLVER_INDEX).toLowerCase();
                 String className = nameWithPlaceholder.substring(CUSTOM_PROPERTY_VARIABLE_PREFIX.length() - 1);
                 Class<? extends Resolver> resolverClass = resolverMap.get(className);
                 if (resolverClass != null) {
-                    try {
-                        resolverObject = resolverClass.newInstance();
-                        resolverObject.setVariable(matcher.group(3));
-                        return resolverObject;
-                    } catch (IllegalAccessException | InstantiationException e) {
-                        throw new ResolverException("Resolver could not be initialized", e);
-                    }
+                    return getResolver(resolverClass, matcher);
                 } else {
                     throw new ResolverException("Resolver could not be found");
                 }
@@ -126,6 +112,7 @@ public Resolver getResolver(String input) {
     private void registerResolvers() {
         resolverMap.put("system", SystemResolver.class);
         resolverMap.put("file", FilePropertyResolver.class);
+        resolverMap.put("config", ConfigResolver.class);
     }
 
     private void registerExterns() {
@@ -147,4 +134,14 @@ private void registerExterns() {
             }
         }
     }
+
+    private Resolver getResolver(Class<? extends Resolver> resolverClass, Matcher matcher) {
+        try {
+            Resolver resolverObject = resolverClass.newInstance();
+            resolverObject.setVariable(matcher.group(3));
+            return resolverObject;
+        } catch (IllegalAccessException | InstantiationException e) {
+            throw new ResolverException("Resolver could not be found");
+        }
+    }
 }

modules/commons/src/main/java/org/apache/synapse/commons/util/FilePropertyLoader.java

@@ -22,9 +22,10 @@
 import org.apache.synapse.commons.SynapseCommonsException;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.InputStream;
 import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
@@ -41,6 +42,7 @@ public class FilePropertyLoader {
     private static final String CONF_LOCATION = "conf.location";
     private static final String FILE_PROPERTY_PATH = "properties.file.path";
     private static final String DEFAULT_PROPERTY_FILE = "file.properties";
+    private static final String CONFIG_PROPERTY_FILE = "config.properties";
     private static final String FILE_SYNC_INTERVAL = "file.properties.sync.interval";
     private static final String FILE_CANNOT_BE_FOUND_ERROR = "File cannot found in ";
     private String propertiesFilePath;
@@ -101,7 +103,7 @@ private void loadPropertiesFile() throws SynapseCommonsException {
         File file = new File(propertiesFilePath);
         if (file.exists()) {
             if (file.lastModified() > lastModifiedTimestamp) {
-                try (InputStream in = new FileInputStream(propertiesFilePath)) {
+                try (InputStream in = Files.newInputStream(Paths.get(propertiesFilePath))) {
                     Properties rawProps = new Properties();
                     Map<String, String> tempPropertyMap = new HashMap<>();
                     rawProps.load(in);
@@ -131,6 +133,8 @@ private void init() {
         }
         if (("default").equals(filePath)) {
             propertiesFilePath = System.getProperty(CONF_LOCATION) + File.separator + DEFAULT_PROPERTY_FILE;
+        } else if (("configurable").equals(filePath)) {
+            propertiesFilePath = System.getProperty(CONF_LOCATION) + File.separator + CONFIG_PROPERTY_FILE;
         } else {
             propertiesFilePath = filePath;
         }

modules/core/src/main/java/org/apache/synapse/mediators/builtin/PropertyMediator.java

@@ -41,6 +41,7 @@
 import org.apache.axis2.util.JavaUtils;
 import org.apache.http.protocol.HTTP;
 import org.apache.synapse.util.MediatorPropertyUtils;
+import org.apache.synapse.util.resolver.SecureVaultResolver;
 
 import java.util.Comparator;
 import java.util.Map;
@@ -211,7 +212,7 @@ public int compare(String o1, String o2) {
                             org.apache.axis2.context.MessageContext.TRANSPORT_HEADERS,
                             headersMap);
                 }
-            }else if(XMLConfigConstants.SCOPE_OPERATION.equals(scope)
+            } else if(XMLConfigConstants.SCOPE_OPERATION.equals(scope)
                     && synCtx instanceof Axis2MessageContext){
             	//Setting Transport Headers
                 Axis2MessageContext axis2smc = (Axis2MessageContext) synCtx;
@@ -504,7 +505,7 @@ private String getMatchedValue(String value, SynapseLog synLog) {
                 matchedValue = matcher.group(group);
             } else {
                 if (synLog.isTraceOrDebugEnabled()) {
-                    String msg = "Failed to get a match for regx : " +
+                    String msg = "Failed to get a match for regex : " +
                             pattern.toString() + " with the property value :" +
                             value + " for group :" + group;
                     synLog.traceOrDebug(msg);
@@ -515,7 +516,7 @@ private String getMatchedValue(String value, SynapseLog synLog) {
 
         } else {
             if (synLog.isTraceOrDebugEnabled()) {
-                String msg = "Unable to find a match for regx : " +
+                String msg = "Unable to find a match for regex : " +
                         pattern.toString() + " with the property value :" + value;
                 synLog.traceOrDebug(msg);
             }

modules/core/src/main/java/org/apache/synapse/util/xpath/DOMSynapseXPathNamespaceMap.java

@@ -17,6 +17,7 @@ public DOMSynapseXPathNamespaceMap() {
         knownPrefixMap.add(SynapseXPathConstants.SOAP_BODY_VARIABLE);
         knownPrefixMap.add(SynapseXPathConstants.FUNC_CONTEXT_VARIABLE_PREFIX);
         knownPrefixMap.add(SynapseXPathConstants.MESSAGE_CONTEXT_VARIABLE_PREFIX);
+        knownPrefixMap.add(SynapseXPathConstants.CONFIG_VARIABLE_PREFIX);
         knownPrefixMap.add(SynapseXPathConstants.URL_VARIABLE_PREFIX);
         knownPrefixMap.add(SynapseXPathConstants.AXIS2_CONTEXT_VARIABLE_PREFIX);
         knownPrefixMap.add(SynapseXPathConstants.TRANSPORT_VARIABLE_PREFIX);

modules/core/src/main/java/org/apache/synapse/util/xpath/SynapseXPath.java

@@ -176,19 +176,20 @@ public SynapseXPath(String xpathString) throws JaxenException {
             contentAware = false;
         }
 
-	 String propertyScope = getPropertyScope(xpathString);
-	 // skip message building for scope registry, system and transport scopes
-	 // for get-property() method
-	 if (XMLConfigConstants.SCOPE_REGISTRY.equals(propertyScope)
-			|| XMLConfigConstants.SCOPE_SYSTEM.equals(propertyScope)
-             || XMLConfigConstants.SCOPE_TRANSPORT.equals(propertyScope)
-             || XMLConfigConstants.SCOPE_ENVIRONMENT.equals(propertyScope)
-             || XMLConfigConstants.SCOPE_FILE.equals(propertyScope)) {
-         contentAware = false;
-         return;
-	 }
-
-        if(xpathString.contains("$trp") || xpathString.contains("$ctx") || xpathString.contains("$axis2")){
+         String propertyScope = getPropertyScope(xpathString);
+         // skip message building for scope registry, system and transport scopes
+         // for get-property() method
+         if (XMLConfigConstants.SCOPE_REGISTRY.equals(propertyScope)
+                || XMLConfigConstants.SCOPE_SYSTEM.equals(propertyScope)
+                 || XMLConfigConstants.SCOPE_TRANSPORT.equals(propertyScope)
+                 || XMLConfigConstants.SCOPE_ENVIRONMENT.equals(propertyScope)
+                 || XMLConfigConstants.SCOPE_FILE.equals(propertyScope)) {
+             contentAware = false;
+             return;
+         }
+
+        if(xpathString.contains("$trp") || xpathString.contains("$ctx") || xpathString.contains("$axis2") ||
+                xpathString.contains("$config")) {
             contentAware = false;
             return;
         }
@@ -276,7 +277,7 @@ public SynapseXPath(String xpathExpr, OMElement elem) throws JaxenException {
             contentAware = false;
         }
 
-        if (xpathExpr.contains("$trp") || xpathExpr.contains("$ctx") || xpathExpr.contains("$axis2")) {
+        if (xpathExpr.contains("$trp") || xpathExpr.contains("$ctx") || xpathExpr.contains("$axis2") || xpathExpr.contains("$config")) {
             contentAware = false;
         }
     }

modules/core/src/main/java/org/apache/synapse/util/xpath/SynapseXPathConstants.java

@@ -57,6 +57,8 @@ public final class SynapseXPathConstants {
     /** Variable prefix for accessing the MessageContext properties through XPath variables */
     public static final String MESSAGE_CONTEXT_VARIABLE_PREFIX = "ctx";
 
+    public static final String CONFIG_VARIABLE_PREFIX = "config";
+
     /** Variable prefix for accessing the Function/Template Context properties through XPath variables */
     public static final String FUNC_CONTEXT_VARIABLE_PREFIX = "func";