I843 CLICS API 2023-06 Endpoint Compliance

.classpath

@@ -64,5 +64,6 @@
 	<classpathentry kind="lib" path="vendor/lib/bcprov-ext-jdk18on-176.jar"/>
 	<classpathentry kind="lib" path="vendor/lib/bcpkix-jdk18on-176.jar"/>
 	<classpathentry kind="lib" path="vendor/lib/bcutil-jdk18on-176.jar"/>
+	<classpathentry kind="lib" path="vendor/lib/jackson-dataformat-yaml-2.5.4.jar"/>
 	<classpathentry kind="output" path=".classes"/>
 </classpath>

pc2v9.ini

@@ -25,4 +25,6 @@ server=localhost:50002
 wtiport=8080
 wtiwsName=/websocket
 
+[clics]
+apiVersionsSupported=2023-06,2020-03
 # eof 

realm.properties

@@ -9,4 +9,8 @@
 # commented out examples:
 # admin: passw0rd,public,admin
 # public: pub1ic,public
-admin: admin,admin
+admin: admin,admin
+team: team,team
+judge: judge,judge
+public: public,public
+analyst: analyst,analyst

samps/pc2v9.ini

@@ -33,4 +33,8 @@ server=localhost:50002
 # use MockContestAdapter as shadow contest API adapter (for testing) 
 # useMockContestAdapter=true
 
+# This is used to populate the API versions available combo box for the event feeder WebServerPane
+[clics]
+apiVersionsSupported=2023-06,2020-03
+
 # eof pc2v9.ini

src/edu/csus/ecs/pc2/services/web/ClarificationService.java → src/edu/csus/ecs/pc2/clics/API202003/ClarificationService.java

@@ -1,5 +1,5 @@
 // Copyright (C) 1989-2024 PC2 Development Team: John Clevenger, Douglas Lane, Samir Ashoo, and Troy Boudreau.
-package edu.csus.ecs.pc2.services.web;
+package edu.csus.ecs.pc2.clics.API202003;
 
 import javax.inject.Singleton;
 import javax.ws.rs.GET;
@@ -21,11 +21,10 @@
 import edu.csus.ecs.pc2.core.model.Clarification;
 import edu.csus.ecs.pc2.core.model.ClarificationAnswer;
 import edu.csus.ecs.pc2.core.model.IInternalContest;
-import edu.csus.ecs.pc2.core.util.JSONTool;
 
 /**
  * WebService to handle languages
- * 
+ *
  * @author ICPC
  *
  */
@@ -51,7 +50,7 @@ public ClarificationService(IInternalContest inContest, IInternalController inCo
     /**
      * This method returns a representation of the current contest groups in JSON format. The returned value is a JSON array with one language description per array element, matching the description
      * at {@link https://clics.ecs.baylor.edu/index.php/Draft_CCS_REST_interface#GET_baseurl.2Flanguages}.
-     * 
+     *
      * @return a {@link Response} object containing the contest languages in JSON form
      */
     @GET
@@ -120,7 +119,7 @@ public Response getClarification(@Context SecurityContext sc, @PathParam("clarif
                         ClarificationAnswer clarificationAnswer = clarAnswers[j];
                         if (clarificationAnswer.getElementId().toString().equals(clarificationId)) {
                             return Response.ok(jsonTool.convertToJSON(clarification, clarificationAnswer).toString(), MediaType.APPLICATION_JSON).build();
-                        }                    
+                        }
                     }
                 }
             }

src/edu/csus/ecs/pc2/services/web/ContestService.java → src/edu/csus/ecs/pc2/clics/API202003/ContestService.java

@@ -1,5 +1,5 @@
-// Copyright (C) 1989-2019 PC2 Development Team: John Clevenger, Douglas Lane, Samir Ashoo, and Troy Boudreau.
-package edu.csus.ecs.pc2.services.web;
+// Copyright (C) 1989-2024 PC2 Development Team: John Clevenger, Douglas Lane, Samir Ashoo, and Troy Boudreau.
+package edu.csus.ecs.pc2.clics.API202003;
 
 import java.io.IOException;
 import java.text.ParseException;
@@ -31,17 +31,16 @@
 import edu.csus.ecs.pc2.core.log.Log;
 import edu.csus.ecs.pc2.core.model.ContestInformation;
 import edu.csus.ecs.pc2.core.model.IInternalContest;
-import edu.csus.ecs.pc2.core.util.JSONTool;
 
 /**
  * WebService to handle "contest" REST endpoint as described by the CLICS wiki.
- * 
+ *
  * example get output: {"id":"7b0dd4ea-19a1-4434-9034-529ebe55ab45", "name":"2014 ICPC World Finals", "formal_name":"38th Annual World Finals of the ACM International Collegiate Programming Contest",
  * "start_time":"2014-06-25T10:00:00+01","duration":"5:00:00","scoreboard_freeze_duration":"1:00:00","penalty_time":20, "state":{"running":true,"frozen":false,"final":false} } example patch request
  * data: {"id":"7b0dd4ea-19a1-4434-9034-529ebe55ab45","start_time":"2014-06-25T10:00:00+01"}
- * 
+ *
  * or {"id":"wf2016","start_time":null}
- * 
+ *
  * @author [email protected]
  *
  */
@@ -59,7 +58,7 @@ public class ContestService implements Feature {
 
     /**
      * List of the possible types of requests which might be received from clients.
-     * 
+     *
      * @author john
      */
     private enum StartTimeRequestType {
@@ -76,9 +75,9 @@ public ContestService(IInternalContest inModel, IInternalController inController
     /**
      * This method resets the current contest scheduled start time according to the received (input) string, which it expects to be in JSON format as described in the CLICS Wiki "StartTime" interface
      * specification.
-     * 
+     *
      * @return a {@link Response} object indicating the status of the setStarttime request as follows (from the CLI Wiki Contest_Start_Interface spec):
-     * 
+     *
      *         <pre>
      *         // PUT HTTP body is application/json:
      *         // { &quot;starttime&quot;:1265335138.26 }
@@ -139,7 +138,7 @@ public Response setStartime(@Context HttpServletRequest servletRequest, @Context
 //            // certainly NOT what PC2 set up as the identifier (Default-###############).  As such, until the
 //            // API endpoints are fixed to include a (configurable) contest identifier, a reasonable thing to
 //            // do at this point is not validate the id at all.  Just make sure one was specified (above).  That's
-//            // enough for now.            
+//            // enough for now.
 //            if (!model.getContestIdentifier().equals(requestMap.get("id"))) {
 //                controller.getLog().log(Log.WARNING, "Starttime PATCH Service: JSON mismatched 'id' key: '" + requestMap.get("id") + "'");
 //                // return HTTP 400 response code per CLICS spec
@@ -288,7 +287,7 @@ public Response setStartime(@Context HttpServletRequest servletRequest, @Context
 
     /**
      * Parses the given String and returns a {@link GregorianCalendar} object if the String represents a valid Unix Epoch date; otherwise returns null.
-     * 
+     *
      * @param startTimeValueString
      *            a String containing a date in ISO 8601 format.
      * @return the GregorianCalendar date/time represented by the String, or null if the String does not represent a valid date/time
@@ -317,10 +316,10 @@ private GregorianCalendar getDate(String startTimeValueString) {
     /**
      * This method updates the Scheduled Start Date for the contest, including causing the scheduling of a "start contest" task for the specified date (which is assumed to be a valid date in the
      * future).
-     * 
+     *
      * This is accomplished by telling the controller to update the {@link ContestInformation} with the scheduled start date. The controller then sends a packet to the server to do that; the server in
      * turn creates a task to start the contest at the specified date/time.
-     * 
+     *
      * @param theDate
      *            the date/time to which the automatic start of the contest should be set, or null if the start date/time should be set to "undefined"
      * @return true if the method was successful in setting the scheduled start time; false otherwise
@@ -347,7 +346,7 @@ private boolean setScheduledStart(GregorianCalendar theDate) {
 
     /**
      * Converts the input string, assumed to be a JSON string, into a {@link Map<String,String>} of JSON key-value pairs.
-     * 
+     *
      * @param jsonRequestString
      *            a JSON string specifying a starttime request in CLICS format
      * @return a Map of the JSON string key-to-value pairs as Strings, or null if the input JSON does not parse as a Map(String->String).
@@ -382,7 +381,7 @@ private Map<String, String> parseJSONIntoMap(String jsonRequestString) {
 
     /**
      * This method returns a representation of the current contest scheduled start time in JSON format as described on the CLICS wiki.
-     * 
+     *
      * @return a {@link Response} object containing a JSON String giving the scheduled contest start time as a Unix Epoch value, or as the string "undefined" if no start time is currently scheduled.
      */
     @GET

src/edu/csus/ecs/pc2/services/web/EventFeedFilter.java → src/edu/csus/ecs/pc2/clics/API202003/EventFeedFilter.java

@@ -1,5 +1,5 @@
 // Copyright (C) 1989-2024 PC2 Development Team: John Clevenger, Douglas Lane, Samir Ashoo, and Troy Boudreau.
-package edu.csus.ecs.pc2.services.web;
+package edu.csus.ecs.pc2.clics.API202003;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -11,7 +11,6 @@
 import edu.csus.ecs.pc2.core.model.Group;
 import edu.csus.ecs.pc2.core.model.IInternalContest;
 import edu.csus.ecs.pc2.core.model.Problem;
-import edu.csus.ecs.pc2.services.core.EventFeedJSON;
 
 /**
  * Event Feed filter.
@@ -262,7 +261,7 @@ public boolean matchesFilter(String string) {
      * @param string JSON string, {"type":"languages", "id":"pc2-11", "op":"create", "data": {"id":"1","name":"Java"}}
      * @return type for event, ex. "languages" as EventFeedType.LANGUAGES.
      */
-    protected EventFeedType getEventFeedType(String string) {
+    public EventFeedType getEventFeedType(String string) {
         // {"type":"languages", "id":"pc2-11", "op":"create", "data": {"id":"1","name":"Java"}}
 
         String typeValue = getCleanValue(string, EF_TYPE_STRING);
@@ -288,7 +287,7 @@ private EventFeedType parseEventFeedType(String typeValue) {
      * @param string ex. {"event":"languages", "id":"pc2-11", "op":"create", "data": {"id":"1","name":"Java"}}
      * @return value for id, ex pc2-11
      */
-    protected String getEventFeedSequence(String string) {
+    public String getEventFeedSequence(String string) {
         // {"event":"languages", "id":"pc2-11", "op":"create", "data": {"id":"1","name":"Java"}}
         String seqVal = getCleanValue(string, EF_SEQ_STRING);
         if(seqVal == null) {