Add violation config to scan requests for partners (#88)

* Add violation config to file/text scan requests

* update action enums

* lint

* tag build as beta release

* make enum public

* doc string

Author: bradleymcallister97

Makefile

@@ -1,7 +1,7 @@
 
 BUILD_DIR=build
 
-VERSION=1.2.2
+VERSION=1.2.3-beta-1
 
 NAME=scan-api
 ARTIFACT=$(NAME)-$(VERSION).jar

README.md

@@ -74,7 +74,7 @@ and then set your API key as an environment variable and run the sample program
 
 ```bash
 export NIGHTFALL_API_KEY="NF-XXXXXX" # replace with your API key
-java -cp build/scan-api-1.2.2.jar ai.nightfall.examples.FileScannerExample /path/to/file
+java -cp build/scan-api-1.2.3-beta-1.jar ai.nightfall.examples.FileScannerExample /path/to/file
 ```
 
 
@@ -116,7 +116,7 @@ then set your API key as an environment variable and run the sample program (cha
 ```bash
 export NIGHTFALL_API_KEY="NF-XXXXXX" # replace with your API key
 NGROK_URL="myurl" # replace with the URL from running ngrok above
-java -cp build/scan-api-1.2.2.jar ai.nightfall.examples.FileScannerExample "$NGROK_URL" /path/to/file
+java -cp build/scan-api-1.2.3-beta-1.jar ai.nightfall.examples.FileScannerExample "$NGROK_URL" /path/to/file
 ```
 
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>ai.nightfall</groupId>
     <artifactId>scan-api</artifactId>
-    <version>1.2.2</version>
+    <version>1.2.3-beta-1</version>
 
     <name>${project.groupId}:${project.artifactId}</name>
     <description>The Nightfall Scanner provides Java bindings for our developer platform, which allows clients

src/main/java/ai/nightfall/scan/model/ScanFileRequest.java

@@ -19,6 +19,9 @@ public class ScanFileRequest {
     @JsonProperty("requestMetadata")
     private String requestMetadata;
 
+    @JsonProperty("violation")
+    private ViolationConfig violationConfig;
+
     /**
      * Create a new request to scan a file.
      *
@@ -30,6 +33,19 @@ public ScanFileRequest(ScanPolicy policy, String requestMetadata) {
         this.requestMetadata = requestMetadata;
     }
 
+    /**
+     * Create a new request to scan a file.
+     *
+     * @param policy the policy to use to scan the file.
+     * @param requestMetadata arbitrary metadata to pass along with the request; maximum length 10 KB.
+     * @param violationConfig the violation configuration to use on the scanned content.
+     */
+    public ScanFileRequest(ScanPolicy policy, String requestMetadata, ViolationConfig violationConfig) {
+        this.policy = policy;
+        this.requestMetadata = requestMetadata;
+        this.violationConfig = violationConfig;
+    }
+
     /**
      * Create a new request to scan a file.
      *
@@ -41,6 +57,19 @@ public ScanFileRequest(UUID policyUUID, String requestMetadata) {
         this.requestMetadata = requestMetadata;
     }
 
+    /**
+     * Create a new request to scan a file.
+     *
+     * @param policyUUID the UUID of an existing policy to use to scan the file.
+     * @param requestMetadata arbitrary metadata to pass along with the request; maximum length 10 KB.
+     * @param violationConfig the violation configuration to use on the scanned content.
+     */
+    public ScanFileRequest(UUID policyUUID, String requestMetadata, ViolationConfig violationConfig) {
+        this.policyUUID = policyUUID;
+        this.requestMetadata = requestMetadata;
+        this.violationConfig = violationConfig;
+    }
+
     /**
      * Get the policy UUID.
      *
@@ -76,4 +105,22 @@ public String getRequestMetadata() {
     public void setRequestMetadata(String requestMetadata) {
         this.requestMetadata = requestMetadata;
     }
+
+    /**
+     * Get the violation config to use when performing a scan.
+     *
+     * @return the violation config.
+     */
+    public ViolationConfig getViolationConfig() {
+        return violationConfig;
+    }
+
+    /**
+     * Set the violation config to use when performing a scan.
+     *
+     * @param violationConfig the violation config.
+     */
+    public void setViolationConfig(ViolationConfig violationConfig) {
+        this.violationConfig = violationConfig;
+    }
 }

src/main/java/ai/nightfall/scan/model/ScanTextRequest.java

@@ -19,6 +19,9 @@ public class ScanTextRequest {
     @JsonProperty("policyUUIDs")
     private List<UUID> policyUUIDs;
 
+    @JsonProperty("violation")
+    private ViolationConfig violationConfig;
+
     /**
      * Create a request to scan the provided <code>payload</code> against the provided scanning
      * <code>policy</code>.
@@ -31,6 +34,20 @@ public ScanTextRequest(List<String> payload, ScanTextConfig policy) {
         this.policy = policy;
     }
 
+    /**
+     * Create a request to scan the provided <code>payload</code> against the provided scanning
+     * <code>policy</code>.
+     *
+     * @param payload the content to scan
+     * @param policy the configuration to use to scan the content
+     * @param violationConfig the violation configuration to use on the scanned content
+     */
+    public ScanTextRequest(List<String> payload, ScanTextConfig policy, ViolationConfig violationConfig) {
+        this.payload = payload;
+        this.policy = policy;
+        this.violationConfig = violationConfig;
+    }
+
     /**
      * Create a request to scan the provided <code>payload</code> against the provided
      * <code>policyUUIDs</code>.
@@ -43,6 +60,20 @@ public ScanTextRequest(List<String> payload, List<UUID> policyUUIDs) {
         this.policyUUIDs = policyUUIDs;
     }
 
+    /**
+     * Create a request to scan the provided <code>payload</code> against the provided
+     * <code>policyUUIDs</code>.
+     *
+     * @param payload the content to scan
+     * @param policyUUIDs a list of UUIDs referring to pre-created policies to-be-used when scanning. Maximum 1.
+     * @param violationConfig the violation configuration to use on the scanned content
+     */
+    public ScanTextRequest(List<String> payload, List<UUID> policyUUIDs, ViolationConfig violationConfig) {
+        this.payload = payload;
+        this.policyUUIDs = policyUUIDs;
+        this.violationConfig = violationConfig;
+    }
+
     /**
      * Get the request payload.
      *
@@ -122,4 +153,22 @@ public List<UUID> getPolicyUUIDs() {
     public void setPolicyUUIDs(List<UUID> policyUUIDs) {
         this.policyUUIDs = policyUUIDs;
     }
+
+    /**
+     * Get the violation config to use when performing a scan.
+     *
+     * @return the violation config.
+     */
+    public ViolationConfig getViolationConfig() {
+        return violationConfig;
+    }
+
+    /**
+     * Set the violation config to use when performing a scan.
+     *
+     * @param violationConfig the violation config.
+     */
+    public void setViolationConfig(ViolationConfig violationConfig) {
+        this.violationConfig = violationConfig;
+    }
 }

src/main/java/ai/nightfall/scan/model/UserViolation.java

@@ -0,0 +1,61 @@
+package ai.nightfall.scan.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * User details associated with a violation.
+ */
+public class UserViolation {
+    @JsonProperty("id")
+    private String id;
+
+    @JsonProperty("displayName")
+    private String displayName;
+
+    /**
+     * Creates a new UserViolation object.
+     *
+     * @param id the id of the user
+     * @param displayName the display name for the user
+     */
+    public UserViolation(String id, String displayName) {
+        this.id = id;
+        this.displayName = displayName;
+    }
+
+    /**
+     * Get the id.
+     *
+     * @return the id of the user
+     */
+    public String getId() {
+        return id;
+    }
+
+    /**
+     * Set the id.
+     *
+     * @param id the id of the user
+     */
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    /**
+     * Get the display name.
+     *
+     * @return the display name of the user
+     */
+    public String getDisplayName() {
+        return displayName;
+    }
+
+    /**
+     * Set the display name.
+     *
+     * @param displayName the display name of the user
+     */
+    public void setDisplayName(String displayName) {
+        this.displayName = displayName;
+    }
+}