Skip to content

FINERACT-2245: Mix Taxonomy (org.apache.fineract.mix) #4635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,24 @@

import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DefaultValue;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.HeaderParam;
import jakarta.ws.rs.PUT;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.util.UUID;
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.infrastructure.core.serialization.ToApiJsonSerializer;
import org.apache.fineract.command.core.CommandPipeline;
import org.apache.fineract.infrastructure.core.service.ThreadLocalContextUtil;
import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.mix.data.MixTaxonomyMappingData;
import org.apache.fineract.mix.data.MixTaxonomyRequest;
import org.apache.fineract.mix.command.MixTaxonomyCommand;
import org.apache.fineract.mix.data.MixTaxonomyMappingRequest;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;
import org.apache.fineract.mix.service.MixTaxonomyMappingReadPlatformService;
import org.springframework.stereotype.Component;

Expand All @@ -44,30 +48,37 @@
public class MixTaxonomyMappingApiResource {

private final PlatformSecurityContext context;
private final ToApiJsonSerializer<MixTaxonomyMappingData> toApiJsonSerializer;
private final MixTaxonomyMappingReadPlatformService readTaxonomyMappingService;
private final PortfolioCommandSourceWritePlatformService commandsSourceWritePlatformService;
private final CommandPipeline pipeline;

@GET
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public MixTaxonomyMappingData retrieveTaxonomyMapping() {
public MixTaxonomyMappingResponse retrieveTaxonomyMapping() {
this.context.authenticatedUser();
return this.readTaxonomyMappingService.retrieveTaxonomyMapping();
}

// TODO support multiple configuration file loading ?
@PUT
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
public String updateTaxonomyMapping(final MixTaxonomyRequest mixTaxonomyRequest) {
// TODO support multiple configuration file loading
public MixTaxonomyMappingResponse updateTaxonomyMapping(@HeaderParam("Idempotency-Key") @DefaultValue("") String idempotencyKey,
final MixTaxonomyMappingRequest request) {

final Long mappingId = (long) 1;
final CommandWrapper commandRequest = new CommandWrapperBuilder().updateTaxonomyMapping(mappingId)
.withJson(toApiJsonSerializer.serialize(mixTaxonomyRequest)).build();
var command = new MixTaxonomyCommand();

String tenantIdentifier = ThreadLocalContextUtil.getTenant().getTenantIdentifier();
command.setId(UUID.randomUUID());
command.setCreatedAt(OffsetDateTime.now(ZoneId.of("UTC")));
command.setTenantId(tenantIdentifier);

final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);
request.setMappingId(mappingId);
command.setPayload(request);

return this.toApiJsonSerializer.serialize(result);
Supplier<MixTaxonomyMappingResponse> result = pipeline.send(command);
return result.get();
}

}
Original file line number Diff line number Diff line change
@@ -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.mix.command;

import lombok.Data;
import lombok.EqualsAndHashCode;
import org.apache.fineract.command.core.Command;
import org.apache.fineract.mix.data.MixTaxonomyMappingRequest;

@Data
@EqualsAndHashCode(callSuper = true)
public class MixTaxonomyCommand extends Command<MixTaxonomyMappingRequest> {}
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,25 @@
*/
package org.apache.fineract.mix.data;

import com.fasterxml.jackson.annotation.JsonInclude;
import io.swagger.v3.oas.annotations.Hidden;
import java.io.Serial;
import java.io.Serializable;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@NoArgsConstructor
@Accessors(chain = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class MixTaxonomyMappingData {
@AllArgsConstructor
public class MixTaxonomyMappingRequest implements Serializable {

@Serial
private static final long serialVersionUID = 1L;

@Hidden
private Long mappingId;

private String identifier;
private String config;
private String currency;
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class MixTaxonomyRequest implements Serializable {
@Accessors(chain = true)
public class MixTaxonomyMappingResponse implements Serializable {

@Serial
private static final long serialVersionUID = 1L;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,19 @@
*/
package org.apache.fineract.mix.handler;

import org.apache.fineract.command.core.Command;
import org.apache.fineract.command.core.CommandHandler;
import org.apache.fineract.commands.annotation.CommandType;
import org.apache.fineract.commands.handler.NewCommandSourceHandler;
import org.apache.fineract.infrastructure.core.api.JsonCommand;
import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
import org.apache.fineract.mix.data.MixTaxonomyMappingRequest;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;
import org.apache.fineract.mix.service.MixTaxonomyMappingWritePlatformService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
@CommandType(entity = "XBRLMAPPING", action = "UPDATE")
public class UpdateTaxonomyMappingCommandHandler implements NewCommandSourceHandler {
public class UpdateTaxonomyMappingCommandHandler implements CommandHandler<MixTaxonomyMappingRequest, MixTaxonomyMappingResponse> {

private final MixTaxonomyMappingWritePlatformService writeTaxonomyService;

Expand All @@ -40,8 +41,8 @@ public UpdateTaxonomyMappingCommandHandler(final MixTaxonomyMappingWritePlatform

@Transactional
@Override
public CommandProcessingResult processCommand(final JsonCommand command) {
return this.writeTaxonomyService.updateMapping(command.entityId(), command);
public MixTaxonomyMappingResponse handle(Command<MixTaxonomyMappingRequest> command) {
return this.writeTaxonomyService.updateMapping(command);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
*/
package org.apache.fineract.mix.service;

import org.apache.fineract.mix.data.MixTaxonomyMappingData;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;

public interface MixTaxonomyMappingReadPlatformService {

MixTaxonomyMappingData retrieveTaxonomyMapping();
MixTaxonomyMappingResponse retrieveTaxonomyMapping();
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import java.sql.ResultSet;
import java.sql.SQLException;
import lombok.RequiredArgsConstructor;
import org.apache.fineract.mix.data.MixTaxonomyMappingData;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
Expand All @@ -31,23 +31,23 @@ public class MixTaxonomyMappingReadPlatformServiceImpl implements MixTaxonomyMap

private final JdbcTemplate jdbcTemplate;

private static final class TaxonomyMappingMapper implements RowMapper<MixTaxonomyMappingData> {
private static final class TaxonomyMappingMapper implements RowMapper<MixTaxonomyMappingResponse> {

public String schema() {
return "identifier, config " + "from mix_taxonomy_mapping";
}

@Override
public MixTaxonomyMappingData mapRow(final ResultSet rs, @SuppressWarnings("unused") final int rowNum) throws SQLException {
public MixTaxonomyMappingResponse mapRow(final ResultSet rs, @SuppressWarnings("unused") final int rowNum) throws SQLException {
final String identifier = rs.getString("identifier");
final String config = rs.getString("config");
return new MixTaxonomyMappingData().setIdentifier(identifier).setConfig(config);
return new MixTaxonomyMappingResponse().setIdentifier(identifier).setConfig(config);
}

}

@Override
public MixTaxonomyMappingData retrieveTaxonomyMapping() {
public MixTaxonomyMappingResponse retrieveTaxonomyMapping() {
try {
final TaxonomyMappingMapper rm = new TaxonomyMappingMapper();
final String sqlString = "select " + rm.schema();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@
*/
package org.apache.fineract.mix.service;

import org.apache.fineract.infrastructure.core.api.JsonCommand;
import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
import org.apache.fineract.command.core.Command;
import org.apache.fineract.mix.data.MixTaxonomyMappingRequest;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;

public interface MixTaxonomyMappingWritePlatformService {

CommandProcessingResult updateMapping(Long mappingId, JsonCommand command);
MixTaxonomyMappingResponse updateMapping(Command<MixTaxonomyMappingRequest> command);
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
package org.apache.fineract.mix.service;

import lombok.RequiredArgsConstructor;
import org.apache.fineract.infrastructure.core.api.JsonCommand;
import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
import org.apache.fineract.infrastructure.core.data.CommandProcessingResultBuilder;
import org.apache.fineract.command.core.Command;
import org.apache.fineract.mix.data.MixTaxonomyMappingRequest;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;
import org.apache.fineract.mix.domain.MixTaxonomyMapping;
import org.apache.fineract.mix.domain.MixTaxonomyMappingRepository;
import org.springframework.dao.DataIntegrityViolationException;
Expand All @@ -35,21 +35,23 @@ public class MixTaxonomyMappingWritePlatformServiceImpl implements MixTaxonomyMa

@Transactional
@Override
public CommandProcessingResult updateMapping(final Long mappingId, final JsonCommand command) {
public MixTaxonomyMappingResponse updateMapping(Command<MixTaxonomyMappingRequest> command) {
Long mappingId = command.getPayload().getMappingId();

try {
MixTaxonomyMapping mapping = this.mappingRepository.findById(mappingId).orElse(null);
if (mapping == null) {
mapping = MixTaxonomyMapping.fromJson(command);
} else {
mapping.update(command);
mapping = new MixTaxonomyMapping();
}
mapping.setIdentifier(command.getPayload().getIdentifier());
mapping.setConfig(command.getPayload().getConfig());
mapping.setCurrency(command.getPayload().getCurrency());

this.mappingRepository.saveAndFlush(mapping);

return new CommandProcessingResultBuilder().withCommandId(command.commandId()).withEntityId(mapping.getId()).build();
MixTaxonomyMapping result = this.mappingRepository.saveAndFlush(mapping);

return new MixTaxonomyMappingResponse(result.getIdentifier(), result.getConfig());
} catch (final JpaSystemException | DataIntegrityViolationException dve) {
return CommandProcessingResult.empty();
return new MixTaxonomyMappingResponse();
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import javax.script.ScriptException;
import lombok.extern.slf4j.Slf4j;
import org.apache.fineract.mix.data.MixTaxonomyData;
import org.apache.fineract.mix.data.MixTaxonomyMappingData;
import org.apache.fineract.mix.data.MixTaxonomyMappingResponse;
import org.apache.fineract.mix.data.XBRLData;
import org.apache.fineract.mix.exception.XBRLMappingInvalidException;
import org.springframework.beans.factory.annotation.Autowired;
Expand Down Expand Up @@ -70,7 +70,7 @@ public XBRLData getXBRLResult(final Date startDate, final Date endDate, final St

@SuppressWarnings("unchecked")
private HashMap<MixTaxonomyData, BigDecimal> retrieveTaxonomyConfig(final Date startDate, final Date endDate) {
final MixTaxonomyMappingData taxonomyMapping = this.readTaxonomyMappingService.retrieveTaxonomyMapping();
final MixTaxonomyMappingResponse taxonomyMapping = this.readTaxonomyMappingService.retrieveTaxonomyMapping();
if (taxonomyMapping == null) {
return null;
}
Expand Down
Loading