FINERACT-2239: New command processing - Resource Notes (org.apache.fineract.portfolio.note)

Author: vidakovic

custom/acme/note/service/src/main/java/com/acme/fineract/portfolio/note/service/AcmeNoteReadPlatformService.java

@@ -21,7 +21,7 @@
 import java.util.Collections;
 import java.util.List;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.fineract.portfolio.note.data.NoteData;
+import org.apache.fineract.portfolio.note.data.NoteResponse;
 import org.apache.fineract.portfolio.note.service.NoteReadPlatformService;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -38,12 +38,12 @@ public void afterPropertiesSet() throws Exception {
     }
 
     @Override
-    public NoteData retrieveNote(Long noteId, Long resourceId, Integer noteTypeId) {
+    public NoteResponse retrieveNote(Long noteId, Long resourceId, Integer noteTypeId) {
         return null;
     }
 
     @Override
-    public List<NoteData> retrieveNotesByResource(Long resourceId, Integer noteTypeId) {
+    public List<NoteResponse> retrieveNotesByResource(Long resourceId, Integer noteTypeId) {
         return Collections.emptyList();
     }
 }

custom/acme/note/service/src/main/java/com/acme/fineract/portfolio/note/service/AcmeNoteWritePlatformService.java

@@ -19,9 +19,13 @@
 package com.acme.fineract.portfolio.note.service;
 
 import lombok.extern.slf4j.Slf4j;
-import org.apache.fineract.infrastructure.core.api.JsonCommand;
-import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
-import org.apache.fineract.portfolio.client.domain.Client;
+import org.apache.fineract.portfolio.note.data.NoteCreateRequest;
+import org.apache.fineract.portfolio.note.data.NoteCreateResponse;
+import org.apache.fineract.portfolio.note.data.NoteDeleteByResourceIdRequest;
+import org.apache.fineract.portfolio.note.data.NoteDeleteRequest;
+import org.apache.fineract.portfolio.note.data.NoteDeleteResponse;
+import org.apache.fineract.portfolio.note.data.NoteUpdateRequest;
+import org.apache.fineract.portfolio.note.data.NoteUpdateResponse;
 import org.apache.fineract.portfolio.note.service.NoteWritePlatformService;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -38,27 +42,22 @@ public void afterPropertiesSet() throws Exception {
     }
 
     @Override
-    public CommandProcessingResult createNote(JsonCommand command) {
+    public NoteCreateResponse createNote(NoteCreateRequest request) {
         throw new UnsupportedOperationException("createNote() is not yet implemented.");
     }
 
     @Override
-    public void createLoanTransactionNote(Long loanTransactionId, String note) {
-        throw new UnsupportedOperationException("createLoanTransactionNote() is not yet implemented.");
-    }
-
-    @Override
-    public CommandProcessingResult updateNote(JsonCommand command) {
+    public NoteUpdateResponse updateNote(NoteUpdateRequest request) {
         throw new UnsupportedOperationException("updateNote() is not yet implemented.");
     }
 
     @Override
-    public CommandProcessingResult deleteNote(JsonCommand command) {
+    public NoteDeleteResponse deleteNote(NoteDeleteRequest request) {
         throw new UnsupportedOperationException("deleteNote() is not yet implemented.");
     }
 
     @Override
-    public void createAndPersistClientNote(Client client, JsonCommand command) {
-        log.warn("createAndPersistClientNote() is intentionally left empty and does nothing.");
+    public void deleteByResource(NoteDeleteByResourceIdRequest request) {
+        throw new UnsupportedOperationException("deleteBySavingsAccount() is not yet implemented.");
     }
 }

custom/acme/note/starter/src/test/java/com/acme/fineract/portfolio/note/starter/TestDefaultConfiguration.java

@@ -29,7 +29,6 @@
 import org.apache.fineract.portfolio.loanaccount.domain.LoanRepositoryWrapper;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanTransactionRepository;
 import org.apache.fineract.portfolio.note.domain.NoteRepository;
-import org.apache.fineract.portfolio.note.serialization.NoteCommandFromApiJsonDeserializer;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -82,9 +81,4 @@ public LoanRepositoryWrapper loanRepository() {
     public LoanTransactionRepository loanTransactionRepository() {
         return mock(LoanTransactionRepository.class);
     }
-
-    @Bean
-    public NoteCommandFromApiJsonDeserializer fromApiJsonDeserializer(FromJsonHelper fromJsonHelper) {
-        return new NoteCommandFromApiJsonDeserializer(fromJsonHelper);
-    }
 }

custom/acme/note/starter/src/test/java/com/acme/fineract/portfolio/note/starter/TestOverrideConfiguration.java

@@ -20,15 +20,13 @@
 
 import static org.mockito.Mockito.mock;
 
-import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
 import org.apache.fineract.infrastructure.core.service.database.RoutingDataSource;
 import org.apache.fineract.infrastructure.core.service.database.RoutingDataSourceServiceFactory;
 import org.apache.fineract.portfolio.client.domain.ClientRepositoryWrapper;
 import org.apache.fineract.portfolio.group.domain.GroupRepository;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanRepositoryWrapper;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanTransactionRepository;
 import org.apache.fineract.portfolio.note.domain.NoteRepository;
-import org.apache.fineract.portfolio.note.serialization.NoteCommandFromApiJsonDeserializer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.jdbc.core.JdbcTemplate;
@@ -37,11 +35,6 @@
 public class TestOverrideConfiguration {
     // NOTE: unfortunately an abastract base class that contains all these mock functions won't work
 
-    @Bean
-    public FromJsonHelper fromJsonHelper() {
-        return mock(FromJsonHelper.class);
-    }
-
     @Bean
     public RoutingDataSourceServiceFactory routingDataSourceServiceFactory() {
         return mock(RoutingDataSourceServiceFactory.class);
@@ -81,9 +74,4 @@ public LoanRepositoryWrapper loanRepository() {
     public LoanTransactionRepository loanTransactionRepository() {
         return mock(LoanTransactionRepository.class);
     }
-
-    @Bean
-    public NoteCommandFromApiJsonDeserializer fromApiJsonDeserializer(FromJsonHelper fromJsonHelper) {
-        return new NoteCommandFromApiJsonDeserializer(fromJsonHelper);
-    }
 }

fineract-accounting/src/main/java/org/apache/fineract/accounting/journalentry/data/TransactionDetailData.java

@@ -20,7 +20,7 @@
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.portfolio.note.data.NoteData;
+import org.apache.fineract.portfolio.note.data.NoteResponse;
 import org.apache.fineract.portfolio.paymentdetail.data.PaymentDetailData;
 
 @RequiredArgsConstructor
@@ -29,13 +29,13 @@ public class TransactionDetailData {
 
     private final Long transactionId;
     private final PaymentDetailData paymentDetails;
-    private final NoteData noteData;
+    private final NoteResponse noteResponse;
     private final TransactionTypeEnumData transactionType;
 
-    public TransactionDetailData(final Long transactionId, final PaymentDetailData paymentDetails, final NoteData noteData) {
+    public TransactionDetailData(final Long transactionId, final PaymentDetailData paymentDetails, final NoteResponse noteResponse) {
         this.transactionId = transactionId;
         this.paymentDetails = paymentDetails;
-        this.noteData = noteData;
+        this.noteResponse = noteResponse;
         this.transactionType = null;
     }
 }

fineract-command/src/test/java/org/apache/fineract/command/sample/api/DummyApiController.java

@@ -22,6 +22,7 @@
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
 import static org.springframework.http.MediaType.APPLICATION_PROBLEM_JSON_VALUE;
 
+import jakarta.validation.Valid;
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
 import java.util.UUID;
@@ -55,7 +56,7 @@ class DummyApiController {
 
     @PostMapping("/sync")
     DummyResponse dummySync(@RequestHeader(value = COMMAND_REQUEST_ID, required = false) UUID requestId,
-            @RequestHeader(value = "x-fineract-tenant-id", required = false) String tenantId, @RequestBody DummyRequest request) {
+            @RequestHeader(value = "x-fineract-tenant-id", required = false) String tenantId, @Valid @RequestBody DummyRequest request) {
         var command = new DummyCommand();
         command.setId(requestId);
         command.setPayload(request);

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

@@ -1837,55 +1837,6 @@ public CommandWrapperBuilder deleteCalendar(final String supportedEntityType, fi
         return this;
     }
 
-    public CommandWrapperBuilder createNote(final CommandWrapper resourceDetails, final String resourceType, final Long resourceId) {
-        this.actionName = "CREATE";
-        this.entityName = resourceDetails.entityName();// Note supports multiple
-                                                       // resources. Note
-                                                       // Permissions are set
-                                                       // for each resource.
-        this.clientId = resourceDetails.getClientId();
-        this.loanId = resourceDetails.getLoanId();
-        this.savingsId = resourceDetails.getSavingsId();
-        this.groupId = resourceDetails.getGroupId();
-        this.subentityId = resourceDetails.subresourceId();
-        this.href = "/" + resourceType + "/" + resourceId + "/notes/template";
-        return this;
-    }
-
-    public CommandWrapperBuilder updateNote(final CommandWrapper resourceDetails, final String resourceType, final Long resourceId,
-            final Long noteId) {
-        this.actionName = "UPDATE";
-        this.entityName = resourceDetails.entityName();// Note supports multiple
-                                                       // resources. Note
-                                                       // Permissions are set
-                                                       // for each resource.
-        this.entityId = noteId;
-        this.clientId = resourceDetails.getClientId();
-        this.loanId = resourceDetails.getLoanId();
-        this.savingsId = resourceDetails.getSavingsId();
-        this.groupId = resourceDetails.getGroupId();
-        this.subentityId = resourceDetails.subresourceId();
-        this.href = "/" + resourceType + "/" + resourceId + "/notes";
-        return this;
-    }
-
-    public CommandWrapperBuilder deleteNote(final CommandWrapper resourceDetails, final String resourceType, final Long resourceId,
-            final Long noteId) {
-        this.actionName = "DELETE";
-        this.entityName = resourceDetails.entityName();// Note supports multiple
-                                                       // resources. Note
-                                                       // Permissions are set
-                                                       // for each resource.
-        this.entityId = noteId;
-        this.clientId = resourceDetails.getClientId();
-        this.loanId = resourceDetails.getLoanId();
-        this.savingsId = resourceDetails.getSavingsId();
-        this.groupId = resourceDetails.getGroupId();
-        this.subentityId = resourceDetails.subresourceId();
-        this.href = "/" + resourceType + "/" + resourceId + "/calendars/" + noteId;
-        return this;
-    }
-
     public CommandWrapperBuilder createGroup() {
         this.actionName = "CREATE";
         this.entityName = "GROUP";
@@ -3581,13 +3532,6 @@ public CommandWrapperBuilder updateRate(final Long rateId) {
         return this;
     }
 
-    public CommandWrapperBuilder updateBusinessDate() {
-        this.actionName = "UPDATE";
-        this.entityName = "BUSINESS_DATE";
-        this.href = "/businessdate";
-        return this;
-    }
-
     public CommandWrapperBuilder createDelinquencyRange() {
         this.actionName = "CREATE";
         this.entityName = "DELINQUENCY_RANGE";

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

@@ -276,16 +276,6 @@ private NewCommandSourceHandler findCommandHandler(final CommandWrapper wrapper)
             } else {
                 throw new UnsupportedCommandException(wrapper.commandName());
             }
-        } else if (wrapper.isNoteResource()) {
-            if (wrapper.isCreate()) {
-                handler = applicationContext.getBean("createNoteCommandHandler", NewCommandSourceHandler.class);
-            } else if (wrapper.isUpdate()) {
-                handler = applicationContext.getBean("updateNoteCommandHandler", NewCommandSourceHandler.class);
-            } else if (wrapper.isDelete()) {
-                handler = applicationContext.getBean("deleteNoteCommandHandler", NewCommandSourceHandler.class);
-            } else {
-                throw new UnsupportedCommandException(wrapper.commandName());
-            }
         } else if (wrapper.isSurveyResource()) {
             if (wrapper.isRegisterSurvey()) {
                 handler = applicationContext.getBean("registerSurveyCommandHandler", NewCommandSourceHandler.class);

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/api/BusinessDateApiResource.java

@@ -19,10 +19,10 @@
 package org.apache.fineract.infrastructure.businessdate.api;
 
 import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DefaultValue;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.HeaderParam;
 import jakarta.ws.rs.POST;
@@ -64,15 +64,15 @@ public List<BusinessDateResponse> getBusinessDates() {
     @Consumes({ MediaType.TEXT_HTML, MediaType.APPLICATION_JSON })
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "Retrieve a specific Business date", description = "")
-    public BusinessDateResponse getBusinessDate(@PathParam("type") @Parameter(description = "type") final String type) {
+    public BusinessDateResponse getBusinessDate(@PathParam("type") final String type) {
         return this.readPlatformService.findByType(type);
     }
 
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Update Business Date", description = "")
-    public BusinessDateResponse updateBusinessDate(@HeaderParam("Idempotency-Key") String idempotencyKey,
+    public BusinessDateResponse updateBusinessDate(@HeaderParam("Idempotency-Key") @DefaultValue("") String idempotencyKey,
             @Valid BusinessDateUpdateRequest request) {
 
         final var command = new BusinessDateUpdateCommand();

…/portfolio/note/command/NoteCommand.java …olio/note/command/NoteCreateCommand.javafineract-provider/src/main/java/org/apache/fineract/portfolio/note/command/NoteCommand.java renamed to fineract-core/src/main/java/org/apache/fineract/portfolio/note/command/NoteCreateCommand.java fineract-provider/src/main/java/org/apache/fineract/portfolio/note/command/NoteCommand.java renamed to fineract-core/src/main/java/org/apache/fineract/portfolio/note/command/NoteCreateCommand.java

@@ -18,16 +18,11 @@
  */
 package org.apache.fineract.portfolio.note.command;
 
-/**
- * Immutable command used for create or update of notes.
- */
-public class NoteCommand {
-
-    @SuppressWarnings("unused")
-    private final String note;
-
-    public NoteCommand(final String note) {
-        this.note = note;
-    }
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import org.apache.fineract.command.core.Command;
+import org.apache.fineract.portfolio.note.data.NoteCreateRequest;
 
-}
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class NoteCreateCommand extends Command<NoteCreateRequest> {}