view common/mongodb/src/main/java/com/redhat/thermostat/gateway/common/mongodb/response/MongoMetaDataGenerator.java @ 286:4375a5dd5ec8

Fix bug in metadata payloadCount values. Reviewed-by: jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-October/025403.html
author Chris Lessard <clessard@redhat.com>
date Thu, 19 Oct 2017 12:04:56 -0400
parents 3055303a670f
children
line wrap: on
line source

/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.gateway.common.mongodb.response;

import java.util.Map;

import com.redhat.thermostat.gateway.common.core.servlet.CommonQueryParams;
import com.redhat.thermostat.gateway.common.core.servlet.RequestParameters;
import com.redhat.thermostat.gateway.common.mongodb.executor.MongoDataResultContainer;

public class MongoMetaDataGenerator {

    private final Integer limit;
    private final Integer offset;
    private final String sort;
    private final String queries;
    private final String includes;
    private final String excludes;
    private final MongoDataResultContainer execResult;
    private final Map<String, String> requestParamArguments;
    private final String baseURL;

    private static final int UNLIMITED = 0;

    public MongoMetaDataGenerator(CommonQueryParams params,
                                  Map<String, String> requestParamArguments, MongoDataResultContainer execResult, String baseUrl) {
        this.limit = params.getLimit();
        this.offset = params.getOffset();
        this.sort = params.getSort();
        this.queries = params.getQueries();
        this.includes = params.getIncludes();
        this.excludes = params.getExcludes();
        this.execResult = execResult;
        this.requestParamArguments = requestParamArguments;
        this.baseURL = baseUrl;
    }

    public void setDocAndPayloadCount(MongoMetaDataResponseBuilder.MetaBuilder response) {
        if (!"".equals(queries)) {
            Integer docCount = (int) execResult.getGetReqCount();
            Integer payloadCount = generatePayloadCount(offset, limit, docCount);

            response.count(docCount).payloadCount(payloadCount);
        }
    }

    // For testing purposes
    int generatePayloadCount(int offset, int limit, int docCount) {
        int payloadCount = 0;

        if (offset < 0 || limit < 0) {
            throw new IllegalArgumentException();
        }

        if (offset == 0) {
            if (limit == UNLIMITED) {
                return docCount;
            }

            return (docCount < limit) ? docCount : limit;
        } else if (offset > 0 && offset < docCount) {
            int diff = offset + limit;
            payloadCount = (diff > docCount || diff <= docCount && limit == UNLIMITED) ? docCount - offset : limit;
        }

        return payloadCount;
    }

    public void setPrev(MongoMetaDataResponseBuilder.MetaBuilder response) {
        if (!Integer.valueOf(0).equals(offset)) {
            StringBuilder prev = new StringBuilder();
            prev.append(baseURL).append("?").append(response.getQueryArgumentsNoOffsetLimit(requestParamArguments));

            if (limit > 1) {
                int newLim = (offset >= limit) ? limit : offset;
                int newOff = (offset >= limit) ? (offset - limit) : 0;
                prev.append("&").append(RequestParameters.LIMIT + '=').append(newLim).append("&").append(RequestParameters.OFFSET + '=').append(newOff);
            } else {
                prev.append("&").append(RequestParameters.LIMIT + '=').append(offset);
            }

            response.prev(prev.toString());
        }
    }

    public void setNext(MongoMetaDataResponseBuilder.MetaBuilder response) {
        if (!"".equals(queries)) {
            int remaining = execResult.getRemainingNumQueryDocuments();
            if (!limit.equals(0) && remaining != 0) {
                StringBuilder next = new StringBuilder();
                int nextLimit = (remaining > limit) ? limit : remaining;
                next.append(baseURL).append('?' + RequestParameters.OFFSET + '=').append(offset + limit).append('&' + RequestParameters.LIMIT + '=').append(nextLimit).append("&");

                next.append(response.getQueryArgumentsNoOffsetLimit(requestParamArguments));

                response.payloadCount(nextLimit).next(next.toString());
            }
        }
    }

}