org.restheart.mongodb.hal.AbstractRepresentationFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-mongodb Show documentation
RESTHeart MongoDB - MongoDB plugin
There is a newer version: 8.1.5
/*-
 * ========================LICENSE_START=================================
 * restheart-mongodb
 * %%
 * Copyright (C) 2014 - 2024 SoftInstigate
 * %%
 * 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 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 .
 * =========================LICENSE_END==================================
 */
package org.restheart.mongodb.hal;

import io.undertow.server.HttpServerExchange;
import static java.lang.Math.toIntExact;
import java.util.TreeMap;
import org.bson.BsonArray;
import org.bson.BsonInt32;
import org.restheart.exchange.IllegalQueryParamenterException;
import org.restheart.exchange.MongoRequest;
import org.restheart.mongodb.utils.MongoURLUtils;
import org.restheart.utils.RepresentationUtils;

/**
 *
 * @author Maurizio Turatti {@literal }
 */
abstract class AbstractRepresentationFactory {

    /**
     *
     * @param exchange
     * @param embeddedData
     * @param size
     * @return the resource HAL representation
     * @throws IllegalQueryParamenterException
     */
    public abstract Resource getRepresentation(
            HttpServerExchange exchange,
            BsonArray embeddedData,
            long size)
            throws IllegalQueryParamenterException;

    /**
     *
     * @param size
     * @param request
     * @param rep
     */
    protected void addSizeAndTotalPagesProperties(
            final long size,
            MongoRequest request,
            final Resource rep) {

        if (size == 0) {
            rep.addProperty("_size", new BsonInt32(0));

            if (request.getPagesize() > 0) {
                rep.addProperty("_total_pages", new BsonInt32(0));
            }
        }

        if (size > 0) {
            float _size = size + 0f;
            float _pagesize = request.getPagesize() + 0f;

            rep.addProperty("_size", new BsonInt32(toIntExact(size)));

            if (request.getPagesize() > 0) {
                rep.addProperty("_total_pages", new BsonInt32(
                        toIntExact(
                                Math.max(1,
                                        Math.round(
                                                Math.ceil(_size / _pagesize)
                                        )))));
            }
        }
    }

    /**
     *
     * @param embeddedData
     * @param rep
     */
    protected void addReturnedProperty(
            final BsonArray embeddedData,
            final Resource rep) {
        long count = embeddedData == null ? 0 : embeddedData.size();

        rep.addProperty("_returned", new BsonInt32(toIntExact(count)));
    }

    /**
     *
     * @param exchange
     * @param requestPath
     * @return
     */
    protected Resource createRepresentation(
            final HttpServerExchange exchange,
            final String requestPath) {
        var request = MongoRequest.of(exchange);
        String queryString
                = exchange.getQueryString() == null
                || exchange.getQueryString().isEmpty()
                ? ""
                : "?" + MongoURLUtils.decodeQueryString(
                        exchange.getQueryString());

        Resource rep;

        if (requestPath != null || request.isFullHalMode()) {
            rep = new Resource(requestPath + queryString);
        } else {
            rep = new Resource();
        }

        return rep;
    }

    /**
     *
     * @param exchange
     * @return
     */
    protected String buildRequestPath(final HttpServerExchange exchange) {
        String requestPath = MongoURLUtils.removeTrailingSlashes(
                exchange.getRequestPath());
        return requestPath;
    }

    /**
     *
     * @param exchange
     * @param size
     * @param rep
     * @throws IllegalQueryParamenterException
     */
    protected void addPaginationLinks(
            HttpServerExchange exchange,
            long size,
            final Resource rep)
            throws IllegalQueryParamenterException {
        var request = MongoRequest.of(exchange);
        if (request.getPagesize() > 0) {
            TreeMap links;
            links = RepresentationUtils.getPaginationLinks(exchange, size);
            if (links != null) {
                links.keySet().stream().forEach((k) -> {
                    rep.addLink(new Link(k, links.get(k)));
                });
            }
        }
    }

    /**
     *
     * @param requestPath
     * @return
     */
    protected boolean hasTrailingSlash(final String requestPath) {
        return requestPath.substring(requestPath.length() > 0
                ? requestPath.length() - 1
                : 0).equals("/");
    }
}