[JXT-3] Validation

README.md

@@ -81,7 +81,20 @@ More methods will be added in future to support other resources and also attachm
 
 ## xAPI Validation
 
-Coming Soon...
+The xAPI model in this library can be used for statement validation using the `jakarta.validation` standard. You can either validate specific parts of a statement using the `jakarta.validation` API directly, or you can use the included helper which takes either a `String` or `Statement` argument and returns a validation object (including the `Statement` object, if valid):
+
+
+```
+String statement = "...";
+StatementValidator validator = new StatementValidator();
+
+// validate by string
+StatementValidationResult result = validator.validateStatement(stmt);
+
+result.isValid(); // boolean
+result.getErrors(); // Set<String> containing the violation messages
+result.getStatement(); // valid Statement object (if isValid() is true)
+```
 
 ## License
 

pom.xml

@@ -4,7 +4,7 @@
   <groupId>com.yetanalytics</groupId>
   <artifactId>xapi-tools</artifactId>
   <packaging>jar</packaging>
-  <version>0.0.4</version>
+  <version>0.0.5</version>
   <name>xAPI Tools</name>
   <description>Java Serialization Model and Tools for xAPI Standard (IEEE 9274.1.1)</description>
   <url>https://github.com/yetanalytics/java-xapi-tools</url>
@@ -53,6 +53,18 @@
       <artifactId>json-path</artifactId>
       <version>2.9.0</version>
     </dependency>
+    <dependency>
+      <groupId>jakarta.validation</groupId>
+      <artifactId>jakarta.validation-api</artifactId>
+      <version>3.1.0</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.bval</groupId>
+      <artifactId>bval-jsr</artifactId>
+      <version>3.0.1</version>
+    </dependency>
+    <!-- Test dependencies -->
+
     <dependency>
       <groupId>jakarta.activation</groupId>
       <artifactId>jakarta.activation-api</artifactId>

src/main/java/com/yetanalytics/xapi/client/filters/StatementFilters.java

@@ -2,7 +2,6 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
-import java.time.LocalDateTime;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.UUID;

src/main/java/com/yetanalytics/xapi/model/AbstractActor.java

@@ -1,9 +1,14 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.net.URI;
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.yetanalytics.xapi.model.deserializers.AbstractActorDeserializer;
+import com.yetanalytics.xapi.validation.MboxUri;
+import com.yetanalytics.xapi.validation.Sha1Sum;
+
+import jakarta.validation.Valid;
 
 /**
 * Abstract Class for serialization and deserialization of xAPI Actors
@@ -13,13 +18,19 @@ public abstract class AbstractActor extends AbstractObject {
 
     private String name;
 
-    //IFI
+    // IFIs
+
+    @MboxUri
     private URI mbox;
-    // TODO: Validate that mbox_sha1sum is a SHA1, 40-char hex string
+    @Sha1Sum
     private String mbox_sha1sum;
+
     private URI openid;
+
+    @Valid
     private Account account;
 
+    // Getters and Setters
     public String getName() {
         return name;
     }
@@ -54,4 +65,33 @@ public Account getAccount() {
     public void setAccount(Account account) {
         this.account = account;
     }
+
+    // Validation
+    protected int countIFIs() {
+        int notNullCount = 0;
+        if (mbox != null) {
+            ++notNullCount;
+        }
+        if (mbox_sha1sum != null) {
+            ++notNullCount;
+        }
+        if (openid != null) {
+            ++notNullCount;
+        }
+        if (account != null) {
+            ++notNullCount;
+        }
+        return notNullCount;
+    }
+
+    public abstract boolean isValidAuthority();
+
+    @Override
+    @JsonIgnore
+    public boolean isEmpty() {
+        return (
+            mbox == null && mbox_sha1sum == null &&
+            openid == null && account == null
+        );
+    }
 }

src/main/java/com/yetanalytics/xapi/model/AbstractObject.java

@@ -1,13 +1,14 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.yetanalytics.xapi.model.deserializers.AbstractObjectDeserializer;
 
 /**
 * Abstract Class for serialization and deserialization of xAPI Objects
 */
 @JsonDeserialize(using = AbstractObjectDeserializer.class)
-public class AbstractObject {
+public abstract class AbstractObject implements JSONObject {
 
     private ObjectType objectType;
 
@@ -18,4 +19,7 @@ public void setObjectType(ObjectType objectType) {
         this.objectType = objectType;
     }
 
+    @Override
+    @JsonIgnore
+    public abstract boolean isEmpty();
 }

src/main/java/com/yetanalytics/xapi/model/Account.java

@@ -1,19 +1,25 @@
 package com.yetanalytics.xapi.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.net.URI;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.NotNull;
+
 /**
 * Class representation of the Account Component of the 
 * <a href="https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#2424-account-object">9274.1.1 xAPI Specification</a>.
 */
 @JsonInclude(Include.NON_NULL)
-public class Account {
-
+public class Account implements JSONObject {
+
+    @NotNull
     private URI homePage;
 
+    @NotNull
     private String name;
 
     public URI getHomePage() {
@@ -29,4 +35,11 @@ public String getName() {
     public void setName(String name) {
         this.name = name;
     }
+
+    @Override
+    @JsonIgnore
+    @AssertFalse(message = "Account must not be empty")
+    public boolean isEmpty() {
+        return homePage == null && name == null;
+    }
 }

src/main/java/com/yetanalytics/xapi/model/Activity.java

@@ -1,20 +1,27 @@
 package com.yetanalytics.xapi.model;
 
-import java.net.URI;
-
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.NotNull;
+import java.net.URI;
+
 /**
 * Class representation of the Activity Object Type of the 
 * <a href="https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#2441-when-the-objecttype-is-activity">9274.1.1 xAPI Specification</a>.
 */
 @JsonInclude(Include.NON_NULL)
 @JsonDeserialize
 public class Activity extends AbstractObject {
+
+    @NotNull
     private URI id;
 
+    @Valid
     private ActivityDefinition definition;
 
     public URI getId() {
@@ -30,4 +37,11 @@ public ActivityDefinition getDefinition() {
     public void setDefinition(ActivityDefinition definition) {
         this.definition = definition;
     }
+
+    @Override
+    @JsonIgnore
+    @AssertFalse(message = "Activity must not be empty")
+    public boolean isEmpty() {
+        return id == null && definition == null;
+    }
 }

src/main/java/com/yetanalytics/xapi/model/ActivityDefinition.java

@@ -3,15 +3,19 @@
 import java.net.URI;
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.AssertTrue;
+
 /**
 * Class representation of the Activity Definition Component of the 
 * <a href="https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#activity-definition">9274.1.1 xAPI Specification</a>.
 */
 @JsonInclude(Include.NON_NULL)
-public class ActivityDefinition {
+public class ActivityDefinition implements JSONObject {
 
     private LangMap name;
     private LangMap description;
@@ -102,4 +106,95 @@ public List<InteractionComponent> getSteps() {
     public void setSteps(List<InteractionComponent> steps) {
         this.steps = steps;
     }
+
+    // Validation
+
+    private boolean isChoices() {
+        return (
+            // choices is allowed
+            scale == null &&
+            source == null &&
+            target == null &&
+            steps == null
+        );
+    }
+
+    private boolean isScale() {
+        return (
+            // scale is allowed
+            choices == null &&
+            source == null &&
+            target == null &&
+            steps == null
+        );
+    }
+
+    private boolean isSourceTarget() {
+        return (
+            // source and target are allowed
+            choices == null &&
+            scale == null &&
+            steps == null
+        );
+    }
+
+    private boolean isSteps() {
+        return (
+            // steps is allowed
+            choices == null &&
+            scale == null &&
+            source == null &&
+            target == null
+        );
+    }
+
+    private boolean isNoInteractionComponents() {
+        return (
+            choices == null &&
+            scale == null &&
+            source == null &&
+            target == null &&
+            steps == null
+        );
+    }
+
+    private boolean isNoInteraction() {
+        return (
+            isNoInteractionComponents() &&
+            correctResponsesPattern == null
+        );
+    }
+
+    @Override
+    @JsonIgnore
+    @AssertFalse(message = "ActivityDefinition must not be empty")
+    public boolean isEmpty() {
+        return (
+            name == null && description == null &&
+            type == null && moreInfo == null && extensions == null &&
+            interactionType == null && isNoInteraction()
+        );
+    }
+
+    @JsonIgnore
+    @AssertTrue(message = "ActivityDefinition must be a valid interaction activity")
+    public boolean isValidInteractionActivity() {
+        if (interactionType == null) {
+            return isNoInteraction();
+        }
+        switch (interactionType) {
+            case CHOICE:
+                return isChoices();
+            case SEQUENCING:
+                return isChoices();
+            case LIKERT:
+                return isScale();
+            case MATCHING:
+                return isSourceTarget();
+            case PERFORMANCE:
+                return isSteps();
+            default:
+                return isNoInteractionComponents();
+        }
+    }
 }

src/main/java/com/yetanalytics/xapi/model/Agent.java

@@ -1,8 +1,12 @@
 package com.yetanalytics.xapi.model;
 
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.AssertTrue;
 
 /**
 * A concrete class representation of the Agent Component of the 
@@ -13,4 +17,28 @@
 @JsonDeserialize
 public class Agent extends AbstractActor {
 
+    // Validation
+
+    @Override
+    @JsonIgnore
+    @AssertFalse(message = "Agent must not be empty")
+    public boolean isEmpty() {
+        return super.isEmpty();
+    }
+
+    /**
+     * Assertion that the Agent has only 1 Inverse Functional Identifier (IFI).
+     * @return true if the Agent has exactly 1 IFI, false otherwise
+     */
+    @JsonIgnore
+    @AssertTrue(message = "Agent must have exactly 1 Inverse Functional Identifier (IFI)")
+    public boolean isIdentifiedAgent() {
+        return countIFIs() == 1;
+    }
+
+    @Override
+    @JsonIgnore
+    public boolean isValidAuthority() {
+        return true;
+    }
 }