Add modification query interface

Author: sibmaks

gradle.properties

@@ -7,7 +7,7 @@ jdk_version=17
 author=Simple Mocks
 project_name=api-session
 group=com.github.simple-mocks
-version=0.0.5
+version=0.0.6
 
 # service deps
 lib_api_error_version=0.0.7

src/main/java/com/github/simple_mocks/session/api/ModificationQuery.java

@@ -0,0 +1,18 @@
+package com.github.simple_mocks.session.api;
+
+import com.github.simple_mocks.session.api.dto.action.Action;
+
+import java.util.List;
+
+/**
+ * @author sibmaks
+ * @since 0.0.6
+ */
+public interface ModificationQuery {
+    /**
+     * Get a list of actions for modification
+     *
+     * @return list of actions
+     */
+    List<Action> actions();
+}

src/main/java/com/github/simple_mocks/session/api/ModificationQueryBuilder.java

@@ -0,0 +1,78 @@
+package com.github.simple_mocks.session.api;
+
+import com.github.simple_mocks.session.api.dto.action.Action;
+import com.github.simple_mocks.session.api.dto.action.DeleteAction;
+import com.github.simple_mocks.session.api.dto.action.SetAction;
+import com.github.simple_mocks.session.api.impl.ModificationQueryImpl;
+import jakarta.annotation.Nonnull;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * @author sibmaks
+ * @since 0.0.6
+ */
+public final class ModificationQueryBuilder {
+    private final List<Action> actions;
+
+    private ModificationQueryBuilder(Action action) {
+        this.actions = new ArrayList<>();
+        this.actions.add(action);
+    }
+
+    /**
+     * Create builder instance of {@link ModificationQueryBuilder}
+     *
+     * @param action 1st action
+     * @param <T>    type of action
+     * @return instance of {@link ModificationQueryBuilder}
+     */
+    public static <T extends Action> ModificationQueryBuilder builder(T action) {
+        return new ModificationQueryBuilder(action);
+    }
+
+    /**
+     * Build modification query
+     *
+     * @return instance of {@link ModificationQuery}
+     */
+    public ModificationQuery build() {
+        return new ModificationQueryImpl(Collections.unmodifiableList(actions));
+    }
+
+    /**
+     * Add put attribute value action<br/>
+     *
+     * @param section   section in session
+     * @param attribute attribute code
+     * @param value     attribute value
+     * @param <T>       type of attribute
+     * @return self reference
+     */
+    public <T extends Serializable> ModificationQueryBuilder putAttribute(@Nonnull String section,
+                                                                          @Nonnull String attribute,
+                                                                          T value) {
+        var action = new SetAction(section, attribute, value);
+        this.actions.add(action);
+        return this;
+    }
+
+    /**
+     * Add remove attribute action<br/>
+     *
+     * @param section   section in session
+     * @param attribute attribute code
+     * @return self reference
+     */
+    public ModificationQueryBuilder removeAttribute(@Nonnull String section,
+                                                    @Nonnull String attribute) {
+        var action = new DeleteAction(section, attribute);
+        this.actions.add(action);
+        return this;
+    }
+
+
+}

src/main/java/com/github/simple_mocks/session/api/SessionService.java

@@ -1,12 +1,12 @@
 package com.github.simple_mocks.session.api;
 
 import com.github.simple_mocks.session.api.dto.Session;
-import com.github.simple_mocks.session.api.dto.action.Action;
-import com.github.simple_mocks.session.api.dto.action.DeleteAction;
-import com.github.simple_mocks.session.api.dto.action.SetAction;
+import com.github.simple_mocks.session.api.dto.SessionOwnerType;
+import jakarta.annotation.Nonnull;
 
 import java.io.Serializable;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 /**
@@ -22,7 +22,7 @@ public interface SessionService {
      * @param sessionId session identifier
      * @return session or null
      */
-    Session get(SessionId sessionId);
+    Session get(@Nonnull SessionId sessionId);
 
     /**
      * Get the last version of session common info.<br/>
@@ -31,18 +31,19 @@ public interface SessionService {
      * @param uid session uid
      * @return session or null
      */
-    Session get(String uid);
+    Session get(@Nonnull String uid);
 
     /**
      * Get attribute names from session's section.<br/>
-     * In case if a section not exists when null should be returned.<br/>
+     * In case if a section doesn't exist when null should be returned.<br/>
      * If session isn't found when {@link SessionErrors#NOT_EXISTS} should be thrown.
      *
      * @param sessionId session identifier
      * @param section   section in session
      * @return attribute names
      */
-    Set<String> getAttributeNames(SessionId sessionId, String section);
+    Set<String> getAttributeNames(@Nonnull SessionId sessionId,
+                                  @Nonnull String section);
 
     /**
      * Get attribute value from session.<br/>
@@ -55,53 +56,34 @@ public interface SessionService {
      * @param <T>       type of attribute
      * @return attribute value or null
      */
-    <T extends Serializable> T getAttribute(SessionId sessionId, String section, String attribute);
+    <T extends Serializable> T getAttribute(@Nonnull SessionId sessionId,
+                                            @Nonnull String section,
+                                            @Nonnull String attribute);
 
     /**
-     * Put attribute value into session's section<br/>
-     * If session not found when {@link SessionErrors#NOT_EXISTS} should be thrown.<br/>
-     * If a section is readonly when {@link SessionErrors#READONLY} should be thrown.
+     * Create session with passed data.<br/>
      *
-     * @param sessionId session id
-     * @param section   section in session
-     * @param attribute attribute code
-     * @param value     attribute value
-     * @param <T>       type of attribute
-     * @return new session identifier
-     */
-    default <T extends Serializable> SessionId putAttribute(
-            SessionId sessionId,
-            String section,
-            String attribute,
-            T value) {
-        var action = new SetAction(section, attribute, value);
-        return update(sessionId, List.of(action));
-    }
-
-    /**
-     * Remove attribute value from session<br/>
-     * If session not found when {@link SessionErrors#NOT_EXISTS} should be thrown.<br/>
-     * If a section is readonly when {@link SessionErrors#READONLY} should be thrown.
-     *
-     * @param sessionId session id
-     * @param section   section in session
-     * @param attribute attribute code
+     * @param sections    shared sections data
+     * @param ownerType   session owner type
+     * @param ownerId     session owner id
+     * @param permissions list of user permissions
      * @return new session identifier
      */
-    default SessionId removeAttribute(SessionId sessionId, String section, String attribute) {
-        var action = new DeleteAction(section, attribute);
-        return update(sessionId, List.of(action));
-    }
+    SessionId create(@Nonnull Map<String, Map<String, Serializable>> sections,
+                     @Nonnull SessionOwnerType ownerType,
+                     @Nonnull String ownerId,
+                     @Nonnull List<String> permissions);
 
     /**
      * Update session by applying passed actions.<br/>
      * Method should apply actions transitionally, in case if some action can't be applied session state should be reset.<br/>
      * If session isn't found when {@link SessionErrors#NOT_EXISTS} should be thrown.<br/>
      * If any of sections are readonly when {@link SessionErrors#READONLY} should be thrown.
      *
-     * @param sessionId session id
-     * @param actions   actions
+     * @param sessionId         session id
+     * @param modificationQuery query to modify session
      * @return new session identifier
      */
-    SessionId update(SessionId sessionId, List<? extends Action> actions);
+    SessionId update(@Nonnull SessionId sessionId,
+                     @Nonnull ModificationQuery modificationQuery);
 }

src/main/java/com/github/simple_mocks/session/api/dto/action/Action.java

@@ -13,7 +13,7 @@
  */
 @Getter
 @AllArgsConstructor
-public sealed class Action implements Serializable permits AddAction, DeleteAction, SetAction {
+public abstract sealed class Action implements Serializable permits AddAction, DeleteAction, SetAction {
     /**
      * The name of the section
      */

src/main/java/com/github/simple_mocks/session/api/impl/ModificationQueryImpl.java

@@ -0,0 +1,13 @@
+package com.github.simple_mocks.session.api.impl;
+
+import com.github.simple_mocks.session.api.ModificationQuery;
+import com.github.simple_mocks.session.api.dto.action.Action;
+
+import java.util.List;
+
+/**
+ * @author sibmaks
+ * @since 0.0.6
+ */
+public record ModificationQueryImpl(List<Action> actions) implements ModificationQuery {
+}