/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2011, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.wmsc;

import java.net.URL;
import org.geotoolkit.client.CapabilitiesException;
import org.geotoolkit.storage.coverage.CoverageReference;
import org.geotoolkit.security.ClientSecurity;
import org.apache.sis.storage.DataStoreException;
import org.geotoolkit.wms.GetMapRequest;
import org.geotoolkit.wms.WebMapClient;
import org.geotoolkit.wms.xml.WMSVersion;
import org.opengis.util.GenericName;

/**
 * WMS-C is a osgeo profile for WMS 1.1.1.
 *
 *
 * @author Johann Sorel (Geomatys)
 * @module
 */
public class WebMapClientCached extends WebMapClient {

    private final boolean cacheImage;

    /**
     * Builds a web map server with the given server url.
     *
     * @param serverURL The server base url.
     */
    public WebMapClientCached(final URL serverURL) {
        this(serverURL, false);
    }

    /**
     * Builds a web map server with the given server url and cache flag.
     *
     * @param serverURL The server base url.
     * @param cacheImage
     */
    public WebMapClientCached(final URL serverURL, boolean cacheImage) {
        super(serverURL,"1.1.1");
        this.cacheImage = cacheImage;
    }

    /**
     * Builds a web map server with the given server url and security.
     *
     * @param serverURL The server base url.
     * @param security
     */
    public WebMapClientCached(final URL serverURL, final ClientSecurity security) {
        this(serverURL, security, false);
    }

    /**
     * Builds a web map server with the given server url, security and cache flag.
     *
     * @param serverURL The server base url.
     * @param security
     * @param cacheImage
     */
    public WebMapClientCached(final URL serverURL, final ClientSecurity security, boolean cacheImage) {
        super(serverURL, security, WMSVersion.v111, null);
        this.cacheImage = cacheImage;
    }

    @Override
    public GetMapRequest createGetMap() {
        final GetMapRequest request = super.createGetMap();
        request.dimensions().put("TILED", "true");
        return request;
    }

    @Override
    protected CoverageReference createReference(GenericName name) throws DataStoreException{
        try {
            return new WMSCCoverageReference(this,name);
        } catch (CapabilitiesException ex) {
            throw new DataStoreException(ex.getMessage(), ex);
        }
    }

    public boolean isCacheImage() {
        return cacheImage;
    }

    @Override
    public void close() {
    }

}