org.mapfish.print.map.tiled.wmts.WMTSLayerParam Maven / Gradle / Ivy

Go to download
package org.mapfish.print.map.tiled.wmts;
import com.google.common.base.Strings;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;
import com.vividsolutions.jts.util.Assert;
import org.mapfish.print.Constants;
import org.mapfish.print.URIUtils;
import org.mapfish.print.map.tiled.AbstractWMXLayerParams;
import org.mapfish.print.parser.HasDefaultValue;
import org.mapfish.print.wrapper.PObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;

/**
 * The parameters for configuration a WMTS layer.
 */
public final class WMTSLayerParam extends AbstractWMXLayerParams {
    private static final Logger LOGGER = LoggerFactory.getLogger(WMTSLayerParam.class);

    /**
     * The ‘ResourceURL’ available in the WMTS capabilities.
     * 
     * Example (for requestEncoding: "KVP"):
     * 
     * baseUrl: "http://domain.com/wmts"
     * 
     * 
     * Example (for requestEncoding: "REST"):
     * 
     * baseUrl: "http://domain.com/wmts/roads/{TileMatrixSet}/{TileMatrix}/{TileCol}/{TileRow}.png"
     * 
     * The following URL template variables are replaced:
     * 
     *  {Layer}
     *  {style}
     *  {TileMatrixSet}
     *  {TileMatrix}
     *  {TileRow}
     *  {TileCol}
     *  {[DIMENSION.IDENTIFIER]}
     * 
     */
    public String baseURL;
    /**
     * The layer name.
     */
    public String layer;
    /**
     * The WMTS protocol version to use.
     */
    @HasDefaultValue
    public String version = "1.0.0";
    /**
     * The way to make the requests. Either KVP or REST (default).
     */
    @HasDefaultValue
    public RequestEncoding requestEncoding = RequestEncoding.REST;
    /**
     * The style name (for styles on the WMTS server).
     */
    @HasDefaultValue
    public String style = "";
    /**
     * The "sample" dimensions or image color bands to retrieve.
     * 
     * This can be null, if so then the default dimensions will be returned.
     * If specified they must be dimensions supported by the server.
     * 
     * These are keys to the {@link #dimensionParams}.
     */
    @HasDefaultValue
    public String[] dimensions;

    /**
     * The dpi of the returned images.
     * 
     * By default this is the OGC default DPI.
     */
    @HasDefaultValue
    public double dpi = Constants.OGC_DPI;
    /**
     * Dictionary of dimensions name (Must be uppercase) => value.
     */
    @HasDefaultValue
    public PObject dimensionParams;

    /**
     * The format of the image. for example image/png, image/jpeg, etc...
     */
    @HasDefaultValue
    public String imageFormat = "image/png";
    /**
     * Reference/Identifier to a tileMatrixSet and limits.
     */
    public String matrixSet;
    /**
     * Array of matrix ids.
     * 
     * Example:
     * 
     * [{
     *   "identifier": "0",
     *   "matrixSize": [1, 1],
     *   "scaleDenominator": 4000,
     *   "tileSize": [256, 256],
     *   "topLeftCorner": [420000, 350000]
     *   }, ...]
     * 
     */
    public Matrix[] matrices;

    @Override
    public String getBaseUrl() {
        return this.baseURL;
    }

    /**
     * Validate some of the properties of this layer.
     */
    public void postConstruct() {
        Assert.isTrue(validateBaseUrl(), "invalid baseURL");
    }

    @Override
    public String createCommonUrl()
            throws URISyntaxException, UnsupportedEncodingException {
        if (RequestEncoding.REST == this.requestEncoding) {
            return getBaseUrl();
        } else {
            Multimap queryParams = HashMultimap.create();

            queryParams.putAll(getCustomParams());
            queryParams.putAll(getMergeableParams());

            final URI baseUri = new URI(getBaseUrl());
            return URIUtils.addParams(getBaseUrl(), queryParams, URIUtils.getParameters(baseUri).keySet());
        }
    }

    @Override
    public boolean validateBaseUrl() {
        String url = getBaseUrl();
        if (Strings.isNullOrEmpty(url)) {
            return false;
        }

        if (RequestEncoding.REST == this.requestEncoding) {
            if (!containsVariables(url)) {
                LOGGER.warn("URL {} is missing some variables", url);
                return false;
            }
            try {
                return WMTSLayer.createRestURI(url, "matrix", 0, 0, this) != null;
            } catch (URISyntaxException exc) {
                LOGGER.warn("URL {} is invalid: {}", url, exc.getMessage());
                return false;
            }
        } else {
            return super.validateBaseUrl();
        }
    }

    private boolean containsVariables(final String url) {
       return url.contains("{TileMatrix}") && url.contains("{TileRow}") && url.contains("{TileCol}");
    }
}