Add registration to composite key and use JpaRepository named methods

Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>

Author: Copilot

samples/xapi-server/src/main/java/dev/learning/xapi/samples/xapiserver/StateEntity.java

@@ -32,6 +32,7 @@ public class StateEntity {
   @Id
   private String stateId;
 
+  @Id
   private UUID registration;
 
   @Lob
@@ -176,6 +177,7 @@ public static class StateId implements Serializable {
     private String activityId;
     private String agentJson;
     private String stateId;
+    private UUID registration;
 
     /**
      * StateId Constructor.
@@ -185,10 +187,11 @@ public StateId() {}
     /**
      * StateId Constructor.
      */
-    public StateId(String activityId, String agentJson, String stateId) {
+    public StateId(String activityId, String agentJson, String stateId, UUID registration) {
       this.activityId = activityId;
       this.agentJson = agentJson;
       this.stateId = stateId;
+      this.registration = registration;
     }
 
     @Override
@@ -201,12 +204,13 @@ public boolean equals(Object o) {
       }
       StateId stateId1 = (StateId) o;
       return activityId.equals(stateId1.activityId) && agentJson.equals(stateId1.agentJson)
-          && stateId.equals(stateId1.stateId);
+          && stateId.equals(stateId1.stateId) && registration.equals(stateId1.registration);
     }
 
     @Override
     public int hashCode() {
-      return activityId.hashCode() + agentJson.hashCode() + stateId.hashCode();
+      return activityId.hashCode() + agentJson.hashCode() + stateId.hashCode()
+          + registration.hashCode();
     }
 
     /**
@@ -262,5 +266,23 @@ public String getStateId() {
     public void setStateId(String stateId) {
       this.stateId = stateId;
     }
+
+    /**
+     * Gets the registration.
+     *
+     * @return the registration
+     */
+    public UUID getRegistration() {
+      return registration;
+    }
+
+    /**
+     * Sets the registration.
+     *
+     * @param registration the registration to set
+     */
+    public void setRegistration(UUID registration) {
+      this.registration = registration;
+    }
   }
 }

samples/xapi-server/src/main/java/dev/learning/xapi/samples/xapiserver/StateRepository.java

@@ -7,9 +7,6 @@
 import java.util.List;
 import java.util.UUID;
 import org.springframework.data.jpa.repository.JpaRepository;
-import org.springframework.data.jpa.repository.Modifying;
-import org.springframework.data.jpa.repository.Query;
-import org.springframework.data.repository.query.Param;
 
 /**
  * State Repository.
@@ -19,31 +16,24 @@
 public interface StateRepository extends JpaRepository<StateEntity, StateEntity.StateId> {
 
   /**
-   * Find all stateIds for a given activityId and agent.
+   * Find all StateEntities by activityId, agentJson, and registration.
    *
    * @param activityId the activityId
    * @param agentJson the agent in JSON format
-   * @param registration the registration (nullable)
-   * @return list of stateIds
+   * @param registration the registration
+   * @return list of StateEntities
    */
-  @Query("SELECT s.stateId FROM StateEntity s WHERE s.activityId = :activityId "
-      + "AND s.agentJson = :agentJson "
-      + "AND (:registration IS NULL OR s.registration = :registration)")
-  List<String> findStateIds(@Param("activityId") String activityId,
-      @Param("agentJson") String agentJson, @Param("registration") UUID registration);
+  List<StateEntity> findByActivityIdAndAgentJsonAndRegistration(String activityId,
+      String agentJson, UUID registration);
 
   /**
-   * Delete all states for a given activityId and agent.
+   * Delete all states for a given activityId, agentJson, and registration.
    *
    * @param activityId the activityId
    * @param agentJson the agent in JSON format
-   * @param registration the registration (nullable)
+   * @param registration the registration
    */
-  @Modifying
-  @Query("DELETE FROM StateEntity s WHERE s.activityId = :activityId "
-      + "AND s.agentJson = :agentJson "
-      + "AND (:registration IS NULL OR s.registration = :registration)")
-  void deleteByActivityIdAndAgentJson(@Param("activityId") String activityId,
-      @Param("agentJson") String agentJson, @Param("registration") UUID registration);
+  void deleteByActivityIdAndAgentJsonAndRegistration(String activityId, String agentJson,
+      UUID registration);
 
 }

samples/xapi-server/src/main/java/dev/learning/xapi/samples/xapiserver/StateService.java

@@ -44,7 +44,7 @@ public StateService(StateRepository repository, ObjectMapper mapper) {
    * @param activityId the activityId
    * @param agent the agent
    * @param stateId the stateId
-   * @param registration the registration (nullable)
+   * @param registration the registration
    * @return the state entity or Optional.empty() if not found
    */
   public Optional<StateEntity> getState(String activityId, Agent agent, String stateId,
@@ -54,7 +54,8 @@ public Optional<StateEntity> getState(String activityId, Agent agent, String sta
         stateId, registration);
 
     final String agentJson = serializeAgent(agent);
-    final StateEntity.StateId id = new StateEntity.StateId(activityId, agentJson, stateId);
+    final StateEntity.StateId id =
+        new StateEntity.StateId(activityId, agentJson, stateId, registration);
 
     return repository.findById(id);
   }
@@ -64,7 +65,7 @@ public Optional<StateEntity> getState(String activityId, Agent agent, String sta
    *
    * @param activityId the activityId
    * @param agent the agent
-   * @param registration the registration (nullable)
+   * @param registration the registration
    * @return list of stateIds
    */
   public List<String> getStateIds(String activityId, Agent agent, UUID registration) {
@@ -74,7 +75,10 @@ public List<String> getStateIds(String activityId, Agent agent, UUID registratio
 
     final String agentJson = serializeAgent(agent);
 
-    return repository.findStateIds(activityId, agentJson, registration);
+    return repository
+        .findByActivityIdAndAgentJsonAndRegistration(activityId, agentJson, registration).stream()
+        .map(StateEntity::getStateId)
+        .toList();
   }
 
   /**
@@ -83,7 +87,7 @@ public List<String> getStateIds(String activityId, Agent agent, UUID registratio
    * @param activityId the activityId
    * @param agent the agent
    * @param stateId the stateId
-   * @param registration the registration (nullable)
+   * @param registration the registration
    * @param stateDocument the state document
    * @param contentType the content type
    */
@@ -106,7 +110,7 @@ public void putState(String activityId, Agent agent, String stateId, UUID regist
    * @param activityId the activityId
    * @param agent the agent
    * @param stateId the stateId
-   * @param registration the registration (nullable)
+   * @param registration the registration
    * @param stateDocument the state document to merge
    * @param contentType the content type
    */
@@ -117,7 +121,8 @@ public void postState(String activityId, Agent agent, String stateId, UUID regis
         stateId, registration);
 
     final String agentJson = serializeAgent(agent);
-    final StateEntity.StateId id = new StateEntity.StateId(activityId, agentJson, stateId);
+    final StateEntity.StateId id =
+        new StateEntity.StateId(activityId, agentJson, stateId, registration);
 
     final Optional<StateEntity> existingEntity = repository.findById(id);
 
@@ -144,15 +149,16 @@ public void postState(String activityId, Agent agent, String stateId, UUID regis
    * @param activityId the activityId
    * @param agent the agent
    * @param stateId the stateId
-   * @param registration the registration (nullable)
+   * @param registration the registration
    */
   public void deleteState(String activityId, Agent agent, String stateId, UUID registration) {
 
     log.info("delete state: activityId={}, agent={}, stateId={}, registration={}", activityId,
         agent, stateId, registration);
 
     final String agentJson = serializeAgent(agent);
-    final StateEntity.StateId id = new StateEntity.StateId(activityId, agentJson, stateId);
+    final StateEntity.StateId id =
+        new StateEntity.StateId(activityId, agentJson, stateId, registration);
 
     repository.deleteById(id);
   }
@@ -162,7 +168,7 @@ public void deleteState(String activityId, Agent agent, String stateId, UUID reg
    *
    * @param activityId the activityId
    * @param agent the agent
-   * @param registration the registration (nullable)
+   * @param registration the registration
    */
   @Transactional
   public void deleteStates(String activityId, Agent agent, UUID registration) {
@@ -172,7 +178,7 @@ public void deleteStates(String activityId, Agent agent, UUID registration) {
 
     final String agentJson = serializeAgent(agent);
 
-    repository.deleteByActivityIdAndAgentJson(activityId, agentJson, registration);
+    repository.deleteByActivityIdAndAgentJsonAndRegistration(activityId, agentJson, registration);
   }
 
   private String serializeAgent(Agent agent) {