Adds NamedWriteable implementations

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

server/src/main/java/org/opensearch/accesscontrol/resources/CreatedBy.java

@@ -8,8 +8,12 @@
 
 package org.opensearch.accesscontrol.resources;
 
+import org.opensearch.core.common.io.stream.NamedWriteable;
+import org.opensearch.core.common.io.stream.StreamInput;
+import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.xcontent.ToXContentFragment;
 import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.core.xcontent.XContentParser;
 
 import java.io.IOException;
 
@@ -19,23 +23,16 @@
  *
  * @opensearch.experimental
  */
-public class CreatedBy implements ToXContentFragment {
+public class CreatedBy implements ToXContentFragment, NamedWriteable {
 
     private String user;
 
-    private String backendRole;
-
-    public CreatedBy(String user, String backendRole) {
+    public CreatedBy(String user) {
         this.user = user;
-        this.backendRole = backendRole;
-    }
-
-    public String getBackendRole() {
-        return backendRole;
     }
 
-    public void setBackendRole(String backendRole) {
-        this.backendRole = backendRole;
+    public CreatedBy(StreamInput in) throws IOException {
+        this(in.readString());
     }
 
     public String getUser() {
@@ -48,11 +45,44 @@ public void setUser(String user) {
 
     @Override
     public String toString() {
-        return "CreatedBy {" + "user='" + user + '\'' + ", backendRole='" + backendRole + '\'' + '}';
+        return "CreatedBy {" + "user='" + user + '\'' + '}';
+    }
+
+    @Override
+    public String getWriteableName() {
+        return "created_by";
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        out.writeString(user);
     }
 
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
-        return builder.startObject().field("user", user).field("backend_role", backendRole).endObject();
+        return builder.startObject().field("user", user).endObject();
     }
+
+    public static CreatedBy fromXContent(XContentParser parser) throws IOException {
+        String user = null;
+        String currentFieldName = null;
+        XContentParser.Token token;
+
+        while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
+            if (token == XContentParser.Token.FIELD_NAME) {
+                currentFieldName = parser.currentName();
+            } else if (token == XContentParser.Token.VALUE_STRING) {
+                if ("user".equals(currentFieldName)) {
+                    user = parser.text();
+                }
+            }
+        }
+
+        if (user == null) {
+            throw new IllegalArgumentException("user field is required");
+        }
+
+        return new CreatedBy(user);
+    }
+
 }

server/src/main/java/org/opensearch/accesscontrol/resources/EntityType.java

@@ -15,9 +15,18 @@
  */
 public enum EntityType {
 
-    USERS,
+    USERS("users"),
+    ROLES("roles"),
+    BACKEND_ROLES("backend_roles");
 
-    ROLES,
+    private final String value;
 
-    BACKEND_ROLES,
+    EntityType(String value) {
+        this.value = value;
+    }
+
+    @Override
+    public String toString() {
+        return value;
+    }
 }

server/src/main/java/org/opensearch/accesscontrol/resources/ResourceSharing.java

@@ -8,8 +8,11 @@
 
 package org.opensearch.accesscontrol.resources;
 
+import org.opensearch.core.common.io.stream.NamedWriteable;
+import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.xcontent.ToXContentFragment;
 import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.core.xcontent.XContentParser;
 
 import java.io.IOException;
 import java.util.Objects;
@@ -22,7 +25,7 @@
  *
  * @opensearch.experimental
  */
-public class ResourceSharing implements ToXContentFragment {
+public class ResourceSharing implements ToXContentFragment, NamedWriteable {
 
     private String sourceIdx;
 
@@ -103,6 +106,24 @@ public String toString() {
             + '}';
     }
 
+    @Override
+    public String getWriteableName() {
+        return "resource_sharing";
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        out.writeString(sourceIdx);
+        out.writeString(resourceId);
+        createdBy.writeTo(out);
+        if (shareWith != null) {
+            out.writeBoolean(true);
+            shareWith.writeTo(out);
+        } else {
+            out.writeBoolean(false);
+        }
+    }
+
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         builder.startObject().field("source_idx", sourceIdx).field("resource_id", resourceId).field("created_by");
@@ -113,4 +134,52 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         }
         return builder.endObject();
     }
+
+    public static ResourceSharing fromXContent(XContentParser parser) throws IOException {
+        String sourceIdx = null;
+        String resourceId = null;
+        CreatedBy createdBy = null;
+        ShareWith shareWith = null;
+
+        String currentFieldName = null;
+        XContentParser.Token token;
+
+        while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
+            if (token == XContentParser.Token.FIELD_NAME) {
+                currentFieldName = parser.currentName();
+            } else {
+                switch (Objects.requireNonNull(currentFieldName)) {
+                    case "source_idx":
+                        sourceIdx = parser.text();
+                        break;
+                    case "resource_id":
+                        resourceId = parser.text();
+                        break;
+                    case "created_by":
+                        createdBy = CreatedBy.fromXContent(parser);
+                        break;
+                    case "share_with":
+                        shareWith = ShareWith.fromXContent(parser);
+                        break;
+                    default:
+                        parser.skipChildren();
+                        break;
+                }
+            }
+        }
+
+        // Validate required fields
+        if (sourceIdx == null) {
+            throw new IllegalArgumentException("source_idx is required");
+        }
+        if (resourceId == null) {
+            throw new IllegalArgumentException("resource_id is required");
+        }
+        if (createdBy == null) {
+            throw new IllegalArgumentException("created_by is required");
+        }
+
+        return new ResourceSharing(sourceIdx, resourceId, createdBy, shareWith);
+    }
+
 }

server/src/main/java/org/opensearch/accesscontrol/resources/ShareWith.java

@@ -9,11 +9,14 @@
 package org.opensearch.accesscontrol.resources;
 
 import org.opensearch.core.common.io.stream.NamedWriteable;
+import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.xcontent.ToXContentFragment;
 import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.core.xcontent.XContentParser;
 
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -42,6 +45,10 @@ public ShareWith(List<SharedWithScope> sharedWithScopes) {
         this.sharedWithScopes = sharedWithScopes;
     }
 
+    public ShareWith(StreamInput in) throws IOException {
+        this.sharedWithScopes = in.readList(SharedWithScope::new);
+    }
+
     public List<SharedWithScope> getSharedWithScopes() {
         return sharedWithScopes;
     }
@@ -57,6 +64,26 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         return builder.endObject();
     }
 
+    public static ShareWith fromXContent(XContentParser parser) throws IOException {
+        List<SharedWithScope> sharedWithScopes = new ArrayList<>();
+
+        // Ensure we're at the start of the object
+        if (parser.currentToken() != XContentParser.Token.START_OBJECT) {
+            parser.nextToken();
+        }
+
+        XContentParser.Token token;
+        while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
+            // Each field in the object represents a SharedWithScope
+            if (token == XContentParser.Token.FIELD_NAME) {
+                SharedWithScope scope = SharedWithScope.fromXContent(parser);
+                sharedWithScopes.add(scope);
+            }
+        }
+
+        return new ShareWith(sharedWithScopes);
+    }
+
     @Override
     public String getWriteableName() {
         return "share_with";

server/src/main/java/org/opensearch/accesscontrol/resources/SharedWithScope.java

@@ -9,11 +9,15 @@
 package org.opensearch.accesscontrol.resources;
 
 import org.opensearch.core.common.io.stream.NamedWriteable;
+import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.xcontent.ToXContentFragment;
 import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.core.xcontent.XContentParser;
 
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 /**
@@ -32,6 +36,11 @@ public SharedWithScope(String scope, SharedWithPerScope sharedWithPerScope) {
         this.sharedWithPerScope = sharedWithPerScope;
     }
 
+    public SharedWithScope(StreamInput in) throws IOException {
+        this.scope = in.readString();
+        this.sharedWithPerScope = new SharedWithPerScope(in);
+    }
+
     public String getScope() {
         return scope;
     }
@@ -50,6 +59,16 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         return builder.endObject();
     }
 
+    public static SharedWithScope fromXContent(XContentParser parser) throws IOException {
+        String scope = parser.currentName();
+
+        parser.nextToken();
+
+        SharedWithPerScope sharedWithPerScope = SharedWithPerScope.fromXContent(parser);
+
+        return new SharedWithScope(scope, sharedWithPerScope);
+    }
+
     @Override
     public String toString() {
         return "{" + scope + ": " + sharedWithPerScope + '}';
@@ -72,6 +91,10 @@ public void writeTo(StreamOutput out) throws IOException {
      * @opensearch.experimental
      */
     public static class SharedWithPerScope implements ToXContentFragment, NamedWriteable {
+        private static final String USERS_FIELD = EntityType.USERS.toString();
+        private static final String ROLES_FIELD = EntityType.ROLES.toString();
+        private static final String BACKEND_ROLES_FIELD = EntityType.BACKEND_ROLES.toString();
+
         private List<String> users;
 
         private List<String> roles;
@@ -84,6 +107,12 @@ public SharedWithPerScope(List<String> users, List<String> roles, List<String> b
             this.backendRoles = backendRoles;
         }
 
+        public SharedWithPerScope(StreamInput in) throws IOException {
+            this.users = Arrays.asList(in.readStringArray());
+            this.roles = Arrays.asList(in.readStringArray());
+            this.backendRoles = Arrays.asList(in.readStringArray());
+        }
+
         public List<String> getUsers() {
             return users;
         }
@@ -110,17 +139,61 @@ public void setBackendRoles(List<String> backendRoles) {
 
         @Override
         public String toString() {
-            return "{" + "users=" + users + ", roles=" + roles + ", backendRoles=" + backendRoles + '}';
+            return "{"
+                + USERS_FIELD
+                + "="
+                + users
+                + ", "
+                + ROLES_FIELD
+                + "="
+                + roles
+                + ", "
+                + BACKEND_ROLES_FIELD
+                + "="
+                + backendRoles
+                + '}';
         }
 
         @Override
         public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
-            writeFieldOrEmptyArray(builder, "users", users);
-            writeFieldOrEmptyArray(builder, "roles", roles);
-            writeFieldOrEmptyArray(builder, "backend_roles", backendRoles);
+            writeFieldOrEmptyArray(builder, USERS_FIELD, users);
+            writeFieldOrEmptyArray(builder, ROLES_FIELD, roles);
+            writeFieldOrEmptyArray(builder, BACKEND_ROLES_FIELD, backendRoles);
             return builder;
         }
 
+        public static SharedWithPerScope fromXContent(XContentParser parser) throws IOException {
+            List<String> users = new ArrayList<>();
+            List<String> roles = new ArrayList<>();
+            List<String> backendRoles = new ArrayList<>();
+
+            XContentParser.Token token;
+            String currentFieldName = null;
+            while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
+                if (token == XContentParser.Token.FIELD_NAME) {
+                    currentFieldName = parser.currentName();
+                } else if (token == XContentParser.Token.START_ARRAY) {
+                    if (USERS_FIELD.equals(currentFieldName)) {
+                        while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
+                            users.add(parser.text());
+                        }
+                    } else if (ROLES_FIELD.equals(currentFieldName)) {
+                        while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
+                            roles.add(parser.text());
+                        }
+                    } else if (BACKEND_ROLES_FIELD.equals(currentFieldName)) {
+                        while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
+                            backendRoles.add(parser.text());
+                        }
+                    } else {
+                        parser.skipChildren();
+                    }
+                }
+            }
+
+            return new SharedWithPerScope(users, roles, backendRoles);
+        }
+
         private void writeFieldOrEmptyArray(XContentBuilder builder, String fieldName, List<String> values) throws IOException {
             if (values != null) {
                 builder.field(fieldName, values);