WIP changes.

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

@@ -50,6 +50,7 @@
 import cwms.cda.api.RatingTemplateController;
 import cwms.cda.api.SpecifiedLevelController;
 import cwms.cda.api.StateController;
+import cwms.cda.api.TextTimeSeriesController;
 import cwms.cda.api.TimeSeriesCategoryController;
 import cwms.cda.api.TimeSeriesController;
 import cwms.cda.api.TimeSeriesGroupController;
@@ -130,6 +131,7 @@
         "/auth/*",
         "/swagger-docs",
         "/timeseries/*",
+        "/text-timeseries/*",
         "/offices/*",
         "/states/*",
         "/counties/*",
@@ -395,6 +397,8 @@ protected void configureRoutes() {
                 new PoolController(metrics), requiredRoles,5, TimeUnit.MINUTES);
         cdaCrudCache("/specified-levels/{specified-level-id}",
                 new SpecifiedLevelController(metrics), requiredRoles,5, TimeUnit.MINUTES);
+        cdaCrudCache("/text-timeseries/{ts-id}",
+                new TextTimeSeriesController(metrics), requiredRoles,5, TimeUnit.MINUTES);
     }
 
     /**

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

@@ -0,0 +1,236 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 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;
+
+import static cwms.cda.api.Controllers.CREATE;
+import static cwms.cda.api.Controllers.FAIL_IF_EXISTS;
+import static cwms.cda.api.Controllers.GET_ALL;
+import static cwms.cda.api.Controllers.NOT_SUPPORTED_YET;
+import static cwms.cda.api.Controllers.OFFICE;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.TEMPLATE_ID_MASK;
+import static cwms.cda.api.Controllers.UPDATE;
+import static cwms.cda.data.dao.JooqDao.getDslContext;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import cwms.cda.api.errors.CdaError;
+import cwms.cda.data.dao.TextTimeSeriesDao;
+import cwms.cda.data.dto.TextTimeSeries;
+import cwms.cda.formatters.ContentType;
+import cwms.cda.formatters.Formats;
+import cwms.cda.formatters.json.JsonV2;
+
+import io.javalin.apibuilder.CrudHandler;
+import io.javalin.core.util.Header;
+import io.javalin.http.Context;
+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.OpenApiRequestBody;
+import io.javalin.plugin.openapi.annotations.OpenApiResponse;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.servlet.http.HttpServletResponse;
+import org.jetbrains.annotations.NotNull;
+import org.jooq.DSLContext;
+
+
+public class TextTimeSeriesController implements CrudHandler {
+    private static final Logger logger = Logger.getLogger(TextTimeSeriesController.class.getName());
+    private static final String TAG = "Text-TimeSeries";
+    public static final String TS_ID = "ts-id";
+    public static final String TEXT_TIMESERIES_ID = "text-timeseries-id";
+    private final MetricRegistry metrics;
+
+
+
+    public TextTimeSeriesController(MetricRegistry metrics) {
+        this.metrics = metrics;
+        String className = this.getClass().getName();
+    }
+
+    @NotNull
+    protected TextTimeSeriesDao getDao(DSLContext dsl) {
+        return new TextTimeSeriesDao(dsl);
+    }
+
+
+    private Timer.Context markAndTime(String subject) {
+        return Controllers.markAndTime(metrics, getClass().getName(), subject);
+    }
+
+
+    @OpenApi(
+            queryParams = {
+                    @OpenApiParam(name = OFFICE, description = "Specifies the owning office of "
+                            + "the Text TimeSeries whose data is to be included in the response."
+                            + " If this field is not specified, matching rating information from "
+                            + "all offices shall be returned."),
+                    @OpenApiParam(name = TEMPLATE_ID_MASK, description = "Mask that specifies "
+                            + "the IDs to be included in the response. If this field is not "
+                            + "specified, all text timeseries shall be returned."),
+            },
+            responses = {
+                    @OpenApiResponse(status = STATUS_200,
+                            content = {
+                                    @OpenApiContent(type = Formats.JSONV2, from = TextTimeSeries.class)
+                            }
+                    )},
+            tags = {TAG}
+    )
+    @Override
+    public void getAll(Context ctx) {
+        String office = ctx.queryParam(OFFICE);
+        String templateIdMask = ctx.queryParam(TEMPLATE_ID_MASK);
+
+        String formatHeader = ctx.header(Header.ACCEPT);
+        ContentType contentType = Formats.parseHeaderAndQueryParm(formatHeader, "");
+        try (Timer.Context timeContext = markAndTime(GET_ALL);
+             DSLContext dsl = getDslContext(ctx)) {
+            TextTimeSeriesDao dao = getDao(dsl);
+            List<TextTimeSeries> textTimeSeries = null;  // dao.get(office, templateIdMask);
+
+            ctx.contentType(contentType.toString());
+
+            String result = Formats.format(contentType, textTimeSeries, TextTimeSeries.class);
+            ctx.result(result);
+
+            ctx.status(HttpServletResponse.SC_OK);
+        } catch (Exception ex) {
+            CdaError re =
+                    new CdaError("Failed to process request: " + ex.getLocalizedMessage());
+            logger.log(Level.SEVERE, re.toString(), ex);
+            ctx.status(HttpServletResponse.SC_INTERNAL_SERVER_ERROR).json(re);
+        }
+
+    }
+
+    @OpenApi(ignore = true)
+    @Override
+    public void getOne(Context ctx, String templateId) {
+        throw new UnsupportedOperationException(NOT_SUPPORTED_YET); //To change body of
+        // generated methods, choose Tools | Specs.
+    }
+
+    @OpenApi(
+        description = "Create new TextTimeSeries",
+        requestBody = @OpenApiRequestBody(
+            content = {
+                @OpenApiContent(from = TextTimeSeries.class, type = Formats.JSONV2)
+            },
+            required = true),
+        queryParams = {
+            @OpenApiParam(name = FAIL_IF_EXISTS, type = Boolean.class,
+                description = "Create will fail if provided ID already exists. Default: true")
+        },
+        method = HttpMethod.POST,
+        tags = {TAG}
+    )
+    @Override
+    public void create(Context ctx) {
+        try (Timer.Context ignored = markAndTime(CREATE);
+             DSLContext dsl = getDslContext(ctx)) {
+            String reqContentType = ctx.req.getContentType();
+            String formatHeader = reqContentType != null ? reqContentType : Formats.JSONV2;
+            String body = ctx.body();
+            TextTimeSeries deserialize = deserialize(body, formatHeader);
+            TextTimeSeriesDao dao = getDao(dsl);
+            boolean failIfExists = ctx.queryParamAsClass(FAIL_IF_EXISTS, Boolean.class).getOrDefault(true);
+//            dao.create(deserialize, failIfExists);
+            ctx.status(HttpServletResponse.SC_CREATED);
+        } catch (JsonProcessingException ex) {
+            CdaError re = new CdaError("Failed to process create request");
+            logger.log(Level.SEVERE, re.toString(), ex);
+            ctx.status(HttpServletResponse.SC_INTERNAL_SERVER_ERROR).json(re);
+        }
+    }
+
+    @OpenApi(
+        description = "Renames the requested specified level id",
+        pathParams = {
+            @OpenApiParam(name = TS_ID, description = "The specified level id to be renamed"),
+        },
+        queryParams = {
+            @OpenApiParam(name = OFFICE, required = true, description = "Specifies the "
+                + "owning office of the text timeseries to be renamed"),
+            @OpenApiParam(name = TEXT_TIMESERIES_ID, description = "The new text timeserie id.")
+        },
+        method = HttpMethod.PATCH,
+        tags = {TAG}
+    )
+    @Override
+    public void update(Context ctx, @NotNull String oldTextTimeSeriesId) {
+        try (Timer.Context ignored = markAndTime(UPDATE);
+             DSLContext dsl = getDslContext(ctx)) {
+            TextTimeSeriesDao dao = getDao(dsl);
+            String newTextTimeSeriesId = ctx.queryParam(TEXT_TIMESERIES_ID);
+            String office = ctx.queryParam(OFFICE);
+         //   dao.update(oldTextTimeSeriesId, newTextTimeSeriesId, office);
+            ctx.status(HttpServletResponse.SC_NO_CONTENT);
+        }
+    }
+
+
+
+    @OpenApi(
+        description = "Deletes requested text timeseries id",
+        pathParams = {
+            @OpenApiParam(name = TS_ID, description = "The text timeseries id to be deleted"),
+        },
+        queryParams = {
+            @OpenApiParam(name = OFFICE, required = true, description = "Specifies the "
+                + "owning office of the timeseries identifier to be deleted"),
+        },
+        method = HttpMethod.DELETE,
+        tags = {TAG}
+    )
+    @Override
+    public void delete(Context ctx, String textTimeSeriesId) {
+        try (Timer.Context ignored = markAndTime(UPDATE);
+             DSLContext dsl = getDslContext(ctx)) {
+            TextTimeSeriesDao dao = getDao(dsl);
+            String office = ctx.queryParam(OFFICE);
+      //      dao.delete(textTimeSeriesId, office);
+            ctx.status(HttpServletResponse.SC_NO_CONTENT);
+        }
+    }
+
+    private static TextTimeSeries deserialize(String body, String format) throws JsonProcessingException {
+        TextTimeSeries retval;
+        if (ContentType.equivalent(Formats.JSONV2, format)) {
+            ObjectMapper om = JsonV2.buildObjectMapper();
+            retval = om.readValue(body, TextTimeSeries.class);
+        } else {
+            throw new IllegalArgumentException("Unsupported format: " + format);
+        }
+        return retval;
+    }
+
+}