FINERACT-2243: New command processing - payment type

Author: vidakovic

fineract-command/REFACTORING.md

@@ -298,12 +298,12 @@ public class CreatePaymentTypeCommandHandler implements NewCommandSourceHandler
 @Slf4j
 @RequiredArgsConstructor
 @Component
-public class CreatePaymentTypeCommandHandler implements CommandHandler<CreatePaymentTypeRequest, CreatePaymentTypeResponse> {
+public class PaymentTypeCreateCommandHandler implements CommandHandler<PaymentTypeCreateRequest, PaymentTypeCreateResponse> {
 
     private final PaymentTypeWriteService paymentTypeWriteService;
 
     @Override
-    public CreatePaymentTypeResponse handle(Command<CreatePaymentTypeRequest> command) {
+    public PaymentTypeCreateResponse handle(Command<PaymentTypeCreateRequest> command) {
         // TODO: refactor business logic service to accept properly typed request objects as input
         return paymentTypeWriteService.createPaymentType(command.getPayload());
     }

fineract-core/src/main/java/org/apache/fineract/commands/service/CommandWrapperBuilder.java

@@ -29,7 +29,6 @@
 import org.apache.fineract.infrastructure.accountnumberformat.service.AccountNumberFormatConstants;
 import org.apache.fineract.infrastructure.core.domain.ExternalId;
 import org.apache.fineract.portfolio.client.api.ClientApiConstants;
-import org.apache.fineract.portfolio.paymenttype.api.PaymentTypeApiResourceConstants;
 import org.apache.fineract.portfolio.savings.DepositsApiConstants;
 import org.apache.fineract.portfolio.self.pockets.api.PocketApiConstants;
 import org.apache.fineract.useradministration.api.PasswordPreferencesApiConstants;
@@ -2946,30 +2945,6 @@ public CommandWrapperBuilder updatePasswordPreferences() {
         return this;
     }
 
-    public CommandWrapperBuilder createPaymentType() {
-        this.actionName = "CREATE";
-        this.entityName = PaymentTypeApiResourceConstants.ENTITY_NAME;
-        this.entityId = null;
-        this.href = "/" + PaymentTypeApiResourceConstants.RESOURCE_NAME;
-        return this;
-    }
-
-    public CommandWrapperBuilder updatePaymentType(final Long paymentTypeId) {
-        this.actionName = "UPDATE";
-        this.entityName = PaymentTypeApiResourceConstants.ENTITY_NAME;
-        this.entityId = paymentTypeId;
-        this.href = "/" + PaymentTypeApiResourceConstants.RESOURCE_NAME + paymentTypeId;
-        return this;
-    }
-
-    public CommandWrapperBuilder deletePaymentType(final Long paymentTypeId) {
-        this.actionName = "DELETE";
-        this.entityName = "PAYMENTTYPE";
-        this.entityId = paymentTypeId;
-        this.href = "/" + PaymentTypeApiResourceConstants.RESOURCE_NAME + paymentTypeId;
-        return this;
-    }
-
     public CommandWrapperBuilder updateExternalServiceProperties(final String externalServiceName) {
         this.actionName = "UPDATE";
         this.entityName = "EXTERNALSERVICES";

fineract-core/src/main/java/org/apache/fineract/portfolio/paymenttype/api/PaymentTypeApiResource.java

@@ -19,11 +19,6 @@
 package org.apache.fineract.portfolio.paymenttype.api;
 
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.media.Content;
-import io.swagger.v3.oas.annotations.media.Schema;
-import io.swagger.v3.oas.annotations.parameters.RequestBody;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.Consumes;
 import jakarta.ws.rs.DELETE;
@@ -36,17 +31,21 @@
 import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.MediaType;
 import java.util.List;
+import java.util.function.Supplier;
 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.data.CommandProcessingResult;
+import org.apache.fineract.command.core.CommandPipeline;
 import org.apache.fineract.infrastructure.core.serialization.DefaultToApiJsonSerializer;
-import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
+import org.apache.fineract.portfolio.paymenttype.command.PaymentTypeCreateCommand;
+import org.apache.fineract.portfolio.paymenttype.command.PaymentTypeDeleteCommand;
+import org.apache.fineract.portfolio.paymenttype.command.PaymentTypeUpdateCommand;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeCreateRequest;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeCreateResponse;
 import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeData;
-import org.apache.fineract.portfolio.paymenttype.data.request.PaymentTypeRequest;
-import org.apache.fineract.portfolio.paymenttype.domain.PaymentTypeRepositoryWrapper;
-import org.apache.fineract.portfolio.paymenttype.service.PaymentTypeReadPlatformService;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeDeleteRequest;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeDeleteResponse;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeUpdateRequest;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeUpdateResponse;
+import org.apache.fineract.portfolio.paymenttype.service.PaymentTypeReadService;
 import org.springframework.stereotype.Component;
 
 @Path("/v1/paymenttypes")
@@ -55,19 +54,15 @@
 @RequiredArgsConstructor
 public class PaymentTypeApiResource {
 
-    private final PlatformSecurityContext securityContext;
+    private final PaymentTypeReadService readPlatformService;
+    private final CommandPipeline commandPipeline;
     private final DefaultToApiJsonSerializer<PaymentTypeData> jsonSerializer;
-    private final PaymentTypeReadPlatformService readPlatformService;
-    private final PortfolioCommandSourceWritePlatformService commandWritePlatformService;
-    private final PaymentTypeRepositoryWrapper paymentTypeRepositoryWrapper;
 
     @GET
     @Consumes({ MediaType.TEXT_HTML, MediaType.APPLICATION_JSON })
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "Retrieve all Payment Types", description = "Retrieve list of payment types")
-    public List<PaymentTypeData> getAllPaymentTypes(
-            @QueryParam("onlyWithCode") @Parameter(description = "onlyWithCode") final boolean onlyWithCode) {
-        securityContext.authenticatedUser().validateHasReadPermission(PaymentTypeApiResourceConstants.ENTITY_NAME);
+    public List<PaymentTypeData> getAllPaymentTypes(@QueryParam("onlyWithCode") final boolean onlyWithCode) {
         return onlyWithCode ? readPlatformService.retrieveAllPaymentTypesWithCode() : readPlatformService.retrieveAllPaymentTypes();
     }
 
@@ -76,61 +71,57 @@ public List<PaymentTypeData> getAllPaymentTypes(
     @Consumes({ MediaType.TEXT_HTML, MediaType.APPLICATION_JSON })
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "Retrieve a Payment Type", description = "Retrieves a payment type")
-    public PaymentTypeData retrieveOnePaymentType(
-            @PathParam("paymentTypeId") @Parameter(description = "paymentTypeId") final Long paymentTypeId) {
-        securityContext.authenticatedUser().validateHasReadPermission(PaymentTypeApiResourceConstants.ENTITY_NAME);
-        paymentTypeRepositoryWrapper.findOneWithNotFoundDetection(paymentTypeId);
+    public PaymentTypeData retrieveOnePaymentType(@PathParam("paymentTypeId") final Long paymentTypeId) {
         return readPlatformService.retrieveOne(paymentTypeId);
     }
 
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
-    @Operation(summary = "Create a Payment Type", description = "Creates a new Payment type\n\n" + "Mandatory Fields: name\n\n"
-            + "Optional Fields: Description, isCashPayment,Position")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = PaymentTypeRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = PaymentTypeApiResourceSwagger.PostPaymentTypesResponse.class)))
-    public CommandProcessingResult createPaymentType(@Parameter(hidden = true) PaymentTypeRequest paymentTypeRequest) {
+    @Operation(summary = "Create a Payment Type", description = "Creates a new Payment type")
+    public PaymentTypeCreateResponse createPaymentType(PaymentTypeCreateRequest request) {
+        final var command = new PaymentTypeCreateCommand();
 
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().createPaymentType()
-                .withJson(jsonSerializer.serialize(paymentTypeRequest)).build();
+        command.setPayload(request);
 
-        CommandProcessingResult result = commandWritePlatformService.logCommandSource(commandRequest);
-        return result;
+        final Supplier<PaymentTypeCreateResponse> response = commandPipeline.send(command);
+
+        return response.get();
     }
 
     @PUT
     @Path("{paymentTypeId}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Update a Payment Type", description = "Updates a Payment Type")
-    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = PaymentTypeApiResourceSwagger.PutPaymentTypesPaymentTypeIdRequest.class)))
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = PaymentTypeApiResourceSwagger.PutPaymentTypesPaymentTypeIdResponse.class)))
-    public CommandProcessingResult updatePaymentType(
-            @PathParam("paymentTypeId") @Parameter(description = "paymentTypeId") final Long paymentTypeId,
-            @Parameter(hidden = true) final String apiRequestBodyAsJson) {
+    public PaymentTypeUpdateResponse updatePaymentType(@PathParam("paymentTypeId") final Long paymentTypeId,
+            final PaymentTypeUpdateRequest request) {
+        request.setId(paymentTypeId);
+
+        final var command = new PaymentTypeUpdateCommand();
+
+        command.setPayload(request);
 
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().updatePaymentType(paymentTypeId).withJson(apiRequestBodyAsJson)
-                .build();
+        final Supplier<PaymentTypeUpdateResponse> response = commandPipeline.send(command);
 
-        final CommandProcessingResult result = commandWritePlatformService.logCommandSource(commandRequest);
-        return result;
+        return response.get();
     }
 
     @DELETE
     @Path("{paymentTypeId}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Delete a Payment Type", description = "Deletes payment type")
-    @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = PaymentTypeApiResourceSwagger.DeletePaymentTypesPaymentTypeIdResponse.class)))
-    public CommandProcessingResult deleteCode(
-            @PathParam("paymentTypeId") @Parameter(description = "paymentTypeId") final Long paymentTypeId) {
+    public PaymentTypeDeleteResponse deleteCode(@PathParam("paymentTypeId") final Long paymentTypeId) {
 
-        final CommandWrapper commandRequest = new CommandWrapperBuilder().deletePaymentType(paymentTypeId).build();
+        final var request = PaymentTypeDeleteRequest.builder().id(paymentTypeId).build();
 
-        final CommandProcessingResult result = commandWritePlatformService.logCommandSource(commandRequest);
+        final var command = new PaymentTypeDeleteCommand();
 
-        return result;
-    }
+        command.setPayload(request);
+
+        final Supplier<PaymentTypeDeleteResponse> response = commandPipeline.send(command);
 
+        return response.get();
+    }
 }

fineract-core/src/main/java/org/apache/fineract/portfolio/paymenttype/api/PaymentTypeApiResourceConstants.java

@@ -0,0 +1,28 @@
+/**
+ * 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.paymenttype.command;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import org.apache.fineract.command.core.Command;
+import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeCreateRequest;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class PaymentTypeCreateCommand extends Command<PaymentTypeCreateRequest> {}