Time Series Profile Controllers

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

@@ -24,19 +24,8 @@
 
 package cwms.cda;
 
-
-import static cwms.cda.api.Controllers.CONTRACT_NAME;
-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 cwms.cda.api.Controllers.*;
+import static io.javalin.apibuilder.ApiBuilder.*;
 import static java.lang.String.format;
 
 import com.codahale.metrics.Meter;
@@ -104,9 +93,9 @@
 import cwms.cda.api.errors.JsonFieldsException;
 import cwms.cda.api.errors.NotFoundException;
 import cwms.cda.api.errors.RequiredQueryParameterException;
+import cwms.cda.api.location.kind.GateChangeCreateController;
 import cwms.cda.api.location.kind.GateChangeDeleteController;
 import cwms.cda.api.location.kind.GateChangeGetAllController;
-import cwms.cda.api.location.kind.GateChangeCreateController;
 import cwms.cda.api.location.kind.OutletController;
 import cwms.cda.api.location.kind.VirtualOutletController;
 import cwms.cda.api.location.kind.VirtualOutletCreateController;
@@ -121,6 +110,18 @@
 import cwms.cda.api.project.ProjectPublishStatusUpdate;
 import cwms.cda.api.project.RemoveAllLockRevokerRights;
 import cwms.cda.api.project.UpdateLockRevokerRights;
+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.TimeSeriesProfileInstanceCatalogController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceCreateController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileInstanceDeleteController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserCatalogController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserCreateController;
+import cwms.cda.api.timeseriesprofile.TimeSeriesProfileParserDeleteController;
 import cwms.cda.api.watersupply.WaterContractCatalogController;
 import cwms.cda.api.watersupply.WaterContractController;
 import cwms.cda.api.watersupply.WaterContractCreateController;
@@ -489,6 +490,35 @@ protected void configureRoutes() {
         get(textBinaryValuePath, new BinaryTimeSeriesValueController(metrics));
         addCacheControl(textBinaryValuePath, 1, TimeUnit.DAYS);
 
+        String timeSeriesProfilePath = "/timeseries/profile/";
+        get(format(timeSeriesProfilePath + "{%s}/{%s}", Controllers.LOCATION_ID, Controllers.PARAMETER_ID),
+                new TimeSeriesProfileController(metrics));
+        delete(format(timeSeriesProfilePath + "/{%s}/{%s}", Controllers.LOCATION_ID,
+                        Controllers.PARAMETER_ID), new TimeSeriesProfileDeleteController(metrics),
+                requiredRoles);
+        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,
+                Controllers.PARAMETER_ID), new TimeSeriesProfileParserController(metrics));
+        post(timeSeriesProfileParserPath, new TimeSeriesProfileParserCreateController(metrics), requiredRoles);
+        delete(format(timeSeriesProfileParserPath + "{%s}/{%s}/", Controllers.LOCATION_ID,
+                        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,
+                        Controllers.PARAMETER_ID, Controllers.VERSION),
+                new TimeSeriesProfileInstanceController(metrics));
+        post(timeSeriesProfileInstancePath, new TimeSeriesProfileInstanceCreateController(metrics), requiredRoles);
+        delete(format(timeSeriesProfileInstancePath + "{%s}/{%s}/{%s}/", Controllers.LOCATION_ID,
+                        Controllers.PARAMETER_ID, Controllers.VERSION),
+                new TimeSeriesProfileInstanceDeleteController(metrics), requiredRoles);
+        get(timeSeriesProfileInstancePath, new TimeSeriesProfileInstanceCatalogController(metrics));
+
         cdaCrudCache("/timeseries/category/{category-id}",
                 new TimeSeriesCategoryController(metrics), requiredRoles,5, TimeUnit.MINUTES);
         cdaCrudCache("/timeseries/identifier-descriptor/{timeseries-id}",
@@ -817,7 +847,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

@@ -88,6 +88,7 @@ public final class Controllers {
     public static final String DATE = "date";
     public static final String LEVEL_ID = "level-id";
     public static final String LEVEL_ID_MASK = "level-id-mask";
+    public static final String LOCATION_MASK = "location-mask";
     public static final String NAME = "name";
     public static final String CASCADE_DELETE = "cascade-delete";
     public static final String DATUM = "datum";
@@ -127,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

@@ -0,0 +1,50 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 Hydrologic Engineering Center
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package cwms.cda.api.timeseriesprofile;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import cwms.cda.api.Controllers;
+import cwms.cda.data.dao.timeseriesprofile.TimeSeriesProfileDao;
+import org.jooq.DSLContext;
+
+public abstract class TimeSeriesProfileBase {
+    static final String TAG = "TimeSeries";
+    private MetricRegistry metrics;
+
+    TimeSeriesProfileDao getProfileDao(DSLContext dsl) {
+        return new TimeSeriesProfileDao(dsl);
+    }
+
+    Timer.Context markAndTime(String subject) {
+        return Controllers.markAndTime(metrics, getClass().getName(), subject);
+    }
+
+    void tspMetrics(MetricRegistry metrics) {
+        this.metrics = metrics;
+    }
+}

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

@@ -0,0 +1,103 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 Hydrologic Engineering Center
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package cwms.cda.api.timeseriesprofile;
+
+import static cwms.cda.api.Controllers.*;
+import static cwms.cda.api.Controllers.PAGE_SIZE;
+import static cwms.cda.data.dao.JooqDao.getDslContext;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import cwms.cda.data.dao.timeseriesprofile.TimeSeriesProfileDao;
+import cwms.cda.data.dto.timeseriesprofile.TimeSeriesProfileList;
+import cwms.cda.formatters.ContentType;
+import cwms.cda.formatters.Formats;
+import io.javalin.core.util.Header;
+import io.javalin.http.Context;
+import io.javalin.http.Handler;
+import io.javalin.plugin.openapi.annotations.HttpMethod;
+import io.javalin.plugin.openapi.annotations.OpenApi;
+import io.javalin.plugin.openapi.annotations.OpenApiContent;
+import io.javalin.plugin.openapi.annotations.OpenApiParam;
+import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import javax.servlet.http.HttpServletResponse;
+import org.jetbrains.annotations.NotNull;
+import org.jooq.DSLContext;
+
+
+public final class TimeSeriesProfileCatalogController extends TimeSeriesProfileBase implements Handler {
+    public static final String PARAMETER_ID_MASK = "parameter-id-mask";
+
+    public TimeSeriesProfileCatalogController(MetricRegistry metrics) {
+        tspMetrics(metrics);
+    }
+
+    @OpenApi(
+        queryParams = {
+            @OpenApiParam(name = OFFICE_MASK, description = "The office mask for the time series profile. "
+                    + "Default is *"),
+            @OpenApiParam(name = LOCATION_MASK, description = "The location mask for the time series profile. "
+                    + "Default is *"),
+            @OpenApiParam(name = PARAMETER_ID_MASK, description = "The key parameter mask for the time series "
+                    + "profile. Default is *"),
+            @OpenApiParam(name = PAGE, description = "The page cursor. Default is null"),
+            @OpenApiParam(name = PAGE_SIZE, description = "The page size. Default is 500")
+        },
+        method = HttpMethod.GET,
+        summary = "Get a time series profile",
+        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),
+                }),
+            @OpenApiResponse(status = STATUS_400, description = "Invalid input"),
+            @OpenApiResponse(status = STATUS_404, description = "No data matching input parameters found")
+        }
+    )
+    @Override
+    public void handle(@NotNull Context ctx) {
+        try (final Timer.Context ignored = markAndTime(GET_ALL)) {
+            DSLContext dsl = getDslContext(ctx);
+            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("*");
+            String cursor = ctx.queryParam(PAGE);
+            int pageSize = ctx.queryParamAsClass(PAGE_SIZE, Integer.class).getOrDefault(500);
+            TimeSeriesProfileList retrievedProfiles = tspDao.catalogTimeSeriesProfiles(locationMask,
+                    parameterIdMask, officeMask, cursor, pageSize);
+            String acceptHeader = ctx.header(Header.ACCEPT);
+            ContentType contentType = Formats.parseHeader(acceptHeader, TimeSeriesProfileList.class);
+            String results = Formats.format(contentType, retrievedProfiles);
+            ctx.status(HttpServletResponse.SC_OK);
+            ctx.result(results);
+        }
+    }
+}

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

@@ -0,0 +1,100 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 Hydrologic Engineering Center
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package cwms.cda.api.timeseriesprofile;
+
+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;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import cwms.cda.data.dao.timeseriesprofile.TimeSeriesProfileDao;
+import cwms.cda.data.dto.timeseriesprofile.TimeSeriesProfile;
+import cwms.cda.formatters.ContentType;
+import cwms.cda.formatters.Formats;
+import io.javalin.core.util.Header;
+import io.javalin.http.Context;
+import io.javalin.http.Handler;
+import io.javalin.plugin.openapi.annotations.HttpMethod;
+import io.javalin.plugin.openapi.annotations.OpenApi;
+import io.javalin.plugin.openapi.annotations.OpenApiContent;
+import io.javalin.plugin.openapi.annotations.OpenApiParam;
+import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import javax.servlet.http.HttpServletResponse;
+import org.jetbrains.annotations.NotNull;
+import org.jooq.DSLContext;
+
+
+public final class TimeSeriesProfileController extends TimeSeriesProfileBase implements Handler {
+    public TimeSeriesProfileController(MetricRegistry metrics) {
+        tspMetrics(metrics);
+    }
+
+    @OpenApi(
+        queryParams = {
+            @OpenApiParam(name = OFFICE, description = "The office ID associated with the time series profile"),
+        },
+        pathParams = {
+            @OpenApiParam(name = PARAMETER_ID, description = "The key parameter ID associated with the time "
+                + "series profile"),
+            @OpenApiParam(name = LOCATION_ID, description = "The location ID associated with the "
+                + "time series profile")
+        },
+        method = HttpMethod.GET,
+        summary = "Get a time series profile",
+        tags = {TAG},
+        responses = {
+            @OpenApiResponse(status = STATUS_200,
+                description = "A TimeSeriesProfileParser object",
+                content = {
+                    @OpenApiContent(from = TimeSeriesProfile.class, type = Formats.JSONV1),
+                    @OpenApiContent(from = TimeSeriesProfile.class, type = Formats.XMLV2),
+                }),
+            @OpenApiResponse(status = "400", description = "Invalid input")
+        }
+    )
+    @Override
+    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 = getProfileDao(dsl);
+            String office = requiredParam(ctx, OFFICE);
+            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);
+            String result = Formats.format(contentType, returned);
+            ctx.status(HttpServletResponse.SC_OK);
+            ctx.result(result);
+        }
+    }
+}