Map extension routes to permission-able action names

src/main/java/org/opensearch/sdk/ExtensionRouteHandler.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.sdk;
+
+import org.opensearch.rest.RestRequest;
+import org.opensearch.extensions.rest.ExtensionRestResponse;
+import org.opensearch.extensions.rest.RouteHandler;
+
+import java.util.function.Function;
+
+public class ExtensionRouteHandler extends RouteHandler {
+
+    public ExtensionRouteHandler(
+        String handlerName,
+        RestRequest.Method method,
+        String path,
+        Function<RestRequest, ExtensionRestResponse> handler
+    ) {
+        super(ExtensionRouteHandlerFactory.getInstance().generateRouteName(handlerName), method, path, handler);
+    }
+}

src/main/java/org/opensearch/sdk/ExtensionRouteHandlerFactory.java

@@ -0,0 +1,30 @@
+package org.opensearch.sdk;
+
+import org.opensearch.OpenSearchException;
+
+public class ExtensionRouteHandlerFactory {
+    private static ExtensionRouteHandlerFactory INSTANCE;
+
+    private String extensionShortName;
+
+    private ExtensionRouteHandlerFactory() { }
+
+    public static ExtensionRouteHandlerFactory getInstance() {
+        if(INSTANCE == null) {
+            INSTANCE = new ExtensionRouteHandlerFactory();
+        }
+
+        return INSTANCE;
+    }
+
+    public void init(String extensionShortName) {
+        if (this.extensionShortName != null) {
+            throw new OpenSearchException("ExtensionRouteHandlerFactory was previously initialized");
+        }
+        this.extensionShortName = extensionShortName;
+    }
+
+    public String generateRouteName(String handlerName) {
+        return extensionShortName + ":" + handlerName;
+    }
+}

src/main/java/org/opensearch/sdk/ExtensionSettings.java

@@ -53,6 +53,8 @@ public class ExtensionSettings {
     private String hostPort;
     private String opensearchAddress;
     private String opensearchPort;
+    private String shortName;
+    private Map<String, String> securitySettings;
 
     public static final Set<String> SECURITY_SETTINGS_KEYS = Set.of(
         "path.home", // TODO Find the right place to put this setting
@@ -79,8 +81,6 @@ public class ExtensionSettings {
         SSL_TRANSPORT_TRUSTSTORE_TYPE
     );
 
-    private Map<String, String> securitySettings;
-
     /**
      * Jackson requires a no-arg constructor.
      */
@@ -93,14 +93,23 @@ private ExtensionSettings() {
      * Instantiate this class using the specified parameters.
      *
      * @param extensionName  The extension name. Provided to OpenSearch as a response to initialization query. Must match the defined extension name in OpenSearch.
+     * @param shortName  The shortened name for the extension
      * @param hostAddress  The IP Address to bind this extension to.
      * @param hostPort  The port to bind this extension to.
      * @param opensearchAddress  The IP Address on which OpenSearch is running.
      * @param opensearchPort  The port on which OpenSearch is running.
      */
-    public ExtensionSettings(String extensionName, String hostAddress, String hostPort, String opensearchAddress, String opensearchPort) {
+    public ExtensionSettings(
+        String extensionName,
+        String shortName,
+        String hostAddress,
+        String hostPort,
+        String opensearchAddress,
+        String opensearchPort
+    ) {
         super();
         this.extensionName = extensionName;
+        this.shortName = shortName;
         this.hostAddress = hostAddress;
         this.hostPort = hostPort;
         this.opensearchAddress = opensearchAddress;
@@ -112,6 +121,7 @@ public ExtensionSettings(String extensionName, String hostAddress, String hostPo
      * Instantiate this class using the specified parameters.
      *
      * @param extensionName  The extension name. Provided to OpenSearch as a response to initialization query. Must match the defined extension name in OpenSearch.
+     * @param shortName  The shortened name for the extension
      * @param hostAddress  The IP Address to bind this extension to.
      * @param hostPort  The port to bind this extension to.
      * @param opensearchAddress  The IP Address on which OpenSearch is running.
@@ -120,20 +130,25 @@ public ExtensionSettings(String extensionName, String hostAddress, String hostPo
      */
     public ExtensionSettings(
         String extensionName,
+        String shortName,
         String hostAddress,
         String hostPort,
         String opensearchAddress,
         String opensearchPort,
         Map<String, String> securitySettings
     ) {
-        this(extensionName, hostAddress, hostPort, opensearchAddress, opensearchPort);
+        this(extensionName, shortName, hostAddress, hostPort, opensearchAddress, opensearchPort);
         this.securitySettings = securitySettings;
     }
 
     public String getExtensionName() {
         return extensionName;
     }
 
+    public String getShortName() {
+        return shortName;
+    }
+
     public String getHostAddress() {
         return hostAddress;
     }
@@ -166,6 +181,8 @@ public Map<String, String> getSecuritySettings() {
     public String toString() {
         return "ExtensionSettings{extensionName="
             + extensionName
+            + ", shortName="
+            + shortName
             + ", hostAddress="
             + hostAddress
             + ", hostPort="
@@ -205,6 +222,7 @@ public static ExtensionSettings readSettingsFromYaml(String extensionSettingsPat
             }
             return new ExtensionSettings(
                 extensionMap.get("extensionName").toString(),
+                extensionMap.get("shortName").toString(),
                 extensionMap.get("hostAddress").toString(),
                 extensionMap.get("hostPort").toString(),
                 extensionMap.get("opensearchAddress").toString(),

src/main/java/org/opensearch/sdk/ExtensionsRunner.java

@@ -24,6 +24,7 @@
 import org.opensearch.extensions.proto.ExtensionRequestProto;
 import org.opensearch.extensions.rest.ExtensionRestRequest;
 import org.opensearch.extensions.rest.RegisterRestActionsRequest;
+import org.opensearch.extensions.rest.RouteHandler;
 import org.opensearch.extensions.settings.RegisterCustomSettingsRequest;
 import org.opensearch.common.settings.Setting;
 import org.opensearch.common.settings.Settings;
@@ -36,6 +37,7 @@
 import org.opensearch.extensions.UpdateSettingsRequest;
 import org.opensearch.extensions.action.ExtensionActionRequest;
 import org.opensearch.index.IndicesModuleRequest;
+import org.opensearch.rest.RestHandler;
 import org.opensearch.sdk.action.SDKActionModule;
 import org.opensearch.sdk.handlers.AcknowledgedResponseHandler;
 import org.opensearch.sdk.api.ActionExtension;
@@ -195,6 +197,12 @@ protected ExtensionsRunner(Extension extension) throws IOException {
         logger.info("SSL is " + sslText + " for transport");
         this.settings = settingsBuilder.build();
 
+        if (extensionSettings.getShortName() != null) {
+            // initialize ExtensionRouteHandlerFactory
+            ExtensionRouteHandlerFactory factory = ExtensionRouteHandlerFactory.getInstance();
+            factory.init(extensionSettings.getShortName());
+        }
+
         final List<ExecutorBuilder<?>> executorBuilders = extension.getExecutorBuilders(settings);
 
         this.runnableTaskListener = new AtomicReference<>();
@@ -255,7 +263,18 @@ protected ExtensionsRunner(Extension extension) throws IOException {
         if (extension instanceof ActionExtension) {
             // store REST handlers in the registry
             for (ExtensionRestHandler extensionRestHandler : ((ActionExtension) extension).getExtensionRestHandlers()) {
-                extensionRestPathRegistry.registerHandler(extensionRestHandler);
+                for (RestHandler.Route route : extensionRestHandler.routes()) {
+                    if (route instanceof RouteHandler && ((RouteHandler) route).name() != null) {
+                        extensionRestPathRegistry.registerHandler(
+                            route.getMethod(),
+                            route.getPath(),
+                            ((RouteHandler) route).name(),
+                            extensionRestHandler
+                        );
+                    } else {
+                        extensionRestPathRegistry.registerHandler(route.getMethod(), route.getPath(), extensionRestHandler);
+                    }
+                }
             }
         }
     }

src/main/java/org/opensearch/sdk/rest/BaseExtensionRestHandler.java

@@ -13,6 +13,8 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
+
+import org.opensearch.extensions.rest.RouteHandler;
 import org.opensearch.rest.BaseRestHandler;
 import static org.opensearch.rest.RestStatus.INTERNAL_SERVER_ERROR;
 import static org.opensearch.rest.RestStatus.NOT_FOUND;
@@ -206,36 +208,6 @@ protected final String unrecognized(
         return BaseRestHandler.unrecognizedStrings(request, invalids, candidates, detail);
     }
 
-    /**
-     * A subclass of {@link Route} that includes a handler method for that route.
-     */
-    public static class RouteHandler extends Route {
-
-        private final Function<RestRequest, ExtensionRestResponse> responseHandler;
-
-        /**
-         * Handle the method and path with the specified handler.
-         *
-         * @param method The {@link Method} to handle.
-         * @param path The path to handle.
-         * @param handler The method which handles the method and path.
-         */
-        public RouteHandler(Method method, String path, Function<RestRequest, ExtensionRestResponse> handler) {
-            super(method, path);
-            this.responseHandler = handler;
-        }
-
-        /**
-         * Executes the handler for this route.
-         *
-         * @param request The request to handle
-         * @return the {@link ExtensionRestResponse} result from the handler for this route.
-         */
-        public ExtensionRestResponse handleRequest(RestRequest request) {
-            return responseHandler.apply(request);
-        }
-    }
-
     /**
      * A subclass of {@link DeprecatedRoute} that includes a handler method for that route.
      */

src/main/java/org/opensearch/sdk/rest/ExtensionRestPathRegistry.java

@@ -60,7 +60,7 @@ public void registerHandler(ExtensionRestHandler restHandler) {
      * @param handler The handler to actually execute
      * @param method GET, POST, etc.
      */
-    private void registerHandler(Method method, String path, ExtensionRestHandler extensionRestHandler) {
+    public void registerHandler(Method method, String path, ExtensionRestHandler extensionRestHandler) {
         pathTrie.insertOrUpdate(
             path,
             new SDKMethodHandlers(path, extensionRestHandler, method),
@@ -133,6 +133,24 @@ private void registerWithDeprecatedHandler(
         registerAsDeprecatedHandler(deprecatedMethod, deprecatedPath, handler, deprecationMessage);
     }
 
+    /**
+     * Register a REST handler to handle a method and route in this extension's path registry.
+     *
+     * @param method  The method to register.
+     * @param path  The path to register. May include named wildcards.
+     * @param name  An optional name of the REST handler
+     * @param extensionRestHandler  The RestHandler to handle this route
+     */
+    public void registerHandler(Method method, String path, String name, ExtensionRestHandler extensionRestHandler) {
+        pathTrie.insertOrUpdate(
+            path,
+            new SDKMethodHandlers(path, extensionRestHandler, method),
+            (mHandlers, newMHandler) -> mHandlers.addMethods(extensionRestHandler, method)
+        );
+        String restPathWithName = restPathToString(method, path, name);
+        registeredPaths.add(restPathWithName);
+    }
+
     /**
      * Get the registered REST handler for the specified method and path.
      *
@@ -176,4 +194,16 @@ public List<String> getRegisteredDeprecatedPaths() {
     public static String restPathToString(Method method, String path) {
         return method.name() + " " + path;
     }
+
+    /**
+     * Converts a REST method and path to a space delimited string to be used as a map lookup key.
+     *
+     * @param method  the method.
+     * @param path  the path.
+     * @param name  the name.
+     * @return A string appending the method and path.
+     */
+    public static String restPathToString(Method method, String path, String name) {
+        return method.name() + " " + path + " " + name;
+    }
 }

src/main/java/org/opensearch/sdk/sample/helloworld/rest/RestHelloAction.java

@@ -15,9 +15,12 @@
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.common.xcontent.json.JsonXContent;
 import org.opensearch.extensions.rest.ExtensionRestResponse;
+import org.opensearch.extensions.rest.RouteHandler;
 import org.opensearch.rest.RestRequest;
+import org.opensearch.sdk.ExtensionRouteHandlerFactory;
 import org.opensearch.sdk.rest.BaseExtensionRestHandler;
 import org.opensearch.sdk.rest.ExtensionRestHandler;
+import org.opensearch.sdk.ExtensionRouteHandler;
 import java.io.IOException;
 import java.net.URLDecoder;
 import java.nio.ByteBuffer;
@@ -50,13 +53,21 @@ public class RestHelloAction extends BaseExtensionRestHandler {
     private List<String> worldAdjectives = new ArrayList<>();
     private Random rand = new Random();
 
+    /**
+     * Instantiate this action
+     *
+     * @param runner The ExtensionsRunner instance
+     */
+    public RestHelloAction() {
+    }
+
     @Override
     public List<RouteHandler> routeHandlers() {
         return List.of(
-            new RouteHandler(GET, "/hello", handleGetRequest),
-            new RouteHandler(POST, "/hello", handlePostRequest),
-            new RouteHandler(PUT, "/hello/{name}", handlePutRequest),
-            new RouteHandler(DELETE, "/goodbye", handleDeleteRequest)
+            new ExtensionRouteHandler("greet", GET, "/hello", handleGetRequest),
+            new ExtensionRouteHandler("greet_with_adjective", POST, "/hello", handlePostRequest),
+            new ExtensionRouteHandler("greet_with_name", PUT, "/hello/{name}", handlePutRequest),
+            new ExtensionRouteHandler("goodbye", DELETE, "/goodbye", handleDeleteRequest)
         );
     }
 

src/main/java/org/opensearch/sdk/sample/helloworld/rest/RestRemoteHelloAction.java

@@ -14,6 +14,7 @@
 import org.opensearch.extensions.ExtensionsManager;
 import org.opensearch.extensions.action.RemoteExtensionActionResponse;
 import org.opensearch.extensions.rest.ExtensionRestResponse;
+import org.opensearch.extensions.rest.RouteHandler;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.sdk.ExtensionsRunner;
 import org.opensearch.sdk.SDKClient;

src/main/resources/sample/helloworld-settings.yml

@@ -1,4 +1,5 @@
 extensionName: hello-world
+shortName: hw
 hostAddress: 127.0.0.1
 hostPort: 4532
 opensearchAddress: 127.0.0.1

src/test/java/org/opensearch/sdk/rest/TestBaseExtensionRestHandler.java

@@ -17,6 +17,7 @@
 import org.junit.jupiter.api.Test;
 import org.opensearch.common.bytes.BytesArray;
 import org.opensearch.extensions.rest.ExtensionRestResponse;
+import org.opensearch.extensions.rest.RouteHandler;
 import org.opensearch.rest.RestHandler.Route;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.RestRequest.Method;

src/test/java/org/opensearch/sdk/sample/helloworld/TestHelloWorldExtension.java

@@ -56,7 +56,7 @@ public class TestHelloWorldExtension extends OpenSearchTestCase {
     private Injector injector;
     private SDKClient sdkClient;
     private SDKRestClient sdkRestClient;
-    private final ExtensionSettings extensionSettings = new ExtensionSettings("", "", "", "localhost", "9200");
+    private final ExtensionSettings extensionSettings = new ExtensionSettings("", "hw", "", "", "localhost", "9200");
 
     static class UnregisteredAction extends ActionType<SampleResponse> {
         public static final String NAME = "helloworld/unregistered";
@@ -105,7 +105,7 @@ public void tearDown() throws Exception {
     public void testExtensionSettings() {
         // This effectively tests the Extension interface helper method
         ExtensionSettings extensionSettings = extension.getExtensionSettings();
-        ExtensionSettings expected = new ExtensionSettings("hello-world", "127.0.0.1", "4532", "127.0.0.1", "9200");
+        ExtensionSettings expected = new ExtensionSettings("hello-world", "hw", "127.0.0.1", "4532", "127.0.0.1", "9200");
         assertEquals(expected.getExtensionName(), extensionSettings.getExtensionName());
         assertEquals(expected.getHostAddress(), extensionSettings.getHostAddress());
         assertEquals(expected.getHostPort(), extensionSettings.getHostPort());

src/test/java/org/opensearch/sdk/sample/helloworld/rest/TestRestHelloAction.java

@@ -42,7 +42,7 @@ public class TestRestHelloAction extends OpenSearchTestCase {
     @BeforeEach
     public void setUp() throws Exception {
         super.setUp();
-        restHelloAction = new RestHelloAction();
+        restHelloAction = new RestHelloAction("hw");
     }
 
     @Test