Package io.jmix.mapsflowui.component.loader

Interface WmtsCapabilitiesDownloader

All Known Implementing Classes:
WmtsCapabilitiesDownloaderImpl
public interface WmtsCapabilitiesDownloader
Provides WMTS GetCapabilities documents for wmtsSource auto-configuration.

Applications may replace the default implementation with their own bean, e.g. to authenticate against a protected GIS server or to serve cached documents.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    download(String url)
    Returns the GetCapabilities document available at the given URL.
    String
    resolveCapabilitiesUrl(@Nullable String sourceUrl, @Nullable String explicitUrl)
    Resolves the URL of the GetCapabilities document.

  • Method Details

    • resolveCapabilitiesUrl

      String resolveCapabilitiesUrl(@Nullable String sourceUrl, @Nullable String explicitUrl)
      Resolves the URL of the GetCapabilities document.
      Parameters:
      sourceUrl - the WMTS source service URL, may be null
      explicitUrl - explicitly configured document URL, may be null
      Returns:
      explicitUrl if set, otherwise the standard KVP GetCapabilities URL derived from sourceUrl
      Throws:
      IllegalArgumentException - if both parameters are null

    • download

      String download(String url)
      Returns the GetCapabilities document available at the given URL.
      Parameters:
      url - the document URL
      Returns:
      the document content
      Throws:
      IllegalStateException - if the document cannot be obtained