FINERACT-2169: Refactor account transfer api controller;

Author: VictorPavfurious

fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/RunreportsApiResource.java

@@ -53,7 +53,7 @@
 
 @Path("/v1/runreports")
 @Component
-@Tag(name = "Run Reports", description = "")
+@Tag(name = "Run Reports")
 @RequiredArgsConstructor
 public class RunreportsApiResource {
 
@@ -69,7 +69,7 @@ public class RunreportsApiResource {
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Return all available export types for the specific report", description = "Returns the list of all available export types.")
     @ApiResponses({
-            @ApiResponse(responseCode = "200", description = "", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ReportExportType.class)))) })
+            @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = ReportExportType.class)))) })
     public Response retrieveAllAvailableExports(@PathParam("reportName") @Parameter(description = "reportName") final String reportName,
             @Context final UriInfo uriInfo,
             @DefaultValue("false") @QueryParam(IS_SELF_SERVICE_USER_REPORT_PARAMETER) @Parameter(description = IS_SELF_SERVICE_USER_REPORT_PARAMETER) final boolean isSelfServiceUserReport) {

fineract-provider/src/main/java/org/apache/fineract/portfolio/account/api/AccountTransfersApiResource.java

@@ -26,29 +26,27 @@
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.ws.rs.BeanParam;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.QueryParam;
-import jakarta.ws.rs.core.Context;
 import jakarta.ws.rs.core.MediaType;
-import jakarta.ws.rs.core.UriInfo;
 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.core.service.Page;
 import org.apache.fineract.infrastructure.core.service.SearchParameters;
 import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
-import org.apache.fineract.infrastructure.security.service.SqlValidator;
 import org.apache.fineract.portfolio.account.data.AccountTransferData;
+import org.apache.fineract.portfolio.account.data.request.AccountTransSearchParam;
+import org.apache.fineract.portfolio.account.data.request.AccountTransferRequest;
 import org.apache.fineract.portfolio.account.service.AccountTransfersReadPlatformService;
 import org.springframework.stereotype.Component;
 
@@ -61,9 +59,7 @@ public class AccountTransfersApiResource {
     private final PlatformSecurityContext context;
     private final DefaultToApiJsonSerializer<AccountTransferData> toApiJsonSerializer;
     private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
-    private final ApiRequestParameterHelper apiRequestParameterHelper;
     private final AccountTransfersReadPlatformService accountTransfersReadPlatformService;
-    private final SqlValidator sqlValidator;
 
     @GET
     @Path("template")
@@ -76,38 +72,28 @@ public class AccountTransfersApiResource {
             + "accounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.GetAccountTransfersTemplateResponse.class))) })
-    public String template(@QueryParam("fromOfficeId") @Parameter(description = "fromOfficeId") final Long fromOfficeId,
-            @QueryParam("fromClientId") @Parameter(description = "fromClientId") final Long fromClientId,
-            @QueryParam("fromAccountId") @Parameter(description = "fromAccountId") final Long fromAccountId,
-            @QueryParam("fromAccountType") @Parameter(description = "fromAccountType") final Integer fromAccountType,
-            @QueryParam("toOfficeId") @Parameter(description = "toOfficeId") final Long toOfficeId,
-            @QueryParam("toClientId") @Parameter(description = "toClientId") final Long toClientId,
-            @QueryParam("toAccountId") @Parameter(description = "toAccountId") final Long toAccountId,
-            @QueryParam("toAccountType") @Parameter(description = "toAccountType") final Integer toAccountType,
-            @Context final UriInfo uriInfo) {
+    public AccountTransferData template(@BeanParam AccountTransSearchParam accountTransSearchParam) {
 
-        this.context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
+        context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
 
-        final AccountTransferData transferData = this.accountTransfersReadPlatformService.retrieveTemplate(fromOfficeId, fromClientId,
-                fromAccountId, fromAccountType, toOfficeId, toClientId, toAccountId, toAccountType);
-
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, transferData, AccountTransfersApiConstants.RESPONSE_DATA_PARAMETERS);
+        return accountTransfersReadPlatformService.retrieveTemplate(accountTransSearchParam.getFromAccountId(),
+                accountTransSearchParam.getFromClientId(), accountTransSearchParam.getFromAccountId(),
+                accountTransSearchParam.getFromAccountType(), accountTransSearchParam.getToOfficeId(),
+                accountTransSearchParam.getToClientId(), accountTransSearchParam.getToAccountId(),
+                accountTransSearchParam.getToAccountType());
     }
 
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Create new Transfer", description = "Ability to create new transfer of monetary funds from one account to another.")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.PostAccountTransfersRequest.class)))
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = AccountTransferRequest.class)))
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.PostAccountTransfersResponse.class)))
-    public String create(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
-
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().createAccountTransfer().withJson(apiRequestBodyAsJson).build();
+    public CommandProcessingResult create(@Parameter(hidden = true) AccountTransferRequest accountTransferRequest) {
+        final CommandWrapper commandRequest = new CommandWrapperBuilder().createAccountTransfer()
+                .withJson(toApiJsonSerializer.serialize(accountTransferRequest)).build();
 
-        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
-
-        return this.toApiJsonSerializer.serialize(result);
+        return commandsSourceWritePlatformService.logCommandSource(commandRequest);
     }
 
     @GET
@@ -117,26 +103,19 @@ public String create(@Parameter(hidden = true) final String apiRequestBodyAsJson
             + "accounttransfers")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.GetAccountTransfersResponse.class))) })
-    public String retrieveAll(@Context final UriInfo uriInfo,
-            @QueryParam("externalId") @Parameter(description = "externalId") final String externalId,
+    public Page<AccountTransferData> retrieveAll(@QueryParam("externalId") @Parameter(description = "externalId") final String externalId,
             @QueryParam("offset") @Parameter(description = "offset") final Integer offset,
             @QueryParam("limit") @Parameter(example = "limit") final Integer limit,
             @QueryParam("orderBy") @Parameter(description = "orderBy") final String orderBy,
             @QueryParam("sortOrder") @Parameter(description = "sortOrder") final String sortOrder,
             @QueryParam("accountDetailId") @Parameter(description = "accountDetailId") final Long accountDetailId) {
 
-        this.context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
+        context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
 
-        sqlValidator.validate(orderBy);
-        sqlValidator.validate(sortOrder);
-        sqlValidator.validate(externalId);
         final SearchParameters searchParameters = SearchParameters.builder().limit(limit).externalId(externalId).offset(offset)
                 .orderBy(orderBy).sortOrder(sortOrder).build();
 
-        final Page<AccountTransferData> transfers = this.accountTransfersReadPlatformService.retrieveAll(searchParameters, accountDetailId);
-
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, transfers, AccountTransfersApiConstants.RESPONSE_DATA_PARAMETERS);
+        return accountTransfersReadPlatformService.retrieveAll(searchParameters, accountDetailId);
     }
 
     @GET
@@ -147,15 +126,9 @@ public String retrieveAll(@Context final UriInfo uriInfo,
             + "accounttransfers/1")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.GetAccountTransfersResponse.GetAccountTransfersPageItems.class))) })
-    public String retrieveOne(@PathParam("transferId") @Parameter(description = "transferId") final Long transferId,
-            @Context final UriInfo uriInfo) {
-
-        this.context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
-
-        final AccountTransferData transfer = this.accountTransfersReadPlatformService.retrieveOne(transferId);
-
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, transfer, AccountTransfersApiConstants.RESPONSE_DATA_PARAMETERS);
+    public AccountTransferData retrieveOne(@PathParam("transferId") @Parameter(description = "transferId") final Long transferId) {
+        context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
+        return accountTransfersReadPlatformService.retrieveOne(transferId);
     }
 
     @GET
@@ -167,39 +140,26 @@ public String retrieveOne(@PathParam("transferId") @Parameter(description = "tra
             + "accounttransfers/templateRefundByTransfer?fromAccountId=2&fromAccountType=1& toAccountId=1&toAccountType=2&toClientId=1&toOfficeId=1")
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.GetAccountTransfersTemplateRefundByTransferResponse.class))) })
-    public String templateRefundByTransfer(@QueryParam("fromOfficeId") @Parameter(description = "fromOfficeId") final Long fromOfficeId,
-            @QueryParam("fromClientId") @Parameter(description = "fromClientId") final Long fromClientId,
-            @QueryParam("fromAccountId") @Parameter(description = "fromAccountId") final Long fromAccountId,
-            @QueryParam("fromAccountType") @Parameter(description = "fromAccountType") final Integer fromAccountType,
-            @QueryParam("toOfficeId") @Parameter(description = "toOfficeId") final Long toOfficeId,
-            @QueryParam("toClientId") @Parameter(description = "toClientId") final Long toClientId,
-            @QueryParam("toAccountId") @Parameter(description = "toAccountId") final Long toAccountId,
-            @QueryParam("toAccountType") @Parameter(description = "toAccountType") final Integer toAccountType,
-            @Context final UriInfo uriInfo) {
-
-        this.context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
-
-        final AccountTransferData transferData = this.accountTransfersReadPlatformService.retrieveRefundByTransferTemplate(fromOfficeId,
-                fromClientId, fromAccountId, fromAccountType, toOfficeId, toClientId, toAccountId, toAccountType);
-
-        final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters());
-        return this.toApiJsonSerializer.serialize(settings, transferData, AccountTransfersApiConstants.RESPONSE_DATA_PARAMETERS);
+    public AccountTransferData templateRefundByTransfer(@BeanParam AccountTransSearchParam accountTransSearchParam) {
+        context.authenticatedUser().validateHasReadPermission(AccountTransfersApiConstants.ACCOUNT_TRANSFER_RESOURCE_NAME);
+        return accountTransfersReadPlatformService.retrieveRefundByTransferTemplate(accountTransSearchParam.getFromAccountId(),
+                accountTransSearchParam.getFromClientId(), accountTransSearchParam.getFromAccountId(),
+                accountTransSearchParam.getFromAccountType(), accountTransSearchParam.getToOfficeId(),
+                accountTransSearchParam.getToClientId(), accountTransSearchParam.getToAccountId(),
+                accountTransSearchParam.getToAccountType());
     }
 
     @POST
     @Path("refundByTransfer")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Refund of an Active Loan by Transfer", description = "Ability to refund an active loan by transferring to a savings account.")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.PostAccountTransfersRefundByTransferRequest.class)))
+    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = AccountTransferRequest.class)))
     @ApiResponses({
             @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = AccountTransfersApiResourceSwagger.PostAccountTransfersRefundByTransferResponse.class))) })
-    public String templateRefundByTransferPost(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
-
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().refundByTransfer().withJson(apiRequestBodyAsJson).build();
-
-        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
-
-        return this.toApiJsonSerializer.serialize(result);
+    public CommandProcessingResult templateRefundByTransferPost(@Parameter(hidden = true) AccountTransferRequest accountTransferRequest) {
+        final CommandWrapper commandRequest = new CommandWrapperBuilder().refundByTransfer()
+                .withJson(toApiJsonSerializer.serialize(accountTransferRequest)).build();
+        return commandsSourceWritePlatformService.logCommandSource(commandRequest);
     }
 }

fineract-provider/src/main/java/org/apache/fineract/portfolio/account/data/request/AccountTransSearchParam.java

@@ -0,0 +1,52 @@
+/**
+ * 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.account.data.request;
+
+import jakarta.ws.rs.QueryParam;
+import java.io.Serial;
+import java.io.Serializable;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class AccountTransSearchParam implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    @QueryParam("fromOfficeId")
+    private Long fromOfficeId;
+    @QueryParam("fromClientId")
+    private Long fromClientId;
+    @QueryParam("fromAccountId")
+    private Long fromAccountId;
+    @QueryParam("fromAccountType")
+    private Integer fromAccountType;
+    @QueryParam("toOfficeId")
+    private Long toOfficeId;
+    @QueryParam("toClientId")
+    private Long toClientId;
+    @QueryParam("toAccountId")
+    private Long toAccountId;
+    @QueryParam("toAccountType")
+    private Integer toAccountType;
+}

fineract-provider/src/main/java/org/apache/fineract/portfolio/account/data/request/AccountTransferRequest.java

@@ -0,0 +1,46 @@
+/**
+ * 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.account.data.request;
+
+import java.io.Serial;
+import java.io.Serializable;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+public class AccountTransferRequest implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private String transferDescription;
+    private String toOfficeId;
+    private String toAccountType;
+    private String dateFormat;
+    private String transferAmount;
+    private String toAccountId;
+    private String fromClientId;
+    private String locale;
+    private String transferDate;
+    private String fromAccountType;
+    private String toClientId;
+    private String fromAccountId;
+    private String fromOfficeId;
+}