Conforms to SPI file name changes and removes spi package

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

Author: DarshitChanpura

RESOURCE_ACCESS_CONTROL_FOR_PLUGINS.md

@@ -8,7 +8,7 @@ The **Resource Sharing and Access Control** feature in OpenSearch Security Plugi
 - **Super admins** to access all resources.
 - Plugins to **define and manage resource access** via a standardized interface.
 
-This feature ensures **secure** and **controlled** access to resources while leveraging existing **index-level authorization** in OpenSearch.
+This feature ensures **secure** and **controlled** access to shareableResources while leveraging existing **index-level authorization** in OpenSearch.
 
 ---
 
@@ -37,7 +37,7 @@ implementation group: 'org.opensearch', name:'opensearch-security-client', versi
 ```
 - **Declare a `compileOnly` dependency** on `opensearch-resource-sharing-spi` package:
 ```build.gradle
-compileOnly "org.opensearch:opensearch-resource-sharing-spi:${opensearch_build}"
+compileOnly group: 'org.opensearch', name:'opensearch-resource-sharing-spi', version:"${opensearch_build}"
 ```
 - **Extend** `opensearch-security` plugin with optional flag:
 ```build.gradle
@@ -77,7 +77,7 @@ This feature is controlled by the following flag:
 ### **Declaring a Plugin as a Resource Plugin**
 To integrate with the security plugin, your plugin must:
 1. Extend `ResourceSharingExtension` and implement required methods.
-2. Implement the `Resource` interface for resource declaration.
+2. Implement the `ShareableResource` interface for resource declaration.
 3. Implement a resource parser to extract resource details.
 
 [`opensearch-resource-sharing-spi` README.md](./spi/README.md) is a great resource to learn more about the components of SPI and how to set up.
@@ -108,7 +108,7 @@ public class SampleResourcePlugin extends Plugin implements SystemIndexPlugin, R
     }
 
     @Override
-    public ResourceParser<SampleResource> getResourceParser() {
+    public ShareableResourceParser<SampleResource> getShareableResourceParser() {
         return new SampleResourceParser();
     }
 }
@@ -153,7 +153,7 @@ This feature introduces a new **sharing mechanism** called **scopes**. Scopes de
 
 Each plugin must **document its scope definitions** so that users understand the **sharing semantics** and how different scopes affect access control.
 
-Scopes enable **granular access control**, allowing resources to be shared with **customized permission levels**, making the system more flexible and adaptable to different use cases.
+Scopes enable **granular access control**, allowing shareableResources to be shared with **customized permission levels**, making the system more flexible and adaptable to different use cases.
 
 ### **Common Scopes for Plugins to declare**
 | Scope        | Description                                         |
@@ -162,7 +162,7 @@ Scopes enable **granular access control**, allowing resources to be shared with
 | `READ_ONLY` | Users can view but not modify the resource.         |
 | `READ_WRITE` | Users can view and modify the resource.             |
 
-By default, all resources are private and only visible to the owner and super-admins. Resources become accessible to others only when explicitly shared.
+By default, all shareableResources are private and only visible to the owner and super-admins. Resources become accessible to others only when explicitly shared.
 
 SPI provides you an interface, with two default scopes `PUBLIC` and `RESTRICTED`, which can be extended to introduce more plugin-specific values.
 
@@ -451,7 +451,7 @@ Returns an array of accessible resources.
 ---
 
 ## **Conclusion**
-The **Resource Sharing and Access Control** feature enhances OpenSearch security by introducing an **additional layer of fine-grained access management** for plugin-defined resources. While **Fine-Grained Access Control (FGAC)** is already enabled, this feature provides **even more granular control** specifically for **resource-level access** within plugins.
+The **Resource Sharing and Access Control** feature enhances OpenSearch security by introducing an **additional layer of fine-grained access management** for plugin-defined shareableResources. While **Fine-Grained Access Control (FGAC)** is already enabled, this feature provides **even more granular control** specifically for **resource-level access** within plugins.
 
 By implementing the **Service Provider Interface (SPI)**, utilizing the **security client**, and following **best practices**, developers can seamlessly integrate this feature into their plugins to enforce controlled resource sharing and access management.
 

client/README.md

@@ -79,7 +79,7 @@ protected void doExecute(Task task, DeleteResourceRequest request, ActionListene
 
 ## **Available Java APIs**
 
-The **`ResourceSharingClient`** provides **four Java APIs** for **resource access control**, enabling plugins to **verify, share, revoke, and list** resources.
+The **`ResourceSharingClient`** provides **four Java APIs** for **resource access control**, enabling plugins to **verify, share, revoke, and list** shareableResources.
 
 **Package Location:**
 [`org.opensearch.security.client.resources.ResourceSharingClient`](../client/src/main/java/org/opensearch/security/client/resources/ResourceSharingClient.java)
@@ -185,7 +185,7 @@ resourceSharingClient.revokeResourceAccess(
 ---
 
 ### **4. `listAllAccessibleResources`**
-**Retrieves all resources the current user has access to.**
+**Retrieves all shareableResources the current user has access to.**
 
 #### **Method Signature:**
 ```java
@@ -196,16 +196,16 @@ void listAllAccessibleResources(String resourceIndex, ActionListener<Set<? exten
 ```java
 resourceSharingClient.listAllAccessibleResources(
     "resource_index",
-    ActionListener.wrap(resources -> {
-        for (Resource resource : resources) {
+    ActionListener.wrap(shareableResources -> {
+        for (Resource resource : shareableResources) {
             System.out.println("Accessible Resource: " + resource.getId());
         }
     }, e -> {
-        System.err.println("Failed to list accessible resources: " + e.getMessage());
+        System.err.println("Failed to list accessible shareableResources: " + e.getMessage());
     })
 );
 ```
-> **Use Case:** Helps a user identify **which resources they can interact with**.
+> **Use Case:** Helps a user identify **which shareableResources they can interact with**.
 
 ---
 
@@ -214,7 +214,7 @@ These APIs provide essential methods for **fine-grained resource access control*
 
 ✔ **Verification** of resource access.
 ✔ **Granting and revoking** access dynamically.
-✔ **Retrieval** of all accessible resources.
+✔ **Retrieval** of all accessible shareableResources.
 
 For further details, refer to the [`ResourceSharingClient` Java class](../client/src/main/java/org/opensearch/security/client/resources/ResourceSharingClient.java).
 

client/build.gradle

@@ -34,7 +34,7 @@ repositories {
 
 dependencies {
     compileOnly "org.opensearch:opensearch:${opensearch_version}"
-    compileOnly project(path: ":opensearch-resource-sharing-spi")
+    compileOnly group: 'org.opensearch', name:'opensearch-resource-sharing-spi', version:"${opensearch_build}"
     compileOnly project(":")
 }
 

client/src/main/java/org/opensearch/security/client/resources/ResourceSharingClient.java

@@ -12,7 +12,7 @@
 import java.util.Set;
 
 import org.opensearch.core.action.ActionListener;
-import org.opensearch.security.spi.resources.Resource;
+import org.opensearch.security.spi.resources.ShareableResource;
 import org.opensearch.security.spi.resources.sharing.ResourceSharing;
 
 /**
@@ -61,5 +61,5 @@ void revokeResourceAccess(
      * @param resourceIndex The index containing the resources.
      * @param listener The listener to be notified with the set of accessible resources.
      */
-    void listAllAccessibleResources(String resourceIndex, ActionListener<Set<? extends Resource>> listener);
+    void listAllAccessibleResources(String resourceIndex, ActionListener<Set<? extends ShareableResource>> listener);
 }

client/src/main/java/org/opensearch/security/client/resources/ResourceSharingNodeClient.java

@@ -20,7 +20,7 @@
 import org.opensearch.security.resources.rest.ResourceAccessAction;
 import org.opensearch.security.resources.rest.ResourceAccessRequest;
 import org.opensearch.security.resources.rest.ResourceAccessResponse;
-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.security.spi.resources.sharing.ResourceSharing;
 import org.opensearch.security.support.ConfigConstants;
@@ -60,7 +60,7 @@ public ResourceSharingNodeClient(Client client, Settings settings) {
     @Override
     public void verifyResourceAccess(String resourceId, String resourceIndex, Set<String> scopes, ActionListener<Boolean> listener) {
         if (isSecurityDisabled || !resourceSharingEnabled) {
-            String message = isSecurityDisabled ? "Security Plugin is disabled." : "Resource Access Control feature is disabled.";
+            String message = isSecurityDisabled ? "Security Plugin is disabled." : "ShareableResource Access Control feature is disabled.";
 
             log.warn("{} {}", message, "Access to resource is automatically granted");
             listener.onResponse(true);
@@ -133,7 +133,7 @@ public void revokeResourceAccess(
      * @param listener The listener to be notified with the set of accessible resources.
      */
     @Override
-    public void listAllAccessibleResources(String resourceIndex, ActionListener<Set<? extends Resource>> listener) {
+    public void listAllAccessibleResources(String resourceIndex, ActionListener<Set<? extends ShareableResource>> listener) {
         if (isResourceAccessControlOrSecurityPluginDisabled("Unable to list all accessible resources.", listener)) {
             return;
         }