Package org.geotools.pmtiles.store

Class PMTilesDataStoreFactory

Object
PMTilesDataStoreFactory
All Implemented Interfaces:
DataAccessFactory, DataStoreFactorySpi, Factory
@NullMarked public class PMTilesDataStoreFactory extends Object implements DataStoreFactorySpi
Factory for creating PMTilesDataStore instances.

This factory supports creating PMTiles datastores from various sources including local files, HTTP/HTTPS servers, and cloud storage providers (AWS S3, Azure Blob Storage, Google Cloud Storage). It uses the Tileverse Range Reader library's SPI mechanism to automatically select the appropriate RangeReaderProvider based on the URI scheme.

Supported URI Schemes:

  • Local files: file:/path/to/file.pmtiles
  • AWS S3: s3://bucket/key.pmtiles or https://bucket.s3.amazonaws.com/key.pmtiles
  • Azure Blob: https://account.blob.core.windows.net/container/key.pmtiles
  • Google Cloud Storage: https://storage.googleapis.com/bucket/key.pmtiles
  • HTTP/HTTPS: https://example.com/path/file.pmtiles
  • S3-compatible (MinIO): http://localhost:9000/bucket/key.pmtiles

Configuration Parameters:

  • pmtiles - PMTiles archive URI (required)
  • namespace - Feature type namespace (optional)
  • io.tileverse.rangereader.provider - Optionally force a specific RangeReaderProvider by its id, defaults to automatic detection by RangeReaderFactory.findBestProvider(io.tileverse.rangereader.spi.RangeReaderConfig)
    • http for HttpRangeReaderProvider
    • azure for AzureBlobRangeReaderProvider
    • s3 for S3RangeReaderProvider
    • gcs for GoogleCloudStorageRangeReaderProvider
  • Caching parameters:
  • HTTP(S) parameters:
    • io.tileverse.rangereader.http.timeout-millis - HTTP connection timeout in milliseconds
    • io.tileverse.rangereader.http.trust-all-certificates - Trust all SSL/TLS certificates
    • io.tileverse.rangereader.http.username - HTTP Basic Auth username
    • io.tileverse.rangereader.http.password - HTTP Basic Auth password
    • io.tileverse.rangereader.http.bearer-token - HTTP Bearer Token
    • io.tileverse.rangereader.http.api-key-headername - API-Key header name
    • io.tileverse.rangereader.http.api-key - API key value
    • io.tileverse.rangereader.http.api-key-value-prefix - API key value prefix
  • Azure Blob parameters:
    • io.tileverse.rangereader.azure.blob-name - Set the Azure blob name if the endpoint points to the account url
    • io.tileverse.rangereader.azure.account-key - Azure Account access key
    • io.tileverse.rangereader.azure.sas-token - Azure SAS token to use for authenticating requests
  • AWS S3 parameters:
    • io.tileverse.rangereader.s3.force-path-style - Enable S3 path style access
    • io.tileverse.rangereader.s3.region - Configure the region with which the AWS S3 SDK should communicate
    • io.tileverse.rangereader.s3.aws-access-key-id - AWS Access Key ID
    • io.tileverse.rangereader.s3.aws-secret-access-key - AWS Secret Access Key
    • io.tileverse.rangereader.s3.use-default-credentials-provider - Use Default Credentials Provider
    • io.tileverse.rangereader.s3.default-credentials-profile - Default Credentials Profile
  • Google Cloud Storage parameters:
    • io.tileverse.rangereader.gcs.project-id - Google Cloud project ID
    • io.tileverse.rangereader.gcs.quota-project-id - Quota ProjectId that specifies the project used for quota and billing purposes
    • GoogleCloudStorageRangeReaderProvider.GCS_USE_DEFAULT_APPLICTION_CREDENTIALS - Whether to use the default application credentials chain
See Also:

  • Field Details

  • Constructor Details

    • PMTilesDataStoreFactory

      public PMTilesDataStoreFactory()

  • Method Details

    • setCacheManager

      public static void setCacheManager(@NonNull CacheManager cacheManager)
      Sets the global CacheManager used by all PMTiles datastores created by this factory.

      This allows applications to provide a custom cache manager for fine-grained control over caching behavior, memory limits, and eviction policies. By default, uses CacheManager.getDefault().

      Parameters:
      cacheManager - the cache manager to use, must not be null
      See Also:

    • getCacheManager

      public static CacheManager getCacheManager()
      Returns the current global CacheManager used by PMTiles datastores.
      Returns:
      the current cache manager, never null

    • clearCaches

      public static void clearCaches()
      Invalidates all caches managed by the current CacheManager and clears the ByteBufferPool.

      This method is useful for:

      • Forcing a refresh when the underlying PMTiles file has been updated
      • Freeing memory under pressure
      • Testing and debugging cache behavior

      Cache statistics are logged at CONFIG level before invalidation.

    • getDisplayName

      public String getDisplayName()
      Description copied from interface: DataAccessFactory
      Name suitable for display to end user.

      A non localized display name for this data store type.

      Specified by:
      getDisplayName in interface DataAccessFactory
      Returns:
      A short name suitable for display in a user interface.

    • getDescription

      public String getDescription()
      Description copied from interface: DataAccessFactory
      Describe the nature of the datasource constructed by this factory.

      A non localized description of this data store type.

      Specified by:
      getDescription in interface DataAccessFactory
      Returns:
      A human readable description that is suitable for inclusion in a list of available datasources.

    • isAvailable

      public boolean isAvailable()
      Description copied from interface: DataAccessFactory
      Test to see if the implementation is available for use. This method ensures all the appropriate libraries to construct the DataAccess are available.

      Most factories will simply return true as GeoTools will distribute the appropriate libraries. Though it's not a bad idea for DataStoreFactories to check to make sure that the libraries are there.

      OracleDataStoreFactory is an example of one that may generally return false, since GeoTools can not distribute the oracle jars. (they must be added by the client.)

      One may ask how this is different than canProcess, and basically available is used by the DataStoreFinder getAvailableDataStore method, so that DataStores that can not even be used do not show up as options in gui applications.

      Specified by:
      isAvailable in interface DataAccessFactory
      Returns:
      true if and only if this factory has all the appropriate jars on the classpath to create DataStores.

    • getParametersInfo

      public DataAccessFactory.Param[] getParametersInfo()
      Dynamically builds the list of configuration parameters based on which RangeReaderProviders are available.
      Specified by:
      getParametersInfo in interface DataAccessFactory
      Returns:
      Param array describing the Map for createDataStore
      See Also:
      • RangeReaderParams#appendAfter(org.geotools.api.data.DataAccessFactory.Param...)

    • createNewDataStore

      public DataStore createNewDataStore(Map<String,?> params)
      Specified by:
      createNewDataStore in interface DataStoreFactorySpi

    • canProcess

      public boolean canProcess(Map<String,?> params)
      Description copied from interface: DataAccessFactory
      Test to see if this factory is suitable for processing the data pointed to by the params map.

      If this datasource requires a number of parameters then this mehtod should check that they are all present and that they are all valid. If the datasource is a file reading data source then the extentions or mime types of any files specified should be checked. For example, a Shapefile datasource should check that the url param ends with shp, such tests should be case insensative.

      Specified by:
      canProcess in interface DataAccessFactory
      Parameters:
      params - The full set of information needed to construct a live data source.
      Returns:
      booean true if and only if this factory can process the resource indicated by the param set and all the required params are pressent.

    • createDataStore

      public PMTilesDataStore createDataStore(Map<String,?> params) throws IOException
      Description copied from interface: DataStoreFactorySpi
      Construct a live data source using the params specifed.

      You can think of this as setting up a connection to the back end data source.

      Magic Params: the following params are magic and are honoured by convention by the GeoServer and uDig application.

      • "user": is taken to be the user name
      • "passwd": is taken to be the password
      • "namespace": is taken to be the namespace prefix (and will be kept in sync with GeoServer namespace management.
      When we eventually move over to the use of OpperationalParam we will have to find someway to codify this convention.
      Specified by:
      createDataStore in interface DataAccessFactory
      Specified by:
      createDataStore in interface DataStoreFactorySpi
      Parameters:
      params - The full set of information needed to construct a live data store. Typical key values for the map include: url - location of a resource, used by file reading datasources. dbtype - the type of the database to connect to, e.g. postgis, mysql
      Returns:
      The created DataStore, this may be null if the required resource was not found or if insufficent parameters were given. Note that canProcess() should have returned false if the problem is to do with insuficent parameters.
      Throws:
      IOException - if there were any problems setting up (creating or connecting) the datasource.