Time Series Profile Controllers

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

@@ -24,8 +24,19 @@
 
 package cwms.cda;
 
-import static cwms.cda.api.Controllers.*;
-import static io.javalin.apibuilder.ApiBuilder.*;
+import static cwms.cda.api.Controllers.CONTRACT_NAME;
+import static cwms.cda.api.Controllers.LOCATION_ID;
+import static cwms.cda.api.Controllers.NAME;
+import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.PROJECT_ID;
+import static cwms.cda.api.Controllers.WATER_USER;
+import static io.javalin.apibuilder.ApiBuilder.crud;
+import static io.javalin.apibuilder.ApiBuilder.delete;
+import static io.javalin.apibuilder.ApiBuilder.get;
+import static io.javalin.apibuilder.ApiBuilder.patch;
+import static io.javalin.apibuilder.ApiBuilder.post;
+import static io.javalin.apibuilder.ApiBuilder.prefixPath;
+import static io.javalin.apibuilder.ApiBuilder.staticInstance;
 import static java.lang.String.format;
 
 import com.codahale.metrics.Meter;
@@ -110,17 +121,14 @@
 import cwms.cda.api.project.ProjectPublishStatusUpdate;
 import cwms.cda.api.project.RemoveAllLockRevokerRights;
 import cwms.cda.api.project.UpdateLockRevokerRights;
-import cwms.cda.api.timeseriesprofile.TimeSeriesProfileBase;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileCatalogController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileCreateController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileDeleteController;
-import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceBase;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceCatalogController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceCreateController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceDeleteController;
-import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserBase;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserCatalogController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserController;
 import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserCreateController;
@@ -508,31 +516,31 @@ protected void configureRoutes() {
         addCacheControl(textBinaryValuePath, 1, TimeUnit.DAYS);
 
         String timeSeriesProfilePath = "/timeseries/profile/";
-        get(format(timeSeriesProfilePath + "{%s}/{%s}", Controllers.LOCATION_ID, TimeSeriesProfileBase.PARAMETER_ID),
+        get(format(timeSeriesProfilePath + "{%s}/{%s}", Controllers.LOCATION_ID, Controllers.PARAMETER_ID),
                 new TimeSeriesProfileController(metrics));
         delete(format(timeSeriesProfilePath + "/{%s}/{%s}", Controllers.LOCATION_ID,
-                    TimeSeriesProfileBase.PARAMETER_ID), new TimeSeriesProfileDeleteController(metrics),
+                        Controllers.PARAMETER_ID), new TimeSeriesProfileDeleteController(metrics),
                 requiredRoles);
-        get(format(timeSeriesProfilePath, Controllers.LOCATION_ID, TimeSeriesProfileBase.PARAMETER_ID),
+        get(format(timeSeriesProfilePath, Controllers.LOCATION_ID, Controllers.PARAMETER_ID),
                 new TimeSeriesProfileCatalogController(metrics));
         post(timeSeriesProfilePath, new TimeSeriesProfileCreateController(metrics), requiredRoles);
 
         String timeSeriesProfileParserPath = "/timeseries/profile-parser/";
         get(format(timeSeriesProfileParserPath + "{%s}/{%s}/", Controllers.LOCATION_ID,
-                TimeSeriesProfileParserBase.PARAMETER_ID), new TimeSeriesProfileParserController(metrics));
+                Controllers.PARAMETER_ID), new TimeSeriesProfileParserController(metrics));
         post(timeSeriesProfileParserPath, new TimeSeriesProfileParserCreateController(metrics), requiredRoles);
         delete(format(timeSeriesProfileParserPath + "{%s}/{%s}/", Controllers.LOCATION_ID,
-                TimeSeriesProfileParserBase.PARAMETER_ID), new TimeSeriesProfileParserDeleteController(metrics),
+                        Controllers.PARAMETER_ID), new TimeSeriesProfileParserDeleteController(metrics),
                 requiredRoles);
         get(timeSeriesProfileParserPath, new TimeSeriesProfileParserCatalogController(metrics));
 
         String timeSeriesProfileInstancePath = "/timeseries/profile-instance/";
         get(format(timeSeriesProfileInstancePath + "{%s}/{%s}/{%s}/", Controllers.LOCATION_ID,
-                TimeSeriesProfileInstanceBase.PARAMETER_ID, Controllers.VERSION),
+                        Controllers.PARAMETER_ID, Controllers.VERSION),
                 new TimeSeriesProfileInstanceController(metrics));
         post(timeSeriesProfileInstancePath, new TimeSeriesProfileInstanceCreateController(metrics), requiredRoles);
         delete(format(timeSeriesProfileInstancePath + "{%s}/{%s}/{%s}/", Controllers.LOCATION_ID,
-                TimeSeriesProfileInstanceBase.PARAMETER_ID, Controllers.VERSION),
+                        Controllers.PARAMETER_ID, Controllers.VERSION),
                 new TimeSeriesProfileInstanceDeleteController(metrics), requiredRoles);
         get(timeSeriesProfileInstancePath, new TimeSeriesProfileInstanceCatalogController(metrics));
 
@@ -905,7 +913,7 @@ private static String getAccessManagerName() {
 
     @Override
     protected void service(HttpServletRequest req, HttpServletResponse resp)
-            throws ServletException, IOException {
+            throws IOException {
         totalRequests.mark();
         try {
             String office = officeFromContext(req.getContextPath());

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

@@ -128,6 +128,12 @@ public final class Controllers {
     public static final String LOCATIONS = "locations";
     public static final String WATER_USER = "water-user";
     public static final String CONTRACT_NAME = "contract-name";
+    public static final String PARAMETER_ID = "parameter-id";
+    public static final String PARAMETER_ID_MASK = "parameter-id-mask";
+    public static final String VERSION_MASK = "version-mask";
+    public static final String PROFILE_DATA = "profile-data";
+    public static final String PREVIOUS = "previous";
+    public static final String NEXT = "next";
 
     public static final String LOCATION_ID = "location-id";
     public static final String SOURCE_ENTITY = "source-entity";

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileBase.java

@@ -32,12 +32,11 @@
 import cwms.cda.data.dao.timeseriesprofile.TimeSeriesProfileDao;
 import org.jooq.DSLContext;
 
-public class TimeSeriesProfileBase {
+public abstract class TimeSeriesProfileBase {
     static final String TAG = "TimeSeries";
-    public static final String PARAMETER_ID = "parameter-id";
     private MetricRegistry metrics;
 
-    TimeSeriesProfileDao getContractDao(DSLContext dsl) {
+    TimeSeriesProfileDao getProfileDao(DSLContext dsl) {
         return new TimeSeriesProfileDao(dsl);
     }
 

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileCatalogController.java

@@ -26,8 +26,14 @@
 
 package cwms.cda.api.timeseriesprofile;
 
-import static cwms.cda.api.Controllers.*;
+import static cwms.cda.api.Controllers.GET_ALL;
+import static cwms.cda.api.Controllers.LOCATION_MASK;
+import static cwms.cda.api.Controllers.OFFICE_MASK;
+import static cwms.cda.api.Controllers.PAGE;
 import static cwms.cda.api.Controllers.PAGE_SIZE;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.STATUS_400;
+import static cwms.cda.api.Controllers.STATUS_404;
 import static cwms.cda.data.dao.JooqDao.getDslContext;
 
 import com.codahale.metrics.MetricRegistry;
@@ -68,14 +74,14 @@ public TimeSeriesProfileCatalogController(MetricRegistry metrics) {
             @OpenApiParam(name = PAGE_SIZE, description = "The page size. Default is 500")
         },
         method = HttpMethod.GET,
-        summary = "Get a time series profile",
+        summary = "Get a catalog of time series profiles",
         tags = {TAG},
         responses = {
             @OpenApiResponse(status = STATUS_200,
                 description = "A TimeSeriesProfile object",
                 content = {
                     @OpenApiContent(from = TimeSeriesProfileList.class, type = Formats.JSONV1),
-                    @OpenApiContent(from = TimeSeriesProfileList.class, type = Formats.XMLV2),
+                    @OpenApiContent(from = TimeSeriesProfileList.class, type = Formats.JSON),
                 }),
             @OpenApiResponse(status = STATUS_400, description = "Invalid input"),
             @OpenApiResponse(status = STATUS_404, description = "No data matching input parameters found")
@@ -85,7 +91,7 @@ public TimeSeriesProfileCatalogController(MetricRegistry metrics) {
     public void handle(@NotNull Context ctx) {
         try (final Timer.Context ignored = markAndTime(GET_ALL)) {
             DSLContext dsl = getDslContext(ctx);
-            TimeSeriesProfileDao tspDao = new TimeSeriesProfileDao(dsl);
+            TimeSeriesProfileDao tspDao = getProfileDao(dsl);
             String officeMask = ctx.queryParamAsClass(OFFICE_MASK, String.class).getOrDefault("*");
             String locationMask = ctx.queryParamAsClass(LOCATION_MASK, String.class).getOrDefault("*");
             String parameterIdMask = ctx.queryParamAsClass(PARAMETER_ID_MASK, String.class).getOrDefault("*");

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileController.java

@@ -29,6 +29,7 @@
 import static cwms.cda.api.Controllers.GET_ONE;
 import static cwms.cda.api.Controllers.LOCATION_ID;
 import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.PARAMETER_ID;
 import static cwms.cda.api.Controllers.STATUS_200;
 import static cwms.cda.api.Controllers.requiredParam;
 import static cwms.cda.data.dao.JooqDao.getDslContext;
@@ -75,7 +76,7 @@ public TimeSeriesProfileController(MetricRegistry metrics) {
                 description = "A TimeSeriesProfileParser object",
                 content = {
                     @OpenApiContent(from = TimeSeriesProfile.class, type = Formats.JSONV1),
-                    @OpenApiContent(from = TimeSeriesProfile.class, type = Formats.XMLV2),
+                    @OpenApiContent(from = TimeSeriesProfile.class, type = Formats.JSON),
                 }),
             @OpenApiResponse(status = "400", description = "Invalid input")
         }
@@ -85,9 +86,9 @@ public void handle(@NotNull Context ctx) {
         try (final Timer.Context ignored = markAndTime(GET_ONE)) {
             DSLContext dsl = getDslContext(ctx);
             String parameterId = ctx.pathParam(PARAMETER_ID);
-            TimeSeriesProfileDao tspDao = new TimeSeriesProfileDao(dsl);
+            TimeSeriesProfileDao tspDao = getProfileDao(dsl);
             String office = requiredParam(ctx, OFFICE);
-            String locationId = requiredParam(ctx, LOCATION_ID);
+            String locationId = ctx.pathParam(LOCATION_ID);
             TimeSeriesProfile returned = tspDao.retrieveTimeSeriesProfile(locationId, parameterId, office);
             String acceptHeader = ctx.header(Header.ACCEPT);
             ContentType contentType = Formats.parseHeader(acceptHeader, TimeSeriesProfile.class);

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileCreateController.java

@@ -74,7 +74,7 @@ public void handle(@NotNull Context ctx) {
             TimeSeriesProfile timeSeriesProfile = Formats.parseContent(Formats.parseHeader(Formats.JSONV1,
                     TimeSeriesProfile.class), ctx.body(), TimeSeriesProfile.class);
             boolean failIfExists = ctx.queryParamAsClass(FAIL_IF_EXISTS, boolean.class).getOrDefault(true);
-            TimeSeriesProfileDao tspDao = new TimeSeriesProfileDao(dsl);
+            TimeSeriesProfileDao tspDao = getProfileDao(dsl);
             tspDao.storeTimeSeriesProfile(timeSeriesProfile, failIfExists);
             ctx.status(HttpServletResponse.SC_CREATED);
         }

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileDeleteController.java

@@ -26,7 +26,15 @@
 
 package cwms.cda.api.timeseriesprofile;
 
-import static cwms.cda.api.Controllers.*;
+import static cwms.cda.api.Controllers.DELETE;
+import static cwms.cda.api.Controllers.LOCATION_ID;
+import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.PARAMETER_ID;
+import static cwms.cda.api.Controllers.STATUS_204;
+import static cwms.cda.api.Controllers.STATUS_400;
+import static cwms.cda.api.Controllers.STATUS_404;
+import static cwms.cda.api.Controllers.STATUS_501;
+import static cwms.cda.api.Controllers.requiredParam;
 import static cwms.cda.data.dao.JooqDao.getDslContext;
 
 import com.codahale.metrics.MetricRegistry;
@@ -55,18 +63,18 @@ public TimeSeriesProfileDeleteController(MetricRegistry metrics) {
             },
             pathParams = {
                 @OpenApiParam(name = LOCATION_ID, description = "The location ID associated with the time "
-                        + "series profile"),
+                    + "series profile"),
                 @OpenApiParam(name = PARAMETER_ID, description = "The key parameter associated with the "
-                        + "time series profile")
+                    + "time series profile")
             },
             method = HttpMethod.DELETE,
-            summary = "Update a time series profile",
+            summary = "Delete a time series profile",
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = STATUS_400, description = "Invalid input"),
-                    @OpenApiResponse(status = STATUS_204, description = "Time series profile deleted"),
-                    @OpenApiResponse(status = STATUS_404, description = "Time series profile not found"),
-                    @OpenApiResponse(status = STATUS_501, description = "Internal server error")
+                @OpenApiResponse(status = STATUS_400, description = "Invalid input"),
+                @OpenApiResponse(status = STATUS_204, description = "Time series profile deleted"),
+                @OpenApiResponse(status = STATUS_404, description = "Time series profile not found"),
+                @OpenApiResponse(status = STATUS_501, description = "Internal server error")
             }
     )
     @Override
@@ -76,7 +84,7 @@ public void handle(@NotNull Context ctx) {
             String keyParameter = ctx.pathParam(PARAMETER_ID);
             String office = requiredParam(ctx, OFFICE);
             String locationId = ctx.pathParam(LOCATION_ID);
-            TimeSeriesProfileDao tspDao = new TimeSeriesProfileDao(dsl);
+            TimeSeriesProfileDao tspDao = getProfileDao(dsl);
             tspDao.deleteTimeSeriesProfile(locationId, keyParameter, office);
             ctx.status(HttpServletResponse.SC_NO_CONTENT);
         }

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileInstanceBase.java

@@ -32,19 +32,11 @@
 import cwms.cda.data.dao.timeseriesprofile.TimeSeriesProfileInstanceDao;
 import org.jooq.DSLContext;
 
-public class TimeSeriesProfileInstanceBase {
+public abstract class TimeSeriesProfileInstanceBase {
     static final String TAG = "TimeSeries";
-    public static final String PARAMETER_ID = "parameter-id";
-    public static final String PARAMETER_ID_MASK = "parameter-id-mask";
-    public static final String VERSION_MASK = "version-mask";
-    public static final String PROFILE_DATA = "profile-data";
-    public static final String START_INCLUSIVE = "start-inclusive";
-    public static final String END_INCLUSIVE = "end-inclusive";
-    public static final String PREVIOUS = "previous";
-    public static final String NEXT = "next";
     private MetricRegistry metrics;
 
-    TimeSeriesProfileInstanceDao getContractDao(DSLContext dsl) {
+    TimeSeriesProfileInstanceDao getProfileInstanceDao(DSLContext dsl) {
         return new TimeSeriesProfileInstanceDao(dsl);
     }
 

cwms-data-api/src/main/java/cwms/cda/api/timeseriesprofile/TimeSeriesProfileInstanceCatalogController.java

@@ -26,8 +26,12 @@
 
 package cwms.cda.api.timeseriesprofile;
 
-import static cwms.cda.api.Controllers.*;
+import static cwms.cda.api.Controllers.GET_ALL;
 import static cwms.cda.api.Controllers.LOCATION_MASK;
+import static cwms.cda.api.Controllers.OFFICE_MASK;
+import static cwms.cda.api.Controllers.PARAMETER_ID_MASK;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.VERSION_MASK;
 import static cwms.cda.data.dao.JooqDao.getDslContext;
 
 import com.codahale.metrics.MetricRegistry;
@@ -67,15 +71,16 @@ public TimeSeriesProfileInstanceCatalogController(MetricRegistry metrics) {
                 + " time series profile instance. Default is *"),
         },
         method = HttpMethod.GET,
-        summary = "Get all time series profile instances. Masks can be provided to filter the results, but are"
-            + "not necessary to get a response.",
+        summary = "Get all time series profile instances that match the provided masks. This endpoint will return a "
+                + "list of time series profile instances without the associated data. Data for an instance can be "
+                + "retrieved using the singular retrieval endpoint.",
         tags = {TAG},
         responses = {
             @OpenApiResponse(status = STATUS_200,
                 description = "A TimeSeriesProfileInstance object",
                 content = {
                     @OpenApiContent(from = TimeSeriesProfileInstance.class, type = Formats.JSONV1),
-                    @OpenApiContent(from = TimeSeriesProfileInstance.class, type = Formats.XMLV2),
+                    @OpenApiContent(from = TimeSeriesProfileInstance.class, type = Formats.JSON),
                 }),
             @OpenApiResponse(status = "400", description = "Invalid input")
         }
@@ -84,7 +89,7 @@ public TimeSeriesProfileInstanceCatalogController(MetricRegistry metrics) {
     public void handle(@NotNull Context ctx) {
         try (final Timer.Context ignored = markAndTime(GET_ALL)) {
             DSLContext dsl = getDslContext(ctx);
-            TimeSeriesProfileInstanceDao tspInstanceDao = new TimeSeriesProfileInstanceDao(dsl);
+            TimeSeriesProfileInstanceDao tspInstanceDao = getProfileInstanceDao(dsl);
             String officeMask = ctx.queryParamAsClass(OFFICE_MASK, String.class).getOrDefault("*");
             String locationMask = ctx.queryParamAsClass(LOCATION_MASK, String.class).getOrDefault("*");
             String parameterIdMask = ctx.queryParamAsClass(PARAMETER_ID_MASK, String.class).getOrDefault("*");