Changeset 36372 in osm

Timestamp:

2025-01-27T14:43:10+01:00 (2 months ago)

Author:

taylor.smock

Message:

See #23913: Fetch remote API keys for Bing imagery

Location:

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/tilesources

Files:

• AbstractTMSTileSource.java (modified) (1 diff)
• BingAerialTileSource.java (modified) (3 diffs)

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/tilesources/AbstractTMSTileSource.java

@@ -44 +44 @@
             baseUrl = baseUrl.substring(0, baseUrl.length()-1);
         }
-        this.id = info.getUrl();
+        this.id = info.getId();
         this.noTileHeaders = info.getNoTileHeaders();
         this.noTileChecksums = info.getNoTileChecksums();

applications/viewer/jmapviewer/src/org/openstreetmap/gui/jmapviewer/tilesources/BingAerialTileSource.java

@@ -81 +81 @@
      */
     public BingAerialTileSource() {
-        super(new TileSourceInfo("Bing", null, null));
+        super(new TileSourceInfo("Bing", null, "Bing"));
         minZoom = 1;
     }
@@ -132 +132 @@
         try {
             return new URI(FeatureAdapter.getSetting(METADATA_API_SETTING, METADATA_API_URL)
-                    .replace(API_KEY_PLACEHOLDER, FeatureAdapter.getSetting(API_KEY_SETTING, API_KEY))
+                    .replace(API_KEY_PLACEHOLDER, getKey())
                     .replace(API_KEY_LAYER, this.layer)).toURL();
         } catch (URISyntaxException e) {
@@ -139 +139 @@
             throw malformedURLException;
         }
+    }
+
+    /**
+     * Get the API key for Bing imagery
+     * Order of preference is as follows:
+     * <ol>
+     *     <li>Custom API key provided by {@link FeatureAdapter#getSetting(String, String)} via {@link #API_KEY_SETTING}</li>
+     *     <li>API key provided by {@link FeatureAdapter#retrieveApiKey(String)}</li>
+     *     <li>The hardcoded API key. This should not be used whenever possible.</li>
+     * </ol>
+     * @return The API key to use
+     */
+    private String getKey() {
+        // Preference order for key
+        // 1. Custom API key
+        // 2. Remote API key
+        // 3. Hardcoded API key
+        String key = FeatureAdapter.getSetting(API_KEY_SETTING, API_KEY);
+        if (API_KEY.equals(key)) { // If the API key has not been customized, we try to retrieve the API key
+            try {
+                key = FeatureAdapter.retrieveApiKey(this.getId());
+            } catch (IOException ioException) {
+                FeatureAdapter.getLogger(this.getClass()).log(Level.WARNING, "Failed to retrieve api key", ioException);
+            }
+        }
+        return key;
     }