Merge branch 'develop' into cda-gui/review-and-improvements

Author: krowvin

cwms-data-api/src/main/java/cwms/cda/api/LocationController.java

@@ -73,6 +73,9 @@
 
 public class LocationController implements CrudHandler {
     private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+    public static final String LOCATIONS_TAG = "Locations";
+
     private final MetricRegistry metrics;
 
     private final Histogram requestResultSize;
@@ -144,7 +147,7 @@ private Timer.Context markAndTime(String subject) {
             },
             description = "Returns CWMS Location Data.  The Catalog end-point is also capable of "
                     + "retrieving lists of locations and can filter on additional fields.",
-            tags = {"Locations"}
+            tags = {LOCATIONS_TAG}
     )
     @Override
     public void getAll(@NotNull Context ctx) {
@@ -234,7 +237,7 @@ public void getAll(@NotNull Context ctx) {
                         + "inputs provided the location was not found.")
             },
             description = "Returns CWMS Location Data",
-            tags = {"Locations"}
+            tags = {LOCATIONS_TAG}
     )
     @Override
     public void getOne(@NotNull Context ctx, @NotNull String locationId) {
@@ -281,7 +284,7 @@ public void getOne(@NotNull Context ctx, @NotNull String locationId) {
             description = "Create new CWMS Location",
             method = HttpMethod.POST,
             path = "/locations",
-            tags = {"Locations"}
+            tags = {LOCATIONS_TAG}
     )
     @Override
     public void create(@NotNull Context ctx) {
@@ -319,7 +322,7 @@ public void create(@NotNull Context ctx) {
             description = "Update CWMS Location",
             method = HttpMethod.PATCH,
             path = "/locations",
-            tags = {"Locations"},
+            tags = {LOCATIONS_TAG},
             responses = {
                 @OpenApiResponse(status = STATUS_404, description = "Based on the combination of "
                         + "inputs provided the location was not found.")
@@ -377,7 +380,7 @@ public void update(@NotNull Context ctx, @NotNull String locationId) {
             description = "Delete CWMS Location",
             method = HttpMethod.DELETE,
             path = "/locations",
-            tags = {"Locations"},
+            tags = {LOCATIONS_TAG},
             responses = {
                 @OpenApiResponse(status = STATUS_200, description = "Location successfully deleted from CWMS."),
                 @OpenApiResponse(status = STATUS_404, description = "Based on the combination of "

cwms-data-api/src/main/java/cwms/cda/api/VerticalDatumController.java

@@ -59,9 +59,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jooq.DSLContext;
 
+import static cwms.cda.api.LocationController.LOCATIONS_TAG;
+
 public final class VerticalDatumController implements CrudHandler {
 
     private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+    // NOTE: manually expanded due to limits of OpenApi Annotations.
+    private static final String VDI_PATH = "/location/{location-id}/vertical-datum";
     private final MetricRegistry metrics;
     private final Histogram requestResultSize;
 
@@ -96,7 +100,8 @@ public void getAll(@NotNull Context ctx) {
                                        @OpenApiContent(type = Formats.XML, from = VerticalDatumInfo.class)})
             },
             description = "Returns Vertical Datum Info for the specified location.",
-            tags = {"Locations"}
+            path = VDI_PATH,
+            tags = {LOCATIONS_TAG}
     )
     @Override
     public void getOne(@NotNull Context ctx, @NotNull String locationId) {
@@ -129,7 +134,8 @@ public void getOne(@NotNull Context ctx, @NotNull String locationId) {
             },
             description = "Create Vertical Datum Info for a Location",
             method = HttpMethod.POST,
-            tags = {"Locations"},
+            path = VDI_PATH,
+            tags = {LOCATIONS_TAG},
             responses = {
                     @OpenApiResponse(status = Controllers.STATUS_201, description = "Vertical Datum Info successfully stored to CWMS.")
             }
@@ -173,7 +179,8 @@ public void create(@NotNull Context ctx) {
             },
             description = "Update Vertical Datum Info for a Location",
             method = HttpMethod.PATCH,
-            tags = {"Locations"},
+            path = VDI_PATH,
+            tags = {LOCATIONS_TAG},
             responses = {
                     @OpenApiResponse(status = Controllers.STATUS_200, description = "Updated Vertical Datum Info")
             }
@@ -207,7 +214,8 @@ public void update(@NotNull Context ctx, @NotNull String locationId) {
             },
             description = "Delete Vertical Datum Info for a Location",
             method = HttpMethod.DELETE,
-            tags = {"Locations"},
+            path = VDI_PATH,
+            tags = {LOCATIONS_TAG},
             responses = {
                     @OpenApiResponse(status = Controllers.STATUS_200, description = "Vertical Datum Info successfully deleted from CWMS."),
                     @OpenApiResponse(status = Controllers.STATUS_404, description = "Vertical Datum Info not found.")

cwms-data-api/src/main/java/cwms/cda/api/enums/MessageQueue.java

@@ -0,0 +1,42 @@
+package cwms.cda.api.enums;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(
+    name = "Message Queue",
+    description = "Desired set of status messages. Must be one of the named options."
+                + " Letter casing is ignored."
+)
+public enum MessageQueue {
+    TS_STORED("TS_STORED", " CWMS messages about time series operations, such as data stored and deleted"),
+    STATUS("STATUS", " CWMS general system and application status messages"),
+    REALTIME_OPS("REALTIME_OPS", " CWMS application operational messages");
+
+    private String queue;
+    private String description;
+
+    MessageQueue(String queue, String description) {
+        this.queue = queue;
+        this.description = description;
+    }
+
+    public String value() {
+        return queue;
+    }
+
+    public String description() {
+        return description;
+    }
+
+    public static MessageQueue queueFor(String queue) {
+        if (TS_STORED.value().equalsIgnoreCase(queue)) {
+            return TS_STORED;
+        } else if (STATUS.value().equalsIgnoreCase(queue)) {
+            return STATUS;
+        } else if (REALTIME_OPS.value().equalsIgnoreCase(queue)) {
+            return REALTIME_OPS;
+        } else {
+            return null;
+        }
+    }
+}

cwms-data-api/src/main/java/cwms/cda/api/rss/RssHandler.java

@@ -30,6 +30,7 @@
 import com.codahale.metrics.MetricRegistry;
 import com.codahale.metrics.Timer;
 import cwms.cda.api.BaseHandler;
+import cwms.cda.api.enums.MessageQueue;
 import cwms.cda.api.errors.CdaError;
 import cwms.cda.data.dao.rss.MessageDao;
 import cwms.cda.data.dto.CwmsDTOPaginated;
@@ -66,7 +67,9 @@ public RssHandler(MetricRegistry metrics) {
     @OpenApi(
         pathParams = {
             @OpenApiParam(name = OFFICE, required = true, description = "Office id for feed."),
-            @OpenApiParam(name = NAME, required = true, description = "Specifies the name of the feed. " +
+            @OpenApiParam(name = NAME, required = true,
+                type = MessageQueue.class,
+                description = "Specifies the name of the feed. " +
                 "eg TS_STORED, STATUS, REALTIME_OPS")
         },
         queryParams = {

cwms-data-api/src/main/java/cwms/cda/data/dao/rss/AqTable.java

@@ -33,6 +33,7 @@
 import static org.jooq.impl.DSL.select;
 import static org.jooq.impl.DSL.table;
 
+import cwms.cda.api.enums.MessageQueue;
 import cwms.cda.api.errors.NotFoundException;
 import cwms.cda.data.dao.JooqDao;
 import cwms.cda.data.dto.CwmsDTOPaginated;
@@ -44,7 +45,6 @@
 import java.time.Instant;
 import java.time.ZoneOffset;
 import java.time.ZonedDateTime;
-import java.time.temporal.ChronoUnit;
 import java.util.Optional;
 import java.util.function.UnaryOperator;
 import org.jooq.DSLContext;
@@ -62,7 +62,7 @@ public MessageDao(DSLContext dsl) {
 
     public RssFeed retrieveFeed(String cursor, int pageSize, String office, String name,
         Instant since, UnaryOperator<String> urlBuilder) {
-        AqTable aqTable = getAqTable(name);
+        MessageQueue aqTable = getAqTable(name);
         String[] cursorSplit = CwmsDTOPaginated.decodeCursor(cursor);
         int offset = 0;
         if(cursorSplit.length == 2) {
@@ -83,30 +83,18 @@ public RssFeed retrieveFeed(String cursor, int pageSize, String office, String n
             String nextCursor = CwmsDTOPaginated.encodeCursor(items.size() + offset, pageSize);
             nextLink = new AtomLink("next", urlBuilder.apply(nextCursor));
         }
-        String description;
-        switch(aqTable) {
-            case TS_STORED:
-                description = " CWMS messages about time series operations, such as data stored and deleted";
-                break;
-            case STATUS:
-                description = " CWMS general system and application status messages";
-                break;
-            case REALTIME_OPS:
-                description = " CWMS application operational messages";
-                break;
-            default:
-                description = null;
-        }
+        String description = aqTable.description();
         RssChannel channel = new RssChannel(name, nextLink, description, items);
         return new RssFeed(channel);
     }
 
-    private static AqTable getAqTable(String name) {
-        try {
-            return AqTable.valueOf(name.toUpperCase());
-        } catch (IllegalArgumentException e) {
-            throw new NotFoundException(e);
+    @SuppressWarnings("unused") // MessageQueue.valueOf can return null. environment is being over zealous.
+    private static MessageQueue getAqTable(String name) {
+        MessageQueue ret = MessageQueue.queueFor(name.toUpperCase());
+        if (ret == null) {
+            throw new NotFoundException("No queue named '" + name + "'");
         }
+        return ret;
     }
 
     private static RssItem rssItem(Record record, String p) {
@@ -116,7 +104,7 @@ private static RssItem rssItem(Record record, String p) {
         return new RssItem(p, enqTimestamp, msgId);
     }
 
-    private Result<?> retrieveMessages(int offset, int pageSize, Instant since, String office, AqTable name) {
+    private Result<?> retrieveMessages(int offset, int pageSize, Instant since, String office, MessageQueue name) {
         Timestamp sinceTimestamp = since == null ? null : Timestamp.from(since);
         Table<?> t = table(name("CWMS_20", "AQ$" + office + "_" + name.name() + "_TABLE")).as("t");
 

cwms-data-api/src/main/java/cwms/cda/data/dao/rss/MessageDao.java

@@ -37,6 +37,7 @@
 
 import com.google.common.flogger.FluentLogger;
 import cwms.cda.api.DataApiTestIT;
+import cwms.cda.api.enums.MessageQueue;
 import cwms.cda.formatters.Formats;
 import fixtures.CwmsDataApiSetupCallback;
 import fixtures.TestAccounts;
@@ -89,7 +90,7 @@ void test_rss_feed_with_pagination() {
         .when()
             .redirects().follow(true)
             .redirects().max(3)
-            .get("/rss/" + OFFICE_ID + "/status")
+            .get("/rss/{office}/{name}", OFFICE_ID, MessageQueue.STATUS.value())
         .then()
             .log().ifValidationFails(LogDetail.ALL, true)
         .assertThat()
@@ -157,7 +158,7 @@ void test_rss_feed_unknown_queue() {
         .when()
             .redirects().follow(true)
             .redirects().max(3)
-            .get("/rss/" + OFFICE_ID + "/answering-machine")
+            .get("/rss/{office}/{name}", OFFICE_ID, "answering-machine")
         .then()
             .log().ifValidationFails(LogDetail.ALL, true)
         .assertThat()