view common/core/src/main/java/com/redhat/thermostat/gateway/common/core/servlet/CommonQueryParams.java @ 266:3055303a670f

Add CommonQueryParams class This patch defines and passes around a CommonQueryParams class, to be used by all the HTTP GET handlers. The class collects and verifies the limit/offset/sort/query/include/exclude/metadata parameters instead of passing them around individually as parameters within the framework. Using this class makes the code simpler and allows for consistent handling of parameters (without it, only some endpoints verified 'offset' was not negative, for instance). This class also allows new common GET parameters tto be added trivially. Reviewed-by: sgehwolf Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-September/024999.html
author Simon Tooke <stooke@redhat.com>
date Tue, 26 Sep 2017 11:41:34 -0400
parents
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.core.servlet;

import com.redhat.thermostat.gateway.common.core.model.LimitParameter;
import com.redhat.thermostat.gateway.common.core.model.OffsetParameter;

import java.util.LinkedHashMap;
import java.util.Map;

public class CommonQueryParams {

    private final boolean returnMetadata;
    private final int limit;
    private final int offset;
    private final String sort;
    private final String queries;
    private final String includes;
    private final String excludes;

    public CommonQueryParams(LimitParameter limit, OffsetParameter offset, String sort, String queries, String includes, String excludes, Boolean returnMetadata) {
        this(limit.getValue(), offset.getValue(), sort, queries, includes, excludes, returnMetadata);
    }

    public CommonQueryParams(int limit, int offset, String sort, String queries, String includes, String excludes, boolean returnMetadata) {
        this.limit = limit;
        this.offset = offset;
        this.sort = sort;
        this.queries = queries;
        this.includes = includes;
        this.excludes = excludes;
        this.returnMetadata = returnMetadata;
    }

    public Map<String, String> buildParams() {
        // Test suites expect a consistent order of next and prev links, hence LinkedHashMap
        LinkedHashMap<String, String> paramArgs = new LinkedHashMap<>();
        paramArgs.put(RequestParameters.SORT, sort);
        paramArgs.put(RequestParameters.QUERY, queries);
        paramArgs.put(RequestParameters.INCLUDE, includes);
        paramArgs.put(RequestParameters.EXCLUDE, excludes);
        paramArgs.put(RequestParameters.METADATA, String.valueOf(returnMetadata));
        paramArgs.put(RequestParameters.LIMIT, String.valueOf(limit));
        paramArgs.put(RequestParameters.OFFSET, String.valueOf(offset));
        return paramArgs;
    }

    public int getLimit() {
        return limit;
    }

    public int getOffset() {
        return offset;
    }

    public String getSort() {
        return sort;
    }

    public String getQueries() {
        return queries;
    }

    public String getIncludes() {
        return includes;
    }

    public String getExcludes() {
        return excludes;
    }

    public boolean isReturnMetadata() {
        return returnMetadata;
    }
}