Revert "Register new routes via SDK as named routes (#827)"

This reverts commit 09c22b0.

CREATE_YOUR_FIRST_EXTENSION.md

@@ -164,28 +164,28 @@ import org.opensearch.sdk.rest.BaseExtensionRestHandler;
 public class CrudAction extends BaseExtensionRestHandler {
 
     @Override
-    public List<NamedRoute> routes() {
+    protected List<RouteHandler> routeHandlers() {
         return List.of(
-            new NamedRoute.Builder().method(Method.PUT).path("/sample").uniqueName("extension1:sample/create").handler(createHandler).build(),
-            new NamedRoute.Builder().method(Method.GET).path("/sample/{id}").uniqueName("extension1:sample/get").handler(readHandler).build(),
-            new NamedRoute.Builder().method(Method.POST).path("/sample/{id}").uniqueName("extension1:sample/post").handler(updateHandler).build(),
-            new NamedRoute.Builder().method(Method.DELETE).path("/sample/{id}").uniqueName("extension1:sample/delete").handler(deleteHandler).build()
+            new RouteHandler(Method.PUT, "/sample", createHandler),
+            new RouteHandler(Method.GET, "/sample/{id}", readHandler),
+            new RouteHandler(Method.POST, "/sample/{id}", updateHandler),
+            new RouteHandler(Method.DELETE, "/sample/{id}", deleteHandler)
         );
     }
 
-    Function<RestRequest, RestResponse> createHandler = (request) -> {
+    Function<RestRequest, ExtensionRestResponse> createHandler = (request) -> {
         return new ExtensionRestResponse(request, RestStatus.OK, "To be implemented");
     };
 
-    Function<RestRequest, RestResponse> readHandler = (request) -> {
+    Function<RestRequest, ExtensionRestResponse> readHandler = (request) -> {
         return new ExtensionRestResponse(request, RestStatus.OK, "To be implemented");
     };
 
-    Function<RestRequest, RestResponse> updateHandler = (request) -> {
+    Function<RestRequest, ExtensionRestResponse> updateHandler = (request) -> {
         return new ExtensionRestResponse(request, RestStatus.OK, "To be implemented");
     };
 
-    Function<RestRequest, RestResponse> deleteHandler = (request) -> {
+    Function<RestRequest, ExtensionRestResponse> deleteHandler = (request) -> {
         return new ExtensionRestResponse(request, RestStatus.OK, "To be implemented");
     };
 }
@@ -248,7 +248,7 @@ return createJsonResponse(request, RestStatus.OK, "_id", response.id());
 Finally, you have the following code:
 
 ```java
-Function<RestRequest, RestResponse> createHandler = (request) -> {
+Function<RestRequest, ExtensionRestResponse> createHandler = (request) -> {
     IndexResponse response;
     try {
         BooleanResponse exists = client.indices().exists(new ExistsRequest.Builder().index("crudsample").build());

DEVELOPER_GUIDE.md

@@ -146,14 +146,14 @@ To **run OpenSearch from a compiled binary**, follow these steps:
 - Start OpenSearch using `./bin/opensearch`.
 - Send the below sample REST API to initialize an extension
 ```bash
-curl -XPOST "localhost:9200/_extensions/initialize" -H "Content-Type:application/json" --data '{
-"name":"hello-world",
-"uniqueId":"hello-world",
-"hostAddress":"127.0.0.1",
-"port":"4532",
-"version":"1.0",
-"opensearchVersion":"3.0.0",
-"minimumCompatibleVersion":"3.0.0",
+curl -XPOST "localhost:9200/_extensions/initialize" -H "Content-Type:application/json" --data '{ \
+"name":"hello-world", \
+"uniqueId":"hello-world", \
+"hostAddress":"127.0.0.1", \
+"port":"4532", \
+"version":"1.0", \
+"opensearchVersion":"3.0.0", \
+"minimumCompatibleVersion":"3.0.0", \
 "dependencies":[{"uniqueId":"test1","version":"2.0.0"},{"uniqueId":"test2","version":"3.0.0"}] \
 }'
 ```
@@ -162,20 +162,18 @@ To **run OpenSearch from Gradle**, follow these steps:
 - Run `./gradlew run` to start OpenSearch.
 - Send the below sample REST API to initialize an extension
 ```bash
-curl -XPOST "localhost:9200/_extensions/initialize" -H "Content-Type:application/json" --data '{
-"name":"hello-world",
-"uniqueId":"hello-world",
-"hostAddress":"127.0.0.1",
-"port":"4532",
-"version":"1.0",
-"opensearchVersion":"3.0.0",
-"minimumCompatibleVersion":"3.0.0",
-"dependencies":[{"uniqueId":"test1","version":"2.0.0"},{"uniqueId":"test2","version":"3.0.0"}]
+curl -XPOST "localhost:9200/_extensions/initialize" -H "Content-Type:application/json" --data '{ \
+"name":"hello-world", \
+"uniqueId":"hello-world", \
+"hostAddress":"127.0.0.1", \
+"port":"4532", \
+"version":"1.0", \
+"opensearchVersion":"3.0.0", \
+"minimumCompatibleVersion":"3.0.0", \
+"dependencies":[{"uniqueId":"test1","version":"2.0.0"},{"uniqueId":"test2","version":"3.0.0"}] \
 }'
 ```
 
-Note: If the Security plugin is initialized in OpenSearch, use admin credentials to send extension initialization request.
-
 In response to the REST `/initialize` request, `ExtensionsManager` discovers the extension listening on a predefined port and executes the TCP handshake protocol to establish a data transfer connection. Then OpenSearch sends a request to the OpenSearch SDK for Java and, upon acknowledgment, the extension responds with its name. This name is logged in the terminal where OpenSearch is running:
 
 ```bash

PLUGIN_MIGRATION.md

@@ -67,38 +67,14 @@ XContentParser parser = XContentType.JSON
 Other potential initialization values are:
 ```java
 this.environmentSettings = extensionsRunner.getEnvironmentSettings();
-this.transportService = extensionsRunner.getSdkTransportService().getTransportService();
+this.transportService = extensionsRunner.getExtensionTransportService();
 this.restClient = anomalyDetectorExtension.getRestClient();
 this.sdkClusterService = new SDKClusterService(extensionsRunner);
 ```
 
 Many of these components are also available via Guice injection.
 
-### Replace `Route` with `NamedRoute`
-Change `routes()` to be NamedRoutes. Here is a sample of an existing route converted to a named route:
-Before:
-```
-public List<Route> routes() {
-    return ImmutableList.of(
-            new Route(GET, "/uri")
-        );
-}
-```
-With new scheme:
-```
-private Function<RestRequest, RestResponse> uriHandler = () -> {};
-public List<NamedRoute> routes() {
-    return ImmutableList.of(
-            new NamedRoute.Builder().method(GET).path("/uri").uniqueName("extension:uri").handler(uriHandler).build()
-        );
-}
-```
-
-You can optionally also add `actionNames()` to this route. These should correspond to any current actions defined as permissions in roles.
-`actionNames()` serve as a valuable tool for converting plugins into extensions while maintaining compatibility with pre-defined reserved roles.
-Ensure that these name-to-route mappings are easily accessible to the cluster admins to allow granting access to these APIs.
-
-Change `prepareRequest()` to `handleRequest()`.
+Optionally, change the `routes()` to `routeHandlers()`. Change `prepareRequest()` to `handleRequest()`.
 
 ### Replace `BytesRestResponse` with `ExtensionRestResponse`
 

build.gradle

@@ -189,18 +189,16 @@ dependencies {
     testRuntimeOnly("org.junit.platform:junit-platform-launcher:${junitPlatform}")
 
     configurations.all {
-        resolutionStrategy {
-            force("jakarta.json:jakarta.json-api:${jakartaVersion}")
-            force("com.fasterxml.jackson.core:jackson-databind:${jacksonDatabindVersion}")
-            force("com.fasterxml.jackson.core:jackson-core:${jacksonDatabindVersion}")
-            force("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:${jacksonDatabindVersion}")
-            force("com.fasterxml.jackson.dataformat:jackson-dataformat-smile:${jacksonDatabindVersion}")
-            force("com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:${jacksonDatabindVersion}")
-            force("org.apache.logging.log4j:log4j-api:${log4jVersion}")
-            force("org.apache.logging.log4j:log4j-core:${log4jVersion}")
-            force("org.apache.logging.log4j:log4j-jul:${log4jVersion}")
-            force("org.slf4j:slf4j-api:${slf4jVersion}")
-        }
+        resolutionStrategy.force("jakarta.json:jakarta.json-api:${jakartaVersion}")
+        resolutionStrategy.force("com.fasterxml.jackson.core:jackson-databind:${jacksonDatabindVersion}")
+        resolutionStrategy.force("com.fasterxml.jackson.core:jackson-core:${jacksonDatabindVersion}")
+        resolutionStrategy.force("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:${jacksonDatabindVersion}")
+        resolutionStrategy.force("com.fasterxml.jackson.dataformat:jackson-dataformat-smile:${jacksonDatabindVersion}")
+        resolutionStrategy.force("com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:${jacksonDatabindVersion}")
+        resolutionStrategy.force("org.apache.logging.log4j:log4j-api:${log4jVersion}")
+        resolutionStrategy.force("org.apache.logging.log4j:log4j-core:${log4jVersion}")
+        resolutionStrategy.force("org.apache.logging.log4j:log4j-jul:${log4jVersion}")
+        resolutionStrategy.force("org.slf4j:slf4j-api:${slf4jVersion}")
     }
 }
 
@@ -324,7 +322,7 @@ task closeTestExtension (type: Exec) {
 tasks.named("integTest").configure { finalizedBy(closeTestExtension) }
 
 testClusters.integTest {
-    extension(true)
+    extension(new ExtensionsProperties("${testExtensionYml.name}", "${testExtensionYml.uniqueId}", "${testExtensionYml.hostAddress}", "${testExtensionYml.port}", "${testExtensionYml.version}", "${testExtensionYml.opensearchVersion}", "${testExtensionYml.minimumCompatibleVersion}"))
     testDistribution = "ARCHIVE"
     // Cluster shrink exception thrown if we try to set numberOfNodes to 1, so only apply if > 1
     if (_numNodes > 1) numberOfNodes = _numNodes

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

@@ -53,7 +53,6 @@ public class ExtensionSettings {
     private String hostPort;
     private String opensearchAddress;
     private String opensearchPort;
-    private Map<String, String> securitySettings;
 
     /**
      * A set of keys for security settings related to SSL transport, keystore and truststore files, and hostname verification.
@@ -84,6 +83,8 @@ public class ExtensionSettings {
         SSL_TRANSPORT_TRUSTSTORE_TYPE
     );
 
+    private Map<String, String> securitySettings;
+
     /**
      * Jackson requires a no-arg constructor.
      */

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

@@ -36,7 +36,6 @@
 import org.opensearch.sdk.handlers.ExtensionsInitRequestHandler;
 import org.opensearch.sdk.handlers.ExtensionsRestRequestHandler;
 import org.opensearch.sdk.handlers.UpdateSettingsRequestHandler;
-import org.opensearch.sdk.rest.BaseExtensionRestHandler;
 import org.opensearch.sdk.rest.ExtensionRestHandler;
 import org.opensearch.sdk.rest.ExtensionRestPathRegistry;
 import org.opensearch.tasks.TaskManager;
@@ -234,9 +233,6 @@ protected ExtensionsRunner(Extension extension) throws IOException {
         if (extension instanceof ActionExtension) {
             // store REST handlers in the registry
             for (ExtensionRestHandler extensionRestHandler : ((ActionExtension) extension).getExtensionRestHandlers()) {
-                if (extensionRestHandler instanceof BaseExtensionRestHandler) {
-                    ((BaseExtensionRestHandler) extensionRestHandler).setExtensionName(extensionSettings.getExtensionName());
-                }
                 extensionRestPathRegistry.registerHandler(extensionRestHandler);
             }
         }