org.openlmis.fulfillment.web.BaseController.java Source code

Introduction

Here is the source code for org.openlmis.fulfillment.web.BaseController.java

Source

/*
 * This program is part of the OpenLMIS logistics management information system platform software.
 * Copyright  2017 VillageReach
 *
 * This program is free software: you can redistribute it and/or modify it under the terms
 * of the GNU Affero General Public License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details. You should have received a copy of
 * the GNU Affero General Public License along with this program. If not, see
 * http://www.gnu.org/licenses. For additional information contact info@OpenLMIS.org.
 */

package org.openlmis.fulfillment.web;

import static java.util.Comparator.comparing;
import static org.openlmis.fulfillment.service.ResourceNames.BASE_PATH;

import com.google.common.collect.Lists;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import javax.annotation.Resource;
import org.apache.commons.lang3.StringUtils;
import org.javers.core.Javers;
import org.javers.core.diff.Change;
import org.javers.core.json.JsonConverter;
import org.javers.repository.jql.QueryBuilder;
import org.openlmis.fulfillment.service.ObjReferenceExpander;
import org.openlmis.fulfillment.util.Pagination;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Pageable;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.RequestMapping;

@RequestMapping(BASE_PATH)
public abstract class BaseController {

    @Resource(name = "javersProvider")
    private Javers javers;

    @Autowired
    private ObjReferenceExpander objReferenceExpander;

    protected void expandDto(Object dto, Set<String> expands) {
        objReferenceExpander.expandDto(dto, expands);
    }

    Map<String, String> getErrors(BindingResult bindingResult) {
        return bindingResult.getFieldErrors().stream()
                .collect(Collectors.toMap(FieldError::getField, FieldError::getCode));
    }

    ResponseEntity<String> getAuditLogResponse(Map<UUID, Class> pairs, String author, String changedPropertyName,
            Pageable page) {
        String auditLogs = getAuditLog(pairs, author, changedPropertyName, page);

        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);

        return new ResponseEntity<>(auditLogs, headers, HttpStatus.OK);
    }

    /**
     * Return a list of changes via JSON.
     *
     * @param pairs               The map that contain as a key the ID of class for which we wish to
     *                            retrieve historical changes and as a value the type of class for
     *                            which we wish to retrieve historical changes.
     * @param author              The author of the changes which should be returned.
     *                            If null or empty, changes are returned regardless of author.
     * @param changedPropertyName The name of the property about which changes should be returned.
     *                            If null or empty, changes associated with any and all properties
     *                            are returned.
     * @param page                A Pageable object with PageNumber and PageSize values used
     *                            for pagination.
     */
    private String getAuditLog(Map<UUID, Class> pairs, String author, String changedPropertyName, Pageable page) {
        List<Change> changes = getChanges(pairs, author, changedPropertyName, page);
        JsonConverter jsonConverter = javers.getJsonConverter();
        return jsonConverter.toJson(changes);
    }

    /*
      Return JaVers changes for the specified type, optionally filtered by id, author, and property.
      We need to pass a map of pairs for aggregate and child classes because of:
      https://stackoverflow.com/q/44386270
      https://stackoverflow.com/q/39826142
    */
    private List<Change> getChanges(Map<UUID, Class> pairs, String author, String changedPropertyName,
            Pageable page) {
        List<Change> changes = Lists.newArrayList();

        for (Entry<UUID, Class> pair : pairs.entrySet()) {
            QueryBuilder queryBuilder = QueryBuilder.byInstanceId(pair.getKey(), pair.getValue())
                    .withNewObjectChanges();

            if (StringUtils.isNotBlank(author)) {
                queryBuilder = queryBuilder.byAuthor(author);
            }

            if (StringUtils.isNotBlank(changedPropertyName)) {
                queryBuilder = queryBuilder.andProperty(changedPropertyName);
            }

            changes.addAll(javers.findChanges(queryBuilder.build()));
        }

        changes.sort(comparing((Change change) -> change.getCommitMetadata().get().getCommitDate()).reversed());

        return Pagination.getPage(changes, page).getContent();
    }

}