FINERACT-2169: Replace String json to DTO in FloatingRatesApiResource - fixed

fineract-rates/src/main/java/org/apache/fineract/portfolio/floatingrates/api/FloatingRatesApiResource.java

@@ -34,9 +34,7 @@ import jakarta.ws.rs.PUT;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
-import jakarta.ws.rs.core.Context;
 import jakarta.ws.rs.core.MediaType;
-import jakarta.ws.rs.core.UriInfo;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
@@ -45,12 +43,11 @@ import lombok.RequiredArgsConstructor;
 import org.apache.fineract.commands.domain.CommandWrapper;
 import org.apache.fineract.commands.service.CommandWrapperBuilder;
 import org.apache.fineract.commands.service.PortfolioCommandSourceWritePlatformService;
-import org.apache.fineract.infrastructure.core.api.ApiRequestParameterHelper;
 import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
-import org.apache.fineract.infrastructure.core.serialization.ApiRequestJsonSerializationSettings;
 import org.apache.fineract.infrastructure.core.serialization.DefaultToApiJsonSerializer;
 import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
 import org.apache.fineract.portfolio.floatingrates.data.FloatingRateData;
+import org.apache.fineract.portfolio.floatingrates.data.FloatingRateRequest;
 import org.apache.fineract.portfolio.floatingrates.service.FloatingRatesReadPlatformService;
 import org.springframework.stereotype.Component;
 
@@ -69,7 +66,6 @@ public class FloatingRatesApiResource {
     private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
     private final DefaultToApiJsonSerializer<FloatingRateData> toApiJsonSerializer;
     private final FloatingRatesReadPlatformService floatingRatesReadPlatformService;
-    private final ApiRequestParameterHelper apiRequestParameterHelper;
 
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
@@ -79,11 +75,10 @@ public class FloatingRatesApiResource {
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.PostFloatingRatesRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.PostFloatingRatesResponse.class))) })
-    public String createFloatingRate(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
+    public CommandProcessingResult createFloatingRate(@Parameter(hidden = true) final FloatingRateRequest floatingRateRequest) {
-
+        final CommandWrapper commandRequest = new CommandWrapperBuilder().createFloatingRate()
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().createFloatingRate().withJson(apiRequestBodyAsJson).build();
+                .withJson(toApiJsonSerializer.serialize(floatingRateRequest)).build();
-        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
+        return commandsSourceWritePlatformService.logCommandSource(commandRequest);
-        return this.toApiJsonSerializer.serialize(result);
     }
 
     @GET
@@ -92,11 +87,9 @@ public class FloatingRatesApiResource {
     @Operation(summary = "List Floating Rates", description = "Lists Floating Rates")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.GetFloatingRatesResponse.class)))) })
-    public String retrieveAll(@Context final UriInfo uriInfo) {
+    public List<FloatingRateData> retrieveAll() {
         this.context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME);
-        final List<FloatingRateData> floatingRates = this.floatingRatesReadPlatformService.retrieveAll();
+        return floatingRatesReadPlatformService.retrieveAll();
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, floatingRates, FloatingRatesApiResource.LIST_FLOATING_RATES_PARAMETERS);
     }
 
     @GET
@@ -106,12 +99,9 @@ public class FloatingRatesApiResource {
     @Operation(summary = "Retrieve Floating Rate", description = "Retrieves Floating Rate")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.GetFloatingRatesFloatingRateIdResponse.class))) })
-    public String retrieveOne(@PathParam("floatingRateId") @Parameter(description = "floatingRateId") final Long floatingRateId,
+    public FloatingRateData retrieveOne(@PathParam("floatingRateId") @Parameter(description = "floatingRateId") final Long floatingRateId) {
-            @Context final UriInfo uriInfo) {
         this.context.authenticatedUser().validateHasReadPermission(RESOURCE_NAME);
-        final FloatingRateData floatingRates = this.floatingRatesReadPlatformService.retrieveOne(floatingRateId);
+        return floatingRatesReadPlatformService.retrieveOne(floatingRateId);
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, floatingRates, FloatingRatesApiResource.INDIVIDUAL_FLOATING_RATES_PARAMETERS);
     }
 
     @PUT
@@ -122,12 +112,13 @@ public class FloatingRatesApiResource {
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.PutFloatingRatesFloatingRateIdRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = FloatingRatesApiResourceSwagger.PutFloatingRatesFloatingRateIdResponse.class))) })
-    public String updateFloatingRate(@PathParam("floatingRateId") @Parameter(description = "floatingRateId") final Long floatingRateId,
+    public CommandProcessingResult updateFloatingRate(
-            @Parameter(hidden = true) final String apiRequestBodyAsJson) {
+            @PathParam("floatingRateId") @Parameter(description = "floatingRateId") final Long floatingRateId,
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().updateFloatingRate(floatingRateId).withJson(apiRequestBodyAsJson)
+            @Parameter(hidden = true) final FloatingRateRequest floatingRateRequest) {
-                .build();
+        final CommandWrapper commandRequest = new CommandWrapperBuilder().updateFloatingRate(floatingRateId)
-        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
+                .withJson(toApiJsonSerializer.serialize(floatingRateRequest)).build();
-        return this.toApiJsonSerializer.serialize(result);
+
+        return commandsSourceWritePlatformService.logCommandSource(commandRequest);
     }
 
 }

fineract-rates/src/main/java/org/apache/fineract/portfolio/floatingrates/data/FloatingRateData.java

@@ -18,6 +18,8 @@
  */
 package org.apache.fineract.portfolio.floatingrates.data;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import java.io.Serializable;
 import java.time.OffsetDateTime;
 import java.util.List;
@@ -26,11 +28,14 @@ import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class FloatingRateData implements Comparable<FloatingRateData>, Serializable {
 
     private final Long id;
     private final String name;
+    @JsonProperty("isBaseLendingRate")
     private final boolean isBaseLendingRate;
+    @JsonProperty("isActive")
     private final boolean isActive;
     private final String createdBy;
     private final OffsetDateTime createdOn;

fineract-rates/src/main/java/org/apache/fineract/portfolio/floatingrates/data/FloatingRatePeriodData.java

@@ -18,6 +18,8 @@
  */
 package org.apache.fineract.portfolio.floatingrates.data;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.time.LocalDate;
@@ -26,12 +28,15 @@ import org.apache.commons.lang3.builder.CompareToBuilder;
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class FloatingRatePeriodData implements Comparable<FloatingRatePeriodData>, Serializable {
 
     private Long id;
     private LocalDate fromDate;
     private BigDecimal interestRate;
+    @JsonProperty("isDifferentialToBaseLendingRate")
     private boolean isDifferentialToBaseLendingRate;
+    @JsonProperty("isActive")
     private boolean isActive;
     private String createdBy;
     private OffsetDateTime createdOn;

fineract-rates/src/main/java/org/apache/fineract/portfolio/floatingrates/data/FloatingRatePeriodRequest.java

@@ -0,0 +1,42 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.floatingrates.data;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.math.BigDecimal;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class FloatingRatePeriodRequest implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private String fromDate;
+    private BigDecimal interestRate;
+    private Boolean isDifferentialToBaseLendingRate;
+    private String locale;
+    private String dateFormat;
+
+}

fineract-rates/src/main/java/org/apache/fineract/portfolio/floatingrates/data/FloatingRateRequest.java

@@ -0,0 +1,41 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.floatingrates.data;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class FloatingRateRequest implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private String name;
+    private Boolean isBaseLendingRate;
+    private Boolean isActive;
+    private List<FloatingRatePeriodRequest> ratePeriods;
+
+}