[GEOS-8222] Cascading WMTS: fixes and improvements as per code review

geoserver · Aug 18, 2017 · 8520a97 · 8520a97
1 parent 0cb23ed
commit 8520a97
Show file tree

Hide file tree

Showing 38 changed files with 15,837 additions and 274 deletions.
diff --git a/src/community/pom.xml b/src/community/pom.xml
@@ -83,7 +83,6 @@
           <descriptor>release/ext-ows-simulate.xml</descriptor> 
           <descriptor>release/ext-jdbc-metrics.xml</descriptor>
           <descriptor>release/ext-opensearch-eo.xml</descriptor>  
-          <descriptor>release/ext-wmts.xml</descriptor>
         </descriptors>
       </configuration>
      </plugin>
@@ -532,14 +531,5 @@
         <module>jdbc-metrics</module>
       </modules>
     </profile>
-    <profile>
-      <id>wmts</id>
-      <modules>
-  	     <module>gs-wmts</module>
-      </modules>
-
-    </profile>
-  </profiles>
-
-
+  </profiles>  
 </project>
diff --git a/src/main/src/main/java/org/geoserver/catalog/CatalogVisitor.java b/src/main/src/main/java/org/geoserver/catalog/CatalogVisitor.java
@@ -44,10 +44,11 @@ public interface CatalogVisitor {
      * Visits a WMS data store.
      */
     void visit( WMSStoreInfo wmsStore ); 
+
     /**
      * Visits a WMTS data store.
      */
-    void visit( WMTSStoreInfo wmsStore ); 
+    default void visit( WMTSStoreInfo store ) {}
 
     /**
      * Visits a feature type.
@@ -81,7 +82,7 @@ public interface CatalogVisitor {
     void visit(WMSLayerInfo wmsLayer);
 
     /**
-     * @param wmtsLayerInfoImpl
+     * Visits a WMTS layer resource
      */
-    void visit(WMTSLayerInfo wmtsLayerInfo);
+    default void visit(WMTSLayerInfo layer) {}
 }
diff --git a/src/main/src/main/java/org/geoserver/catalog/HTTPStoreInfo.java b/src/main/src/main/java/org/geoserver/catalog/HTTPStoreInfo.java
@@ -0,0 +1,82 @@
+/* (c) 2017 Open Source Geospatial Foundation - all rights reserved
+ * This code is licensed under the GPL 2.0 license, available at the root
+ * application directory.
+ */
+package org.geoserver.catalog;
+
+/**
+ * A store backed by a remote HTTP service.
+ *
+ * Most of these methods have been refactored from WMSStoreInfo, now a sub-interface.
+ *
+ * @author Andrea Aime - OpenGeo
+ * @author Emanuele Tajariol (etj at geo-solutions dot it)
+ */
+public interface HTTPStoreInfo extends StoreInfo {
+
+    /**
+     * The entrypoint URL, usually a getCapabilities
+     */
+    String getCapabilitiesURL();
+
+    /**
+     * Sets entrypoint / getCapabilities url.
+     * 
+     * @uml.property name="url"
+     */
+    void setCapabilitiesURL(String url);
+
+    String getUsername();
+
+    void setUsername(String user);
+
+    String getPassword();
+
+    void setPassword(String password);
+
+    /**
+     * @return Upper limit on the number of http connections the store should hold in the pool if
+     *         {@link #isUseConnectionPooling()} is {@code true}.
+     */
+    int getMaxConnections();
+
+    void setMaxConnections(int maxConcurrentConnections);
+
+    /**
+     * @return number of seconds to wait on read before time out, defaults to 60
+     */
+    int getReadTimeout();
+
+    /**
+     * @param timeoutSeconds
+     *            seconds to wait before timing out a read request
+     */
+    void setReadTimeout(int timeoutSeconds);
+
+    /**
+     * @return seconds to wait for connect requests before timing out, defaults to 30
+     */
+    int getConnectTimeout();
+
+    /**
+     * @param seconds
+     *            to wait for connect requests before timing out
+     */
+    void setConnectTimeout(int timeoutSeconds);
+
+    /**
+     * @return {@code true} (default) if the store shall use an http connection managed that pools
+     *         connections, {@code false} otherwise.
+     * @see #getMaxConnections()
+     */
+    public boolean isUseConnectionPooling();
+
+    /**
+     * @param useHttpConnectionPooling
+     *            {@code true} if the store shall use an http connection managed that pools
+     *            connections, {@code false} otherwise.
+     * @see #setMaxConnections(int)
+     */
+    public void setUseConnectionPooling(boolean useHttpConnectionPooling);
+
+}
diff --git a/src/main/src/main/java/org/geoserver/catalog/ResourcePool.java b/src/main/src/main/java/org/geoserver/catalog/ResourcePool.java
@@ -1785,9 +1785,10 @@ public WebMapTileServer getWebMapTileServer(WMTSStoreInfo info) throws IOExcepti
                 synchronized (wmtsCache) {
                     wmts = (WebMapTileServer) wmtsCache.get(id);
                     if (wmts == null) {
+                        HTTPClient client = getHTTPClient(expandedStore); 
                         String capabilitiesURL = expandedStore.getCapabilitiesURL();
                         URL serverURL = new URL(capabilitiesURL);
-                        wmts = new WebMapTileServer(serverURL);
+                        wmts = new WebMapTileServer(serverURL, client, null);
 
                         if(StringUtils.isNotEmpty(info.getHeaderName()) && StringUtils.isNotEmpty(info.getHeaderValue())) {
                             wmts.getHeaders().put(info.getHeaderName(), info.getHeaderValue());
@@ -1818,7 +1819,7 @@ public EntityResolver getEntityResolver() {
         return entityResolver;
     }
 
-    private HTTPClient getHTTPClient(WMSStoreInfo info) {
+    private HTTPClient getHTTPClient(HTTPStoreInfo info) { 
         String capabilitiesURL = info.getCapabilitiesURL();
 
         // check for mock bindings. Since we are going to run this code in production as well,

diff --git a/src/main/src/main/java/org/geoserver/catalog/WMSStoreInfo.java b/src/main/src/main/java/org/geoserver/catalog/WMSStoreInfo.java
@@ -16,7 +16,7 @@
  * @author Andrea Aime - OpenGeo
  * 
  */
-public interface WMSStoreInfo extends StoreInfo {
+public interface WMSStoreInfo extends HTTPStoreInfo {
 
     /**
      * Returns the underlying {@link WebMapServer}
@@ -34,70 +34,5 @@ public interface WMSStoreInfo extends StoreInfo {
      *             Any I/O problems.
      */
     WebMapServer getWebMapServer(ProgressListener listener) throws IOException;
-
-    /**
-     * The capabilities url
-     */
-    String getCapabilitiesURL();
-
-    /**
-     * Sets the web map server capabilities url.
-     * 
-     * @uml.property name="url"
-     */
-    void setCapabilitiesURL(String url);
-
-    String getUsername();
-
-    void setUsername(String user);
-
-    String getPassword();
-
-    void setPassword(String password);
-
-    /**
-     * @return Upper limit on the number of http connections the store should hold in the pool if
-     *         {@link #isUseConnectionPooling()} is {@code true}.
-     */
-    int getMaxConnections();
-
-    void setMaxConnections(int maxConcurrentConnections);
-
-    /**
-     * @return number of seconds to wait on read before time out, defaults to 60
-     */
-    int getReadTimeout();
-
-    /**
-     * @param timeoutSeconds
-     *            seconds to wait before timing out a read request
-     */
-    void setReadTimeout(int timeoutSeconds);
-
-    /**
-     * @return seconds to wait for connect requests before timing out, defaults to 30
-     */
-    int getConnectTimeout();
-
-    /**
-     * @param seconds
-     *            to wait for connect requests before timing out
-     */
-    void setConnectTimeout(int timeoutSeconds);
-
-    /**
-     * @return {@code true} (default) if the store shall use an http connection managed that pools
-     *         connections, {@code false} otherwise.
-     * @see #getMaxConnections()
-     */
-    public boolean isUseConnectionPooling();
-
-    /**
-     * @param useHttpConnectionPooling
-     *            {@code true} if the store shall use an http connection managed that pools
-     *            connections, {@code false} otherwise.
-     * @see #setMaxConnections(int)
-     */
-    public void setUseConnectionPooling(boolean useHttpConnectionPooling);
 
 }
diff --git a/src/main/src/main/java/org/geoserver/catalog/WMTSLayerInfo.java b/src/main/src/main/java/org/geoserver/catalog/WMTSLayerInfo.java
@@ -1,5 +1,4 @@
-/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
- * (c) 2001 - 2013 OpenPlans
+/* (c) 2017 Open Source Geospatial Foundation - all rights reserved
  * This code is licensed under the GPL 2.0 license, available at the root
  * application directory.
  */

diff --git a/src/main/src/main/java/org/geoserver/catalog/WMTSStoreInfo.java b/src/main/src/main/java/org/geoserver/catalog/WMTSStoreInfo.java
@@ -1,5 +1,4 @@
-/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
- * (c) 2001 - 2013 OpenPlans
+/* (c) 2017 Open Source Geospatial Foundation - all rights reserved
  * This code is licensed under the GPL 2.0 license, available at the root
  * application directory.
  */
@@ -11,15 +10,16 @@
 import org.opengis.util.ProgressListener;
 
 /**
- * A store backed by a {@link WebMapServer}, allows for WMS cascading
+ * A store backed by a {@link WebMapTileServer}, allows for WMTS cascading
  * 
- * @author Andrea Aime - OpenGeo
+ * @author ian
+ * @author Emanuele Tajariol (etj at geo-solutions dot it)
  * 
  */
-public interface WMTSStoreInfo extends StoreInfo {
+public interface WMTSStoreInfo extends HTTPStoreInfo {
 
     /**
-     * Returns the underlying {@link WebMapTileServer}
+     * Returns the underlying {@link WebMapTileServer}.
      * <p>
      * This method does I/O and is potentially blocking. The <tt>listener</tt> may be used to report
      * the progress of loading the datastore and also to report any errors or warnings that occur.
@@ -35,71 +35,6 @@ public interface WMTSStoreInfo extends StoreInfo {
      */
     WebMapTileServer getWebMapTileServer(ProgressListener listener) throws IOException; 
 
-    /**
-     * The capabilities url
-     */
-    String getCapabilitiesURL();
-
-    /**
-     * Sets the web map server capabilities url.
-     * 
-     * @uml.property name="url"
-     */
-    void setCapabilitiesURL(String url);
-
-    String getUsername();
-
-    void setUsername(String user);
-
-    String getPassword();
-
-    void setPassword(String password);
-
-    /**
-     * @return Upper limit on the number of http connections the store should hold in the pool if
-     *         {@link #isUseConnectionPooling()} is {@code true}.
-     */
-    int getMaxConnections();
-
-    void setMaxConnections(int maxConcurrentConnections);
-
-    /**
-     * @return number of seconds to wait on read before time out, defaults to 60
-     */
-    int getReadTimeout();
-
-    /**
-     * @param timeoutSeconds
-     *            seconds to wait before timing out a read request
-     */
-    void setReadTimeout(int timeoutSeconds);
-
-    /**
-     * @return seconds to wait for connect requests before timing out, defaults to 30
-     */
-    int getConnectTimeout();
-
-    /**
-     * @param seconds
-     *            to wait for connect requests before timing out
-     */
-    void setConnectTimeout(int timeoutSeconds);
-
-    /**
-     * @return {@code true} (default) if the store shall use an http connection managed that pools
-     *         connections, {@code false} otherwise.
-     * @see #getMaxConnections()
-     */
-    public boolean isUseConnectionPooling();
-
-    /**
-     * @param useHttpConnectionPooling
-     *            {@code true} if the store shall use an http connection managed that pools
-     *            connections, {@code false} otherwise.
-     * @see #setMaxConnections(int)
-     */
-    public void setUseConnectionPooling(boolean useHttpConnectionPooling);
-
     String getHeaderName();
     void setHeaderName(String headerName);
     String getHeaderValue();

diff --git a/src/main/src/main/java/org/geoserver/catalog/impl/WMTSLayerInfoImpl.java b/src/main/src/main/java/org/geoserver/catalog/impl/WMTSLayerInfoImpl.java
@@ -1,5 +1,4 @@
-/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
- * (c) 2001 - 2013 OpenPlans
+/* (c) 2017 Open Source Geospatial Foundation - all rights reserved
  * This code is licensed under the GPL 2.0 license, available at the root
  * application directory.
  */
@@ -9,7 +8,6 @@
 
 import org.geoserver.catalog.Catalog;
 import org.geoserver.catalog.CatalogVisitor;
-import org.geoserver.catalog.WMSStoreInfo;
 import org.geoserver.catalog.WMTSLayerInfo;
 import org.geoserver.catalog.WMTSStoreInfo;
 import org.geotools.data.ows.Layer;

diff --git a/src/main/src/main/java/org/geoserver/catalog/impl/WMTSStoreInfoImpl.java b/src/main/src/main/java/org/geoserver/catalog/impl/WMTSStoreInfoImpl.java
@@ -1,5 +1,4 @@
-/* (c) 2014 Open Source Geospatial Foundation - all rights reserved
- * (c) 2001 - 2013 OpenPlans
+/* (c) 2017 Open Source Geospatial Foundation - all rights reserved
  * This code is licensed under the GPL 2.0 license, available at the root
  * application directory.
  */

diff --git a/src/main/src/main/java/org/geoserver/config/GeoServerLoader.java b/src/main/src/main/java/org/geoserver/config/GeoServerLoader.java
@@ -631,7 +631,7 @@ private void loadWmtsStore(StoreContents storeContents, CatalogImpl catalog,
             return;
         }
 
-        // load wms layers
+        // load wmts layers
         LayerLoader<WMTSLayerInfo> coverageLoader = new LayerLoader<>(WMTSLayerInfo.class, xp, catalog);
         try(AsynchResourceIterator<LayerContents> it = new AsynchResourceIterator<>(storeResource.parent(), Resources.DirectoryFilter.INSTANCE, WMTS_LAYER_MAPPER)) {
             while(it.hasNext()) {

diff --git a/src/main/src/main/java/org/geoserver/security/DataAccessManagerAdapter.java b/src/main/src/main/java/org/geoserver/security/DataAccessManagerAdapter.java
@@ -77,7 +77,7 @@ DataAccessLimits buildLimits(Class<? extends ResourceInfo> resourceClass, Filter
         } else if (WMSLayerInfo.class.isAssignableFrom(resourceClass)) {
             return new WMSAccessLimits(mode, readFilter, null, true);
         } else if (WMTSLayerInfo.class.isAssignableFrom(resourceClass)) {
-            return new WMTSAccessLimits(mode, readFilter, null, true);
+            return new WMTSAccessLimits(mode, readFilter, null);
         } else {
             LOGGER.log(Level.INFO,
                     "Warning, adapting to generic access limits for unrecognized resource type "