Add StatusResponse class to handle successful response messages

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

@@ -45,6 +45,7 @@
 import cwms.cda.data.dao.JooqDao;
 import cwms.cda.data.dao.basinconnectivity.BasinDao;
 import cwms.cda.data.dto.CwmsId;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.data.dto.basinconnectivity.Basin;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
@@ -251,7 +252,8 @@ public void update(@NotNull Context ctx, @NotNull String name) {
             .withOfficeId(officeId)
             .build();
         basinDao.renameBasin(oldLoc, newLoc);
-        ctx.status(HttpServletResponse.SC_OK).json("Updated Location");
+        StatusResponse re = new StatusResponse(officeId, "Updated Location", newBasinId);
+        ctx.status(HttpServletResponse.SC_OK).json(re);
     }
 
     @OpenApi(
@@ -276,21 +278,23 @@ public void create(@NotNull Context ctx) {
         String newBasinId = basin.getBasinId().getName();
         cwms.cda.data.dao.basin.BasinDao basinDao = new cwms.cda.data.dao.basin.BasinDao(dsl);
         basinDao.storeBasin(basin);
-        ctx.status(HttpServletResponse.SC_CREATED).json(newBasinId + " Created");
+        StatusResponse re = new StatusResponse(basin.getBasinId().getOfficeId(),
+                "Basin successfully stored to CWMS.", newBasinId);
+        ctx.status(HttpServletResponse.SC_CREATED).json(re);
     }
 
     @OpenApi(
         queryParams = {
             @OpenApiParam(name = OFFICE, required = true, description = "Specifies the"
-                    + " owning office of the basin to be renamed."),
+                    + " owning office of the basin to be deleted."),
             @OpenApiParam(name = METHOD, required = true, description = "Specifies the delete method used.",
                 type = JooqDao.DeleteMethod.class)
         },
         pathParams = {
             @OpenApiParam(name = NAME, description = "Specifies the name of "
                     + "the basin to be deleted.")
         },
-        description = "Renames CWMS Basin",
+        description = "Deletes CWMS Basin",
         tags = {TAG}
     )
     @Override
@@ -303,6 +307,7 @@ public void delete(@NotNull Context ctx, @NotNull String name) {
                 .withOfficeId(ctx.queryParam(OFFICE))
                 .build();
         basinDao.deleteBasin(basinId, deleteMethod.getRule());
-        ctx.status(HttpServletResponse.SC_NO_CONTENT).json(basinId.getName() + " Deleted");
+        StatusResponse re = new StatusResponse(basinId.getOfficeId(), "Deleted CWMS Basin", basinId.getName());
+        ctx.status(HttpServletResponse.SC_OK).json(re);
     }
 }

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

@@ -29,6 +29,7 @@
 import com.codahale.metrics.Timer;
 import cwms.cda.data.dao.JooqDao;
 import cwms.cda.data.dao.location.kind.EmbankmentDao;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.data.dto.location.kind.Embankment;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
@@ -167,7 +168,9 @@ public void create(Context ctx) {
             DSLContext dsl = getDslContext(ctx);
             EmbankmentDao dao = new EmbankmentDao(dsl);
             dao.storeEmbankment(embankment, failIfExists);
-            ctx.status(HttpServletResponse.SC_CREATED).json("Created Embankment");
+            StatusResponse re = new StatusResponse(embankment.getLocation().getOfficeId(),
+                    "Embankment successfully stored to CWMS", embankment.getLocation().getName());
+            ctx.status(HttpServletResponse.SC_CREATED).json(re);
         }
 
     }
@@ -197,7 +200,8 @@ public void update(@NotNull Context ctx, @NotNull String name) {
             DSLContext dsl = getDslContext(ctx);
             EmbankmentDao dao = new EmbankmentDao(dsl);
             dao.renameEmbankment(office, name, newName);
-            ctx.status(HttpServletResponse.SC_OK).json("Renamed Embankment");
+            StatusResponse re = new StatusResponse(office, "Embankment successfully renamed in CWMS", newName);
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         }
     }
 
@@ -217,7 +221,7 @@ public void update(@NotNull Context ctx, @NotNull String name) {
             method = HttpMethod.DELETE,
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = STATUS_204, description = "Embankment successfully deleted from CWMS."),
+                    @OpenApiResponse(status = STATUS_200, description = "Embankment successfully deleted from CWMS."),
                     @OpenApiResponse(status = STATUS_404, description = "Based on the combination of "
                             + "inputs provided the embankment was not found.")
             }
@@ -231,7 +235,8 @@ public void delete(@NotNull Context ctx, @NotNull String name) {
             DSLContext dsl = getDslContext(ctx);
             EmbankmentDao dao = new EmbankmentDao(dsl);
             dao.deleteEmbankment(name, office, deleteMethod.getRule());
-            ctx.status(HttpServletResponse.SC_NO_CONTENT).json(name + " Deleted");
+            StatusResponse re = new StatusResponse(office, "Embankment successfully deleted from CWMS", name);
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         }
     }
 }

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

@@ -43,6 +43,7 @@
 import cwms.cda.api.enums.UnitSystem;
 import cwms.cda.data.dao.LocationLevelsDao;
 import cwms.cda.data.dao.LocationLevelsDaoImpl;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.data.dto.locationlevel.ConstantLocationLevel;
 import cwms.cda.data.dto.locationlevel.LocationLevel;
 import cwms.cda.data.dto.locationlevel.LocationLevels;
@@ -119,7 +120,8 @@ public void create(@NotNull Context ctx) {
             DSLContext dsl = getDslContext(ctx);
             LocationLevelsDao levelsDao = getLevelsDao(dsl);
             levelsDao.storeLocationLevel(level);
-            ctx.status(HttpServletResponse.SC_CREATED).json("Created Location Level");
+            StatusResponse re = new StatusResponse(level.getOfficeId(),"Created Location Level", level.getLocationLevelId());
+            ctx.status(HttpServletResponse.SC_CREATED).json(re);
         } catch (IOException e) {
             throw new IllegalArgumentException("Unable to parse the request body", e);
         }
@@ -185,7 +187,8 @@ public void delete(@NotNull Context ctx, @NotNull String levelId) {
                     ? DateUtils.parseUserDate(dateString, timezone) : null;
             LocationLevelsDao levelsDao = getLevelsDao(dsl);
             levelsDao.deleteLocationLevel(levelId, unmarshalledDateTime, office, cascadeDelete);
-            ctx.status(HttpServletResponse.SC_OK).json(levelId + " Deleted");
+            StatusResponse re = new StatusResponse(office,"CWMS Location Level Deleted", levelId);
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         }
     }
 
@@ -411,7 +414,8 @@ public void update(@NotNull Context ctx, @NotNull String oldLevelId) {
             if (!oldLevelId.equals(newLevelId)) {
                 //if name changed then delete location with old name
                 levelsDao.renameLocationLevel(oldLevelId, newLevelId, officeId);
-                ctx.status(HttpServletResponse.SC_OK).json("Renamed Location Level");
+                StatusResponse re = new StatusResponse(officeId,"Renamed Location Level", newLevelId);
+                ctx.status(HttpServletResponse.SC_OK).json(re);
             } else {
                 String dateString = queryParamAsClass(ctx,
                     new String[]{EFFECTIVE_DATE, DATE}, String.class, null, metrics,
@@ -432,7 +436,8 @@ public void update(@NotNull Context ctx, @NotNull String oldLevelId) {
                     levelFromBody, unmarshalledDateTime);
 
                 levelsDao.storeLocationLevel(updatedLocationLevel);
-                ctx.status(HttpServletResponse.SC_OK).json("Updated Location Level");
+                StatusResponse re = new StatusResponse(officeId,"Updated Location Level", newLevelId);
+                ctx.status(HttpServletResponse.SC_OK).json(re);
             }
         } catch (JsonProcessingException ex) {
             throw new FormattingException("Failed to format location level update request", ex);

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

@@ -62,6 +62,7 @@
 import cwms.cda.data.dao.LocationsDao;
 import cwms.cda.data.dao.LocationsDaoImpl;
 import cwms.cda.data.dto.Location;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
 import cwms.cda.formatters.UnsupportedFormatException;
@@ -306,7 +307,8 @@ public void create(@NotNull Context ctx) {
             Location locationFromBody = Formats.parseContent(contentType, ctx.body(), Location.class);
             boolean failIfExists = ctx.queryParamAsClass(FAIL_IF_EXISTS, Boolean.class).getOrDefault(true);
             locationsDao.storeLocation(locationFromBody, failIfExists);
-            ctx.status(HttpServletResponse.SC_CREATED).json("Created Location");
+            StatusResponse re = new StatusResponse(locationFromBody.getOfficeId(),"Created Location", locationFromBody.getName());
+            ctx.status(HttpServletResponse.SC_CREATED).json(re);
         } catch (IOException ex) {
             CdaError re = new CdaError("failed to process request");
             logger.log(Level.SEVERE, re.toString(), ex);
@@ -351,10 +353,12 @@ public void update(@NotNull Context ctx, @NotNull String locationId) {
             if (!updatedLocation.getName().equalsIgnoreCase(existingLocation.getName())) {
                 //if name changed then delete location with old name
                 locationsDao.renameLocation(locationId, updatedLocation);
-                ctx.status(HttpServletResponse.SC_OK).json("Updated and renamed Location");
+                ctx.status(HttpServletResponse.SC_OK).json(new StatusResponse(updatedLocation.getOfficeId(),
+                        "Updated and renamed Location", updatedLocation.getName()));
             } else {
                 locationsDao.storeLocation(updatedLocation, false);
-                ctx.status(HttpServletResponse.SC_OK).json("Updated Location");
+                ctx.status(HttpServletResponse.SC_OK).json(new StatusResponse(updatedLocation.getOfficeId(),
+                        "Updated Location", updatedLocation.getName()));
             }
         } catch (NotFoundException e) {
             CdaError re = new CdaError("Not found.");
@@ -386,6 +390,7 @@ public void update(@NotNull Context ctx, @NotNull String locationId) {
             path = "/locations",
             tags = {"Locations"},
             responses = {
+                @OpenApiResponse(status = STATUS_200, description = "Location successfully deleted from CWMS."),
                 @OpenApiResponse(status = STATUS_404, description = "Based on the combination of "
                         + "inputs provided the location was not found.")
             }
@@ -400,7 +405,8 @@ public void delete(@NotNull Context ctx, @NotNull String locationId) {
             LocationsDao locationsDao = getLocationsDao(dsl);
             boolean cascadeDelete = ctx.queryParamAsClass(CASCADE_DELETE, Boolean.class).getOrDefault(false);
             locationsDao.deleteLocation(locationId, office, cascadeDelete);
-            ctx.status(HttpServletResponse.SC_OK).json(locationId + " Deleted");
+            StatusResponse re = new StatusResponse(office,"Deleted CWMS Location", locationId);
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         } catch (DataAccessException ex) {
             SQLException cause = ex.getCause(SQLException.class);
             if (cause != null && cause.getErrorCode() == 20031) {

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

@@ -29,6 +29,7 @@
 import com.codahale.metrics.Timer;
 import cwms.cda.data.dao.LookupTypeDao;
 import cwms.cda.data.dto.LookupType;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
 import io.javalin.apibuilder.CrudHandler;
@@ -138,7 +139,9 @@ public void create(Context ctx) {
             DSLContext dsl = getDslContext(ctx);
             LookupTypeDao dao = new LookupTypeDao(dsl);
             dao.storeLookupType(category, prefix, lookupType);
-            ctx.status(HttpServletResponse.SC_CREATED).json("Created Lookup Type");
+            StatusResponse re = new StatusResponse(lookupType.getOfficeId(), "Lookup Type successfully stored to CWMS.",
+                    lookupType.getDisplayValue());
+            ctx.status(HttpServletResponse.SC_CREATED).json(re);
         }
     }
 
@@ -156,7 +159,7 @@ public void create(Context ctx) {
             method = HttpMethod.PATCH,
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = STATUS_204, description = "Lookup Type successfully stored to CWMS.")
+                    @OpenApiResponse(status = STATUS_200, description = "Updated Lookup Type")
             }
     )
     @Override
@@ -170,7 +173,9 @@ public void update(Context ctx, String name) {
             DSLContext dsl = getDslContext(ctx);
             LookupTypeDao dao = new LookupTypeDao(dsl);
             dao.updateLookupType(category, prefix, lookupType);
-            ctx.status(HttpServletResponse.SC_OK).json("Updated Lookup Type");
+            StatusResponse re = new StatusResponse(lookupType.getOfficeId(), "Updated Lookup Type",
+                    lookupType.getDisplayValue());
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         }
     }
 
@@ -184,7 +189,7 @@ public void update(Context ctx, String name) {
             method = HttpMethod.DELETE,
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = STATUS_204, description = "Lookup Type successfully deleted from CWMS."),
+                    @OpenApiResponse(status = STATUS_200, description = "Lookup Type successfully deleted from CWMS."),
                     @OpenApiResponse(status = STATUS_404, description = "Based on the combination of inputs provided the lookup type was not found.")
             }
     )
@@ -197,7 +202,8 @@ public void delete(Context ctx, @NotNull String displayValue) {
             DSLContext dsl = getDslContext(ctx);
             LookupTypeDao dao = new LookupTypeDao(dsl);
             dao.deleteLookupType(category, prefix, officeId, displayValue);
-            ctx.status(HttpServletResponse.SC_NO_CONTENT).json(displayValue + " Deleted");
+            StatusResponse re = new StatusResponse(officeId, "Lookup Type successfully deleted from CWMS.", displayValue);
+            ctx.status(HttpServletResponse.SC_OK).json(re);
         }
     }
 

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

@@ -49,13 +49,16 @@
 import static cwms.cda.api.Controllers.OFFICE;
 import static cwms.cda.api.Controllers.OFFICE_MASK;
 import static cwms.cda.api.Controllers.QUALITY;
+import static cwms.cda.api.Controllers.STATUS_200;
+import static cwms.cda.api.Controllers.STATUS_404;
 import static cwms.cda.api.Controllers.TIMEZONE;
 import static cwms.cda.api.Controllers.UNIT_SYSTEM;
 import static cwms.cda.api.Controllers.queryParamAsDouble;
 import static cwms.cda.api.Controllers.queryParamAsInstant;
 import static cwms.cda.api.Controllers.requiredParam;
 import cwms.cda.api.enums.UnitSystem;
 import cwms.cda.data.dao.MeasurementDao;
+import cwms.cda.data.dto.StatusResponse;
 import cwms.cda.data.dto.measurement.Measurement;
 import cwms.cda.formatters.ContentType;
 import cwms.cda.formatters.Formats;
@@ -188,7 +191,7 @@ public void getOne(@NotNull Context ctx, @NotNull String locationId) {
             method = HttpMethod.POST,
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = "204", description = "Measurement(s) successfully stored.")
+                    @OpenApiResponse(status = "201", description = "Measurement(s) successfully stored.")
             }
     )
     @Override
@@ -202,12 +205,8 @@ public void create(Context ctx) {
             DSLContext dsl = getDslContext(ctx);
             MeasurementDao dao = new MeasurementDao(dsl);
             dao.storeMeasurements(measurements, failIfExists);
-            String statusMsg = "Created Measurement";
-            if(measurements.size() > 1)
-            {
-                statusMsg += "s";
-            }
-            ctx.status(HttpServletResponse.SC_CREATED).json(statusMsg);
+            StatusResponse re = new StatusResponse(measurements.get(0).getOfficeId(), "Measurement(s) successfully stored.");
+            ctx.status(HttpServletResponse.SC_CREATED).json(re);
         }
     }
 
@@ -245,8 +244,8 @@ public void update(@NotNull Context ctx, @NotNull String locationId) {
             method = HttpMethod.DELETE,
             tags = {TAG},
             responses = {
-                    @OpenApiResponse(status = "204", description = "Measurement successfully deleted."),
-                    @OpenApiResponse(status = "404", description = "Measurement not found.")
+                    @OpenApiResponse(status = STATUS_200, description = "Measurement successfully deleted."),
+                    @OpenApiResponse(status = STATUS_404, description = "Measurement not found.")
             }
     )
     @Override
@@ -260,7 +259,8 @@ public void delete(@NotNull Context ctx, @NotNull String locationId) {
             DSLContext dsl = getDslContext(ctx);
             MeasurementDao dao = new MeasurementDao(dsl);
             dao.deleteMeasurements(officeId, locationId, minDate, maxDate,minNum, maxNum);
-            ctx.status(HttpServletResponse.SC_NO_CONTENT).json( "Measurements for " + locationId + " Deleted");
+            StatusResponse re = new StatusResponse(officeId, "Measurement successfully deleted for specified location-id.", locationId);
+            ctx.status(HttpServletResponse.SC_OK).json( re);
         }
     }