Updates sample plugin to conform to spi changes

Signed-off-by: Darshit Chanpura <[email protected]>

Author: DarshitChanpura

sample-resource-plugin/README.md

@@ -19,7 +19,7 @@ plugins.security.system_indices.enabled: true
 
 ## Features
 
-- Create, update, get, delete resources, as well as share and revoke access to a resource.
+- Create, update, get, delete SampleResource, as well as share and revoke access to a resource.
 
 ## Installation
 

sample-resource-plugin/build.gradle

@@ -73,7 +73,7 @@ configurations.all {
 dependencies {
     // Main implementation dependencies
     implementation group: 'org.opensearch', name:'opensearch-security-client', version: "${opensearch_build}"
-    compileOnly "org.opensearch:opensearch-resource-sharing-spi:${opensearch_build}"
+    compileOnly group: 'org.opensearch', name:'opensearch-resource-sharing-spi', version:"${opensearch_build}"
     compileOnly "com.fasterxml.jackson.core:jackson-databind:${versions.jackson_databind}"
 
     // Integration test dependencies

sample-resource-plugin/src/integrationTest/java/org/opensearch/sample/nonsystemindex/plugin/ResourceNonSystemIndexPlugin.java

@@ -14,9 +14,9 @@
 import org.opensearch.plugins.Plugin;
 import org.opensearch.sample.SampleResource;
 import org.opensearch.sample.SampleResourceParser;
-import org.opensearch.security.spi.resources.Resource;
-import org.opensearch.security.spi.resources.ResourceParser;
 import org.opensearch.security.spi.resources.ResourceSharingExtension;
+import org.opensearch.security.spi.resources.ShareableResource;
+import org.opensearch.security.spi.resources.ShareableResourceParser;
 
 /**
  * Sample resource sharing plugin that doesn't declare its resource index as system index.
@@ -38,7 +38,7 @@ public String getResourceIndex() {
     }
 
     @Override
-    public ResourceParser<? extends Resource> getResourceParser() {
+    public ShareableResourceParser<? extends ShareableResource> getShareableResourceParser() {
         return new SampleResourceParser();
     }
 }

sample-resource-plugin/src/main/java/org/opensearch/sample/SampleResource.java

@@ -21,15 +21,15 @@
 import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 
 import static org.opensearch.core.xcontent.ConstructingObjectParser.constructorArg;
 import static org.opensearch.core.xcontent.ConstructingObjectParser.optionalConstructorArg;
 
 /**
  * Sample resource declared by this plugin.
  */
-public class SampleResource implements Resource {
+public class SampleResource implements ShareableResource {
 
     private String name;
     private String description;
@@ -103,7 +103,7 @@ public void setAttributes(Map<String, String> attributes) {
     }
 
     @Override
-    public String getResourceName() {
+    public String getName() {
         return name;
     }
 }

sample-resource-plugin/src/main/java/org/opensearch/sample/SampleResourceParser.java

@@ -14,12 +14,12 @@
 import java.io.IOException;
 
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.security.spi.resources.ResourceParser;
+import org.opensearch.security.spi.resources.ShareableResourceParser;
 
 /**
  * Responsible for parsing the XContent into a SampleResource object.
  */
-public class SampleResourceParser implements ResourceParser<SampleResource> {
+public class SampleResourceParser implements ShareableResourceParser<SampleResource> {
     @Override
     public SampleResource parseXContent(XContentParser parser) throws IOException {
         return SampleResource.fromXContent(parser);

sample-resource-plugin/src/main/java/org/opensearch/sample/SampleResourcePlugin.java

@@ -54,8 +54,8 @@
 import org.opensearch.sample.resource.actions.transport.ShareResourceTransportAction;
 import org.opensearch.sample.resource.actions.transport.UpdateResourceTransportAction;
 import org.opensearch.script.ScriptService;
-import org.opensearch.security.spi.resources.ResourceParser;
 import org.opensearch.security.spi.resources.ResourceSharingExtension;
+import org.opensearch.security.spi.resources.ShareableResourceParser;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.client.Client;
 import org.opensearch.watcher.ResourceWatcherService;
@@ -135,7 +135,7 @@ public String getResourceIndex() {
     }
 
     @Override
-    public ResourceParser<SampleResource> getResourceParser() {
+    public ShareableResourceParser<SampleResource> getShareableResourceParser() {
         return new SampleResourceParser();
     }
 }

sample-resource-plugin/src/main/java/org/opensearch/sample/resource/actions/rest/create/CreateResourceRequest.java

@@ -14,24 +14,24 @@
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 
 /**
  * Request object for CreateSampleResource transport action
  */
 public class CreateResourceRequest extends ActionRequest {
 
-    private final Resource resource;
+    private final ShareableResource resource;
 
     /**
      * Default constructor
      */
-    public CreateResourceRequest(Resource resource) {
+    public CreateResourceRequest(ShareableResource resource) {
         this.resource = resource;
     }
 
     public CreateResourceRequest(StreamInput in) throws IOException {
-        this.resource = in.readNamedWriteable(Resource.class);
+        this.resource = in.readNamedWriteable(ShareableResource.class);
     }
 
     @Override
@@ -44,7 +44,7 @@ public ActionRequestValidationException validate() {
         return null;
     }
 
-    public Resource getResource() {
+    public ShareableResource getResource() {
         return this.resource;
     }
 }

sample-resource-plugin/src/main/java/org/opensearch/sample/resource/actions/rest/create/UpdateResourceRequest.java

@@ -14,27 +14,27 @@
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 
 /**
  * Request object for UpdateResource transport action
  */
 public class UpdateResourceRequest extends ActionRequest {
 
     private final String resourceId;
-    private final Resource resource;
+    private final ShareableResource resource;
 
     /**
      * Default constructor
      */
-    public UpdateResourceRequest(String resourceId, Resource resource) {
+    public UpdateResourceRequest(String resourceId, ShareableResource resource) {
         this.resourceId = resourceId;
         this.resource = resource;
     }
 
     public UpdateResourceRequest(StreamInput in) throws IOException {
         this.resourceId = in.readString();
-        this.resource = in.readNamedWriteable(Resource.class);
+        this.resource = in.readNamedWriteable(ShareableResource.class);
     }
 
     @Override
@@ -48,7 +48,7 @@ public ActionRequestValidationException validate() {
         return null;
     }
 
-    public Resource getResource() {
+    public ShareableResource getResource() {
         return this.resource;
     }
 

sample-resource-plugin/src/main/java/org/opensearch/sample/resource/actions/transport/CreateResourceTransportAction.java

@@ -25,7 +25,7 @@
 import org.opensearch.sample.resource.actions.rest.create.CreateResourceAction;
 import org.opensearch.sample.resource.actions.rest.create.CreateResourceRequest;
 import org.opensearch.sample.resource.actions.rest.create.CreateResourceResponse;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 import org.opensearch.tasks.Task;
 import org.opensearch.transport.TransportService;
 import org.opensearch.transport.client.Client;
@@ -61,7 +61,7 @@ protected void doExecute(Task task, CreateResourceRequest request, ActionListene
     }
 
     private void createResource(CreateResourceRequest request, ActionListener<CreateResourceResponse> listener) {
-        Resource sample = request.getResource();
+        ShareableResource sample = request.getResource();
         try (XContentBuilder builder = jsonBuilder()) {
             IndexRequest ir = nodeClient.prepareIndex(RESOURCE_INDEX_NAME)
                 .setWaitForActiveShards(1)

sample-resource-plugin/src/main/java/org/opensearch/sample/resource/actions/transport/UpdateResourceTransportAction.java

@@ -30,7 +30,7 @@
 import org.opensearch.sample.resource.actions.rest.create.UpdateResourceRequest;
 import org.opensearch.sample.resource.client.ResourceSharingClientAccessor;
 import org.opensearch.security.client.resources.ResourceSharingClient;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 import org.opensearch.security.spi.resources.exceptions.ResourceSharingException;
 import org.opensearch.tasks.Task;
 import org.opensearch.transport.TransportService;
@@ -95,7 +95,7 @@ private void updateResource(UpdateResourceRequest request, ActionListener<Create
         ThreadContext threadContext = this.transportService.getThreadPool().getThreadContext();
         try (ThreadContext.StoredContext ignore = threadContext.stashContext()) {
             String resourceId = request.getResourceId();
-            Resource sample = request.getResource();
+            ShareableResource sample = request.getResource();
             try (XContentBuilder builder = jsonBuilder()) {
                 UpdateRequest ur = new UpdateRequest(RESOURCE_INDEX_NAME, resourceId).setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE)
                     .doc(sample.toXContent(builder, ToXContent.EMPTY_PARAMS));
@@ -112,9 +112,7 @@ private void updateResource(UpdateResourceRequest request, ActionListener<Create
             } catch (IOException e) {
                 listener.onFailure(new RuntimeException(e));
             }
-            listener.onResponse(
-                new CreateResourceResponse("Resource " + request.getResource().getResourceName() + " updated successfully.")
-            );
+            listener.onResponse(new CreateResourceResponse("Resource " + request.getResource().getName() + " updated successfully."));
         } catch (Exception e) {
             log.error("Failed to update resource: {}", request.getResourceId(), e);
             listener.onFailure(e);