| /** |
| * 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.savings.data; |
| |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.SAVINGS_ACCOUNT_RESOURCE_NAME; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.activatedOnDateParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.bankNumberParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.checkNumberParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.closedOnDateParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.lienAllowedParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.paymentTypeIdParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.receiptNumberParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.routingCodeParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.transactionAccountNumberParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.transactionAmountParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.transactionDateParamName; |
| import static org.apache.fineract.portfolio.savings.SavingsApiConstants.withdrawBalanceParamName; |
| |
| import com.google.gson.JsonElement; |
| import com.google.gson.reflect.TypeToken; |
| import java.lang.reflect.Type; |
| import java.math.BigDecimal; |
| import java.time.LocalDate; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import lombok.RequiredArgsConstructor; |
| import org.apache.commons.lang3.BooleanUtils; |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService; |
| import org.apache.fineract.infrastructure.core.api.JsonCommand; |
| import org.apache.fineract.infrastructure.core.data.ApiParameterError; |
| import org.apache.fineract.infrastructure.core.data.DataValidatorBuilder; |
| import org.apache.fineract.infrastructure.core.exception.InvalidJsonException; |
| import org.apache.fineract.infrastructure.core.exception.PlatformApiDataValidationException; |
| import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper; |
| import org.apache.fineract.infrastructure.core.service.DateUtils; |
| import org.apache.fineract.portfolio.savings.SavingsApiConstants; |
| import org.apache.fineract.portfolio.savings.domain.SavingsAccount; |
| import org.apache.fineract.portfolio.savings.domain.SavingsAccountSubStatusEnum; |
| import org.apache.fineract.portfolio.savings.domain.SavingsAccountTransaction; |
| import org.apache.fineract.portfolio.savings.exception.TransactionBeforePivotDateNotAllowed; |
| import org.apache.fineract.useradministration.domain.AppUser; |
| import org.springframework.stereotype.Component; |
| |
| @Component |
| @RequiredArgsConstructor |
| public class SavingsAccountTransactionDataValidator { |
| |
| private final FromJsonHelper fromApiJsonHelper; |
| private static final Set<String> SAVINGS_ACCOUNT_HOLD_AMOUNT_REQUEST_DATA_PARAMETERS = new HashSet<>( |
| Arrays.asList(transactionDateParamName, SavingsApiConstants.dateFormatParamName, SavingsApiConstants.localeParamName, |
| transactionAmountParamName, lienAllowedParamName, SavingsApiConstants.reasonForBlockParamName)); |
| private final ConfigurationDomainService configurationDomainService; |
| |
| public void validateTransactionWithPivotDate(final LocalDate transactionDate, final SavingsAccount savingsAccount) { |
| final boolean backdatedTxnsAllowedTill = this.configurationDomainService.retrievePivotDateConfig(); |
| final boolean isRelaxingDaysConfigOn = this.configurationDomainService.isRelaxingDaysConfigForPivotDateEnabled(); |
| |
| final LocalDate lastInterestPostingDate = savingsAccount.getSummary().getInterestPostedTillDate(); |
| |
| if (backdatedTxnsAllowedTill && lastInterestPostingDate != null) { |
| LocalDate pivotDate = lastInterestPostingDate; |
| if (isRelaxingDaysConfigOn) { |
| pivotDate = pivotDate.minusDays(this.configurationDomainService.retrieveRelaxingDaysConfigForPivotDate()); |
| } |
| if (DateUtils.isAfter(pivotDate, transactionDate)) { |
| throw new TransactionBeforePivotDateNotAllowed(transactionDate, pivotDate); |
| } |
| } |
| } |
| |
| public void validate(final JsonCommand command) { |
| final String json = command.json(); |
| |
| if (StringUtils.isBlank(json)) { |
| throw new InvalidJsonException(); |
| } |
| |
| final Type typeOfMap = new TypeToken<Map<String, Object>>() {}.getType(); |
| this.fromApiJsonHelper.checkForUnsupportedParameters(typeOfMap, json, |
| SavingsAccountConstant.SAVINGS_ACCOUNT_TRANSACTION_REQUEST_DATA_PARAMETERS); |
| |
| final List<ApiParameterError> dataValidationErrors = new ArrayList<>(); |
| final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) |
| .resource(SavingsApiConstants.SAVINGS_ACCOUNT_TRANSACTION_RESOURCE_NAME); |
| |
| final JsonElement element = command.parsedJson(); |
| |
| final LocalDate transactionDate = this.fromApiJsonHelper.extractLocalDateNamed(transactionDateParamName, element); |
| baseDataValidator.reset().parameter(transactionDateParamName).value(transactionDate).notNull(); |
| |
| final BigDecimal transactionAmount = this.fromApiJsonHelper.extractBigDecimalWithLocaleNamed(transactionAmountParamName, element); |
| baseDataValidator.reset().parameter(transactionAmountParamName).value(transactionAmount).notNull().positiveAmount(); |
| |
| final Integer paymentType = this.fromApiJsonHelper.extractIntegerWithLocaleNamed(paymentTypeIdParamName, element); |
| baseDataValidator.reset().parameter(paymentTypeIdParamName).value(paymentType).notNull(); |
| |
| validatePaymentTypeDetails(baseDataValidator, element); |
| |
| throwExceptionIfValidationWarningsExist(dataValidationErrors); |
| } |
| |
| public void validateActivation(final JsonCommand command) { |
| final String json = command.json(); |
| |
| if (StringUtils.isBlank(json)) { |
| throw new InvalidJsonException(); |
| } |
| |
| final Type typeOfMap = new TypeToken<Map<String, Object>>() {}.getType(); |
| this.fromApiJsonHelper.checkForUnsupportedParameters(typeOfMap, json, |
| SavingsAccountConstant.SAVINGS_ACCOUNT_ACTIVATION_REQUEST_DATA_PARAMETERS); |
| |
| final List<ApiParameterError> dataValidationErrors = new ArrayList<>(); |
| final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) |
| .resource(SavingsApiConstants.SAVINGS_ACCOUNT_RESOURCE_NAME); |
| |
| final JsonElement element = command.parsedJson(); |
| |
| final LocalDate activationDate = this.fromApiJsonHelper.extractLocalDateNamed(activatedOnDateParamName, element); |
| baseDataValidator.reset().parameter(activatedOnDateParamName).value(activationDate).notNull(); |
| |
| throwExceptionIfValidationWarningsExist(dataValidationErrors); |
| } |
| |
| public void validateClosing(final JsonCommand command, final SavingsAccount account) { |
| final String json = command.json(); |
| |
| if (StringUtils.isBlank(json)) { |
| throw new InvalidJsonException(); |
| } |
| |
| final Type typeOfMap = new TypeToken<Map<String, Object>>() {}.getType(); |
| this.fromApiJsonHelper.checkForUnsupportedParameters(typeOfMap, json, |
| SavingsAccountConstant.SAVINGS_ACCOUNT_CLOSE_REQUEST_DATA_PARAMETERS); |
| |
| final List<ApiParameterError> dataValidationErrors = new ArrayList<>(); |
| final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) |
| .resource(SavingsApiConstants.SAVINGS_ACCOUNT_RESOURCE_NAME); |
| |
| final JsonElement element = command.parsedJson(); |
| |
| final LocalDate closedonDate = this.fromApiJsonHelper.extractLocalDateNamed(closedOnDateParamName, element); |
| baseDataValidator.reset().parameter(closedOnDateParamName).value(closedonDate).notNull(); |
| |
| if (this.fromApiJsonHelper.parameterExists(withdrawBalanceParamName, element)) { |
| final Boolean withdrawBalance = this.fromApiJsonHelper.extractBooleanNamed(withdrawBalanceParamName, element); |
| baseDataValidator.reset().parameter(withdrawBalanceParamName).value(withdrawBalance).isOneOfTheseValues(true, false); |
| } |
| |
| if (account.getSavingsHoldAmount().compareTo(BigDecimal.ZERO) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("amount.is.on.hold.release.the.amount.to.continue", |
| account.getId()); |
| } |
| |
| if (account.getSubStatus().equals(SavingsAccountSubStatusEnum.BLOCK.getValue()) |
| || account.getSubStatus().equals(SavingsAccountSubStatusEnum.BLOCK_CREDIT.getValue()) |
| || account.getSubStatus().equals(SavingsAccountSubStatusEnum.BLOCK_DEBIT.getValue())) { |
| baseDataValidator.reset().parameter(SavingsApiConstants.subStatusParamName) |
| .failWithCodeNoParameterAddedToErrorCode("account.is.in.blocked.state"); |
| } |
| |
| validatePaymentTypeDetails(baseDataValidator, element); |
| |
| throwExceptionIfValidationWarningsExist(dataValidationErrors); |
| } |
| |
| private void validatePaymentTypeDetails(final DataValidatorBuilder baseDataValidator, JsonElement element) { |
| // Validate all string payment detail fields for max length |
| boolean checkPaymentTypeDetails = false; |
| final Integer paymentTypeId = this.fromApiJsonHelper.extractIntegerWithLocaleNamed(paymentTypeIdParamName, element); |
| baseDataValidator.reset().parameter(paymentTypeIdParamName).value(paymentTypeId).ignoreIfNull().integerGreaterThanZero(); |
| final Set<String> paymentDetailParameters = new HashSet<>(Arrays.asList(transactionAccountNumberParamName, checkNumberParamName, |
| routingCodeParamName, receiptNumberParamName, bankNumberParamName)); |
| for (final String paymentDetailParameterName : paymentDetailParameters) { |
| final String paymentDetailParameterValue = this.fromApiJsonHelper.extractStringNamed(paymentDetailParameterName, element); |
| baseDataValidator.reset().parameter(paymentDetailParameterName).value(paymentDetailParameterValue).ignoreIfNull() |
| .notExceedingLengthOf(50); |
| if (paymentDetailParameterValue != null && !paymentDetailParameterValue.equals("")) { |
| checkPaymentTypeDetails = true; |
| } |
| } |
| if (checkPaymentTypeDetails) { |
| baseDataValidator.reset().parameter(paymentTypeIdParamName).value(paymentTypeId).notBlank().integerGreaterThanZero(); |
| } |
| |
| } |
| |
| public void validateHoldAndAssembleForm(final String json, final SavingsAccount account, final AppUser createdUser, |
| final boolean backdatedTxnsAllowedTill) { |
| |
| if (StringUtils.isBlank(json)) { |
| throw new InvalidJsonException(); |
| } |
| |
| final Type typeOfMap = new TypeToken<Map<String, Object>>() {}.getType(); |
| this.fromApiJsonHelper.checkForUnsupportedParameters(typeOfMap, json, SAVINGS_ACCOUNT_HOLD_AMOUNT_REQUEST_DATA_PARAMETERS); |
| |
| final List<ApiParameterError> dataValidationErrors = new ArrayList<>(); |
| final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) |
| .resource(SAVINGS_ACCOUNT_RESOURCE_NAME); |
| |
| final JsonElement element = this.fromApiJsonHelper.parse(json); |
| |
| final BigDecimal amount = this.fromApiJsonHelper.extractBigDecimalWithLocaleNamed(transactionAmountParamName, element); |
| baseDataValidator.reset().parameter(transactionAmountParamName).value(amount).notNull().positiveAmount(); |
| final LocalDate transactionDate = this.fromApiJsonHelper.extractLocalDateNamed(transactionDateParamName, element); |
| |
| final String reasonForBlock = this.fromApiJsonHelper.extractStringNamed(SavingsApiConstants.reasonForBlockParamName, element); |
| baseDataValidator.reset().parameter(SavingsApiConstants.reasonForBlockParamName).value(reasonForBlock).notBlank() |
| .notExceedingLengthOf(100); |
| |
| baseDataValidator.reset().parameter(transactionDateParamName).value(transactionDate).notNull(); |
| boolean isActive = account.isActive(); |
| |
| if (!isActive) { |
| baseDataValidator.reset().parameter(SavingsApiConstants.statusParamName) |
| .failWithCodeNoParameterAddedToErrorCode(SavingsApiConstants.ERROR_MSG_SAVINGS_ACCOUNT_NOT_ACTIVE); |
| } |
| |
| Boolean isEnforceMinRequiredBalanceEnabled = account.getEnforceMinRequiredBalance(); |
| Boolean isAccountLienEnabled = account.isLienAllowed(); |
| Boolean isOverdraftEnabled = account.isAllowOverdraft(); |
| |
| Boolean lienAllowed = false; |
| if (BooleanUtils.isTrue(fromApiJsonHelper.extractBooleanNamed(lienAllowedParamName, element))) { |
| lienAllowed = this.fromApiJsonHelper.extractBooleanNamed(lienAllowedParamName, element); |
| if (isAccountLienEnabled) { |
| if (isOverdraftEnabled) { |
| if (account.getOverdraftLimit().compareTo(account.getMaxAllowedLienLimit()) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode( |
| "Overdraft.limit.can.not.be.greater.than.lien.limit", account.getId()); |
| } |
| } |
| if (amount.compareTo(account.getMaxAllowedLienLimit()) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("lien.limit.exceeded", account.getId()); |
| } |
| } else { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("lien.is.not.allowed.in.product.level", account.getId()); |
| } |
| } else { |
| if (isOverdraftEnabled) { |
| if (amount.compareTo(account.getWithdrawableBalance()) > 0 && amount.compareTo(account.getOverdraftLimit()) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("insufficient.balance", account.getId()); |
| } |
| } |
| if (isEnforceMinRequiredBalanceEnabled) { |
| if (amount.compareTo(account.getWithdrawableBalance()) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("insufficient.balance", account.getId()); |
| } |
| } |
| if (!isOverdraftEnabled && !isEnforceMinRequiredBalanceEnabled) { |
| if (amount.compareTo(account.getWithdrawableBalance()) > 0) { |
| baseDataValidator.reset().failWithCodeNoParameterAddedToErrorCode("insufficient.balance", account.getId()); |
| } |
| } |
| } |
| LocalDate lastTransactionDate = null; |
| |
| if (!backdatedTxnsAllowedTill) { |
| lastTransactionDate = account.retrieveLastTransactionDate(); |
| } else { |
| lastTransactionDate = account.retrieveLastTransactionDateWithPivotConfig(); |
| } |
| |
| // compare two dates now |
| if (DateUtils.isBefore(transactionDate, lastTransactionDate)) { |
| baseDataValidator.parameter(SavingsApiConstants.dateParamName).value(lastTransactionDate).failWithCode( |
| "validation.msg.date.can.not.be.before.last.transaction.date", "Amount can be put on hold only after last transaction"); |
| } |
| |
| throwExceptionIfValidationWarningsExist(dataValidationErrors); |
| } |
| |
| public SavingsAccountTransaction validateReleaseAmountAndAssembleForm(final SavingsAccountTransaction holdTransaction) { |
| final List<ApiParameterError> dataValidationErrors = new ArrayList<>(); |
| final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors) |
| .resource(SAVINGS_ACCOUNT_RESOURCE_NAME); |
| |
| if (holdTransaction == null) { |
| baseDataValidator.failWithCode("validation.msg.validation.errors.exist", "Transaction not found"); |
| } else if (holdTransaction.getReleaseIdOfHoldAmountTransaction() != null) { |
| baseDataValidator.parameter(SavingsApiConstants.amountParamName).value(holdTransaction.getAmount()) |
| .failWithCode("validation.msg.amount.is.not.on.hold", "Transaction amount is not on hold"); |
| } |
| |
| if (holdTransaction != null) { |
| boolean isActive = holdTransaction.getSavingsAccount().isActive(); |
| if (!isActive) { |
| baseDataValidator.reset().parameter(SavingsApiConstants.statusParamName) |
| .failWithCodeNoParameterAddedToErrorCode(SavingsApiConstants.ERROR_MSG_SAVINGS_ACCOUNT_NOT_ACTIVE); |
| } |
| } |
| |
| throwExceptionIfValidationWarningsExist(dataValidationErrors); |
| LocalDate transactionDate = DateUtils.getBusinessLocalDate(); |
| SavingsAccountTransaction transaction = SavingsAccountTransaction.releaseAmount(holdTransaction, transactionDate); |
| return transaction; |
| } |
| |
| private void throwExceptionIfValidationWarningsExist(final List<ApiParameterError> dataValidationErrors) { |
| if (!dataValidationErrors.isEmpty()) { |
| // |
| throw new PlatformApiDataValidationException("validation.msg.validation.errors.exist", "Validation errors exist.", |
| dataValidationErrors); |
| } |
| } |
| } |
