| /* |
| * 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.cn.reporting.service.rest; |
| |
| import com.google.gson.Gson; |
| import com.google.gson.GsonBuilder; |
| import org.apache.fineract.cn.reporting.api.v1.EventConstants; |
| import org.apache.fineract.cn.reporting.api.v1.PermittableGroupIds; |
| import org.apache.fineract.cn.reporting.api.v1.domain.ReportDefinition; |
| import org.apache.fineract.cn.reporting.api.v1.domain.ReportPage; |
| import org.apache.fineract.cn.reporting.api.v1.domain.ReportRequest; |
| import org.apache.fineract.cn.reporting.service.ServiceConstants; |
| import org.apache.fineract.cn.reporting.service.internal.provider.ReportSpecificationProvider; |
| import org.apache.fineract.cn.reporting.service.spi.ReportSpecification; |
| import java.util.List; |
| import java.util.Optional; |
| import org.apache.fineract.cn.anubis.annotation.AcceptedTokenType; |
| import org.apache.fineract.cn.anubis.annotation.Permittable; |
| import org.apache.fineract.cn.lang.ApplicationName; |
| import org.apache.fineract.cn.lang.ServiceException; |
| import org.apache.fineract.cn.lang.TenantContextHolder; |
| import org.apache.fineract.cn.lang.config.TenantHeaderFilter; |
| import org.slf4j.Logger; |
| import org.springframework.beans.factory.annotation.Autowired; |
| import org.springframework.beans.factory.annotation.Qualifier; |
| import org.springframework.http.MediaType; |
| import org.springframework.http.ResponseEntity; |
| import org.springframework.jms.core.JmsTemplate; |
| import org.springframework.web.bind.annotation.PathVariable; |
| import org.springframework.web.bind.annotation.RequestBody; |
| import org.springframework.web.bind.annotation.RequestMapping; |
| import org.springframework.web.bind.annotation.RequestMethod; |
| import org.springframework.web.bind.annotation.RequestParam; |
| import org.springframework.web.bind.annotation.ResponseBody; |
| import org.springframework.web.bind.annotation.RestController; |
| |
| @SuppressWarnings("unused") |
| @RestController |
| @RequestMapping("/") |
| public class ReportingRestController { |
| |
| private final Logger logger; |
| private final ReportSpecificationProvider reportSpecificationProvider; |
| private final ApplicationName applicationName; |
| private final JmsTemplate jmsTemplate; |
| |
| @Autowired |
| public ReportingRestController(@Qualifier(ServiceConstants.LOGGER_NAME) final Logger logger, |
| final ReportSpecificationProvider reportSpecificationProvider, |
| final ApplicationName applicationName, |
| final JmsTemplate jmsTemplate) { |
| super(); |
| this.logger = logger; |
| this.reportSpecificationProvider = reportSpecificationProvider; |
| this.applicationName = applicationName; |
| this.jmsTemplate = jmsTemplate; |
| } |
| |
| @Permittable(value = AcceptedTokenType.SYSTEM) |
| @RequestMapping( |
| value = "/initialize", |
| method = RequestMethod.POST, |
| consumes = MediaType.ALL_VALUE, |
| produces = MediaType.APPLICATION_JSON_VALUE |
| ) |
| public |
| @ResponseBody |
| ResponseEntity<Void> initialize() { |
| final Gson gson = new GsonBuilder().create(); |
| this.jmsTemplate.convertAndSend( |
| gson.toJson(this.applicationName.getVersionString()), |
| message -> { |
| if (TenantContextHolder.identifier().isPresent()) { |
| message.setStringProperty( |
| TenantHeaderFilter.TENANT_HEADER, |
| TenantContextHolder.checkedGetIdentifier()); |
| } |
| message.setStringProperty( |
| EventConstants.SELECTOR_NAME, |
| EventConstants.INITIALIZE |
| ); |
| return message; |
| } |
| ); |
| |
| return ResponseEntity.ok().build(); |
| } |
| |
| @Permittable(value = AcceptedTokenType.TENANT, groupId = PermittableGroupIds.REPORT_MANAGEMENT) |
| @RequestMapping( |
| value = "/categories", |
| method = RequestMethod.GET, |
| produces = MediaType.APPLICATION_JSON_VALUE, |
| consumes = MediaType.ALL_VALUE |
| ) |
| public |
| ResponseEntity<List<String>> fetchCategories() { |
| return ResponseEntity.ok(this.reportSpecificationProvider.getAvailableCategories()); |
| } |
| |
| @Permittable(value = AcceptedTokenType.TENANT, groupId = PermittableGroupIds.REPORT_MANAGEMENT) |
| @RequestMapping( |
| value = "categories/{category}", |
| method = RequestMethod.GET, |
| produces = MediaType.APPLICATION_JSON_VALUE, |
| consumes = MediaType.ALL_VALUE) |
| public |
| ResponseEntity<List<ReportDefinition>> fetchReportDefinitions(@PathVariable("category") final String category) { |
| return ResponseEntity.ok(this.reportSpecificationProvider.getAvailableReports(category)); |
| } |
| |
| @Permittable(value = AcceptedTokenType.TENANT, groupId = PermittableGroupIds.REPORT_MANAGEMENT) |
| @RequestMapping( |
| value = "/categories/{category}/reports/{identifier}", |
| method = RequestMethod.POST, |
| produces = MediaType.APPLICATION_JSON_VALUE, |
| consumes = MediaType.APPLICATION_JSON_VALUE |
| ) |
| public |
| ResponseEntity<ReportPage> generateReport(@PathVariable("category") final String category, |
| @PathVariable("identifier") final String identifier, |
| @RequestBody final ReportRequest reportRequest, |
| @RequestParam(value = "pageIndex", required = false) final Integer pageIndex, |
| @RequestParam(value = "size", required = false) final Integer size) { |
| |
| final Optional<ReportSpecification> optionalReportSpecification = |
| this.reportSpecificationProvider.getReportSpecification(category, identifier); |
| if (optionalReportSpecification.isPresent()) { |
| final ReportSpecification reportSpecification = optionalReportSpecification.get(); |
| |
| try { |
| reportSpecification.validate(reportRequest); |
| } catch (final IllegalArgumentException iaex) { |
| throw ServiceException.badRequest(iaex.getMessage()); |
| } |
| |
| return ResponseEntity.ok(reportSpecification.generateReport(reportRequest, pageIndex, size)); |
| } else { |
| throw ServiceException.notFound("Report {0} not found.", identifier); |
| } |
| } |
| |
| @Permittable(value = AcceptedTokenType.TENANT, groupId = PermittableGroupIds.REPORT_MANAGEMENT) |
| @RequestMapping( |
| value = "categories/{category}/definitions/{identifier}", |
| method = RequestMethod.GET, |
| produces = MediaType.APPLICATION_JSON_VALUE, |
| consumes = MediaType.ALL_VALUE) |
| public |
| ResponseEntity<ReportDefinition> findReportDefinition( |
| @PathVariable("category") final String category, |
| @PathVariable("identifier") final String identifier) { |
| return ResponseEntity.ok( |
| this.reportSpecificationProvider.findReportDefinition(category, identifier) |
| .orElseThrow(() -> ServiceException.notFound("Report definition {0} not found.", identifier)) |
| ); |
| } |
| } |