Merge branch 'master' into mongodb-exchange-store-yaml-example

Author: predic8

README.md

@@ -297,11 +297,11 @@ api:
 #### Viewing Deployed APIs
 Once configured, a list of deployed APIs is available at: [http://localhost:2000/api-docs](http://localhost:2000/api-docs)
 
-![List of OpenAPI Deployments](distribution/examples/openapi/openapi-proxy/api-overview.png)
+![List of OpenAPI Deployments](distribution/examples/openapi/openapi-proxy/api-overview.jpg)
 
 Click on an API title in the list to open the Swagger UI for interactive exploration and testing:
 
-![Swagger UI](distribution/examples/openapi/openapi-proxy/swagger-ui.png)
+![Swagger UI](distribution/examples/openapi/openapi-proxy/swagger-ui.jpg)
 
 ### Learn More
 For additional details and a working example, check out the [OpenAPI Example](distribution/examples/openapi).

annot/pom.xml

@@ -54,7 +54,7 @@
         <dependency>
             <groupId>com.networknt</groupId>
             <artifactId>json-schema-validator</artifactId>
-            <version>2.0.0</version>
+            <version>2.0.1</version>
         </dependency>
         <dependency>
             <groupId>com.github.spotbugs</groupId>

annot/src/main/java/com/predic8/membrane/annot/yaml/MethodSetter.java

@@ -14,23 +14,21 @@
 
 package com.predic8.membrane.annot.yaml;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.predic8.membrane.annot.MCChildElement;
+import com.fasterxml.jackson.databind.*;
+import com.predic8.membrane.annot.*;
 import org.jetbrains.annotations.*;
 
-import javax.lang.model.util.Types;
+import javax.lang.model.util.*;
 import java.lang.reflect.*;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
-import static com.predic8.membrane.annot.yaml.GenericYamlParser.createAndPopulateNode;
-import static com.predic8.membrane.annot.yaml.GenericYamlParser.parseListIncludingStartEvent;
+import static com.predic8.membrane.annot.yaml.GenericYamlParser.*;
 import static com.predic8.membrane.annot.yaml.McYamlIntrospector.*;
-import static java.lang.Boolean.parseBoolean;
-import static java.lang.Integer.parseInt;
-import static java.lang.Long.parseLong;
-import static java.util.Locale.ROOT;
+import static java.lang.Boolean.*;
+import static java.lang.Double.*;
+import static java.lang.Integer.*;
+import static java.lang.Long.*;
+import static java.util.Locale.*;
 
 public class MethodSetter {
 
@@ -85,27 +83,53 @@ public <T> void setSetter(T instance, ParsingContext ctx, JsonNode node, String
     private Object resolveSetterValue(ParsingContext ctx, JsonNode node, String key) throws WrongEnumConstantException, ParsingException {
         Class<?> wanted = getParameterType();
 
+        // Collections / repeated elements
         List<Object> list = getObjectList(ctx, node, key, wanted);
         if (list != null) return list;
 
+        // Structured objects
+        if (McYamlIntrospector.isStructured(setter)) {
+            if (beanClass != null) return createAndPopulateNode(ctx.updateContext(key), beanClass, node);
+            return createAndPopulateNode(ctx.updateContext(key), wanted, node);
+        }
+
+        return coerceScalarOrReference(ctx, node, key, wanted);
+    }
+
+    /**
+     * Attempts to coerce a given JSON node into the desired scalar, enum, reference, or map type,
+     * as specified by the provided target class.
+     *
+     * @param ctx The parsing context, providing access to type resolution and bean lookup mechanisms.
+     * @param node The JSON node to be coerced into the desired type.
+     * @param key The key corresponding to the JSON node, often used for error messages or map assignments.
+     * @param wanted The target class specifying the type into which the node should be converted.
+     * @return The coerced object, matching the desired type, derived from the input node.
+     * @throws WrongEnumConstantException If the node value does not match any of the constants in the enum type.
+     * @throws ParsingException If the provided type is unsupported for coercion or other unexpected issues arise.
+     */
+    Object coerceScalarOrReference(ParsingContext ctx, JsonNode node, String key, Class<?> wanted) throws WrongEnumConstantException {
+        // Scalars, enums, bean refs, "other attributes"
         if (wanted.isEnum()) return parseEnum(wanted, node);
         if (wanted.equals(String.class)) return node.asText();
 
-        if (wanted == Integer.TYPE || wanted == Integer.class) return parseInt(node.asText());
-        if (wanted == Long.TYPE || wanted == Long.class) return parseLong(node.asText());
-        if (wanted == Boolean.TYPE || wanted == Boolean.class) return parseBoolean(node.asText());
-        if (wanted.equals(Map.class) && McYamlIntrospector.hasOtherAttributes(setter)) return Map.of(key, node.asText());
+        if (wanted == int.class || wanted == Integer.class)
+            return node.isInt() ? node.intValue() : parseInt(node.asText());
+        if (wanted == long.class || wanted == Long.class)
+            return node.isLong() || node.isInt() ? node.longValue() : parseLong(node.asText());
+        if (wanted == double.class || wanted == Double.class)
+            return node.isNumber() ? node.doubleValue() : parseDouble(node.asText());
+        if (wanted == boolean.class || wanted == Boolean.class)
+            return node.isBoolean() ? node.booleanValue() : parseBoolean(node.asText());
+        if (wanted.equals(Map.class) && McYamlIntrospector.hasOtherAttributes(setter))
+            return Map.of(key, node.asText());
 
         if (node.isTextual() && isBeanReference(wanted)) {
             return resolveReference(ctx, node, key, wanted);
         }
 
-        if (McYamlIntrospector.isStructured(setter)) {
-            if (beanClass != null) return createAndPopulateNode(ctx.updateContext(key), beanClass, node);
-            return createAndPopulateNode(ctx.updateContext(key), wanted, node);
-        }
         if (McYamlIntrospector.isReferenceAttribute(setter)) return ctx.registry().resolve(node.asText());
-        throw new RuntimeException("Not implemented setter type " + wanted);
+        throw new ParsingException("Unsupported setter type: %s for key '%s' with node type %s".formatted(wanted.getName(), key, node.getNodeType()), node);
     }
 
     private @Nullable List<Object> getObjectList(ParsingContext ctx, JsonNode node, String key, Class<?> wanted) {
@@ -118,7 +142,7 @@ private Object resolveSetterValue(ParsingContext ctx, JsonNode node, String key)
                     if (o == null) continue;
                     if (!elemType.isAssignableFrom(o.getClass())) {
                         throw new ParsingException("Value of type '%s' is not allowed in list '%s'. Expected '%s'."
-                                        .formatted(McYamlIntrospector.getElementName(o.getClass()), key, elemType.getSimpleName()), node);
+                                .formatted(McYamlIntrospector.getElementName(o.getClass()), key, elemType.getSimpleName()), node);
                     }
                 }
             }

annot/src/test/java/com/predic8/membrane/annot/yaml/MethodSetterTest.java

@@ -14,15 +14,20 @@
 
 package com.predic8.membrane.annot.yaml;
 
-import com.predic8.membrane.annot.MCChildElement;
-import com.predic8.membrane.annot.util.GrammarMock;
-import org.junit.jupiter.api.Test;
+import com.fasterxml.jackson.core.*;
+import com.fasterxml.jackson.databind.*;
+import com.predic8.membrane.annot.*;
+import com.predic8.membrane.annot.util.*;
+import org.junit.jupiter.api.*;
 
-import static com.predic8.membrane.annot.yaml.MethodSetter.getMethodSetter;
+import static com.predic8.membrane.annot.yaml.MethodSetter.*;
 import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 class MethodSetterTest {
 
+    private static final ObjectMapper om = new ObjectMapper();
+
     @SuppressWarnings("unused")
     static class A {
         public void setA1(B b) {}
@@ -44,25 +49,36 @@ public static class B {}
     public static class C {}
 
     @Test
-    public void dontUseMethodsWithoutChildElementAnnotation() {
+    void dontUseMethodsWithoutChildElementAnnotation() {
         MethodSetter ms = getMethodSetter(new ParsingContext("foo", null,
                         new GrammarMock().withGlobalElement("b", B.class)),
                 A.class, "b");
         assertEquals("setA3", ms.getSetter().getName());
     }
 
     @Test
-    public void multiplePotentialSettersFound() {
+    void multiplePotentialSettersFound() {
         assertThrowsExactly(RuntimeException.class, () -> getMethodSetter(new ParsingContext("foo", null,
                         new GrammarMock().withGlobalElement("b", B.class)),
                 A2.class, "b"));
     }
 
     @Test
-    public void noPotentialSetterFound() {
+    void noPotentialSetterFound() {
         assertThrowsExactly(RuntimeException.class, () -> getMethodSetter(new ParsingContext("foo", null,
                         new GrammarMock().withGlobalElement("c", C.class)),
                 A2.class, "c"));
     }
 
+    @Test
+    void coerceScalar() throws Exception {
+        var ms  = new MethodSetter(null, null);
+        assertEquals(true, ms.coerceScalarOrReference(null, om.readTree("true"), null, boolean.class));
+        assertEquals(true, ms.coerceScalarOrReference(null, om.readTree("true"), null, Boolean.class));
+        assertEquals(1, ms.coerceScalarOrReference(null, om.readTree("1"), null, int.class));
+        assertEquals(1.0, ms.coerceScalarOrReference(null, om.readTree("1"), null, double.class));
+        var l = ms.coerceScalarOrReference(null, om.readTree("1"), null, long.class);
+        assertInstanceOf(Long.class, l);
+        assertEquals(1L, l);
+    }
 }

core/src/main/java/com/predic8/membrane/core/cli/RouterCLI.java

@@ -75,8 +75,7 @@ private static void start(String[] args) {
         if (commandLine.getCommand().getName().equals("private-jwk-to-public")) {
             privateJwkToPublic(commandLine);
         }
-        var router = getRouter(commandLine);
-        if (router instanceof DefaultRouter dr)
+        if (getRouter(commandLine) instanceof DefaultRouter dr)
             dr.waitFor();
     }
 

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/ApiKeysInterceptor.java

@@ -14,7 +14,6 @@
 package com.predic8.membrane.core.interceptor.apikey;
 
 import com.predic8.membrane.annot.*;
-import com.predic8.membrane.core.config.spring.*;
 import com.predic8.membrane.core.exchange.*;
 import com.predic8.membrane.core.interceptor.*;
 import com.predic8.membrane.core.interceptor.apikey.extractors.*;
@@ -23,11 +22,10 @@
 import org.slf4j.*;
 
 import java.util.*;
-import java.util.stream.*;
 
 import static com.predic8.membrane.core.exceptions.ProblemDetails.*;
 import static com.predic8.membrane.core.interceptor.Outcome.*;
-import static java.util.stream.Collectors.joining;
+import static java.util.stream.Collectors.*;
 import static java.util.stream.Stream.*;
 
 /**
@@ -85,10 +83,17 @@ public String getLongDescription() {
     @Override
     public void init() {
         super.init();
-        // At the moment the beanFactory is only there when the Membrane configuration was read from XML
+
+        // Todo: Move logic into the registry
+        // The beanFactory is only there when the Membrane configuration was read from XML
         if (router.getBeanFactory() != null) {
             stores.addAll(router.getBeanFactory().getBeansOfType(ApiKeyStore.class).values());
         }
+        // For YAML configuration
+        if (router.getRegistry() != null) {
+            this.stores.addAll(router.getRegistry().getBeans(ApiKeyStore.class));
+        }
+
         stores.forEach(s -> s.init(router));
 
         // Add the default extractor if none is configured

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/extractors/ApiKeyHeaderExtractor.java

@@ -22,7 +22,6 @@
 import static com.predic8.membrane.core.security.ApiKeySecurityScheme.In.*;
 
 /**
- * @deprecated Set an expression like ${header['api']} on apiKey
  * @description Extracts an API key from a specific HTTP request header. By default, the header name
  * is <code>X-Api-Key</code>. If the header is present, its first value is returned as the API key.
  * <p>

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/inConfig/Key.java

@@ -26,19 +26,19 @@
 @MCElement(name = "secret", component = false)
 public class Key {
 
-    private final List<Scope> scopes = new ArrayList<>();
+    private final List<String> scopes = new ArrayList<>();
 
     private String value;
 
     /**
-     * @description <scope>...</scope> elements for defining scopes for this key.
+     * @description Scopes for this key.
      */
     @MCChildElement(allowForeign = true)
-    public void setScopes(List<Scope> scopes) {
+    public void setScopes(List<String> scopes) {
         this.scopes.addAll(scopes);
     }
 
-    public List<Scope> getScopes() {
+    public List<String> getScopes() {
         return scopes;
     }
 

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/inConfig/Scope.java

@@ -45,9 +45,7 @@ public List<Key> getKeys() {
     public Optional<Set<String>> getScopes(String apiKey) throws UnauthorizedApiKeyException {
         var key = keys.stream().filter(k -> k.getValue().equals(apiKey)).findFirst();
         if (key.isPresent()) {
-            Set<String> scopeValues = key.get().getScopes().stream()
-                    .map(Scope::getValue)
-                    .collect(toSet());
+            Set<String> scopeValues = new HashSet<>(key.get().getScopes());
             return ofNullable(scopeValues.isEmpty() ? null : scopeValues);
         } else {
             throw new UnauthorizedApiKeyException();