Class PMTilesDataStoreFactory
- All Implemented Interfaces:
DataAccessFactory
,DataStoreFactorySpi
,Factory
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
orhttps://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 itsid
, defaults to automatic detection byRangeReaderFactory.findBestProvider(io.tileverse.rangereader.spi.RangeReaderConfig)
http
forHttpRangeReaderProvider
azure
forAzureBlobRangeReaderProvider
s3
forS3RangeReaderProvider
gcs
forGoogleCloudStorageRangeReaderProvider
- Caching parameters:
- io.tileverse.rangereader.caching.enabled - Enable in-memory caching
- io.tileverse.rangereader.caching.blockaligned - Enable block-aligned caching
- io.tileverse.rangereader.caching.blocksize - Cache block size in bytes (power of 2)
- 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:
-
PMTilesDataStore
RangeReaderParams
- Tileverse Documentation
-
Nested Class Summary
Nested classes/interfaces inherited from interface DataAccessFactory
DataAccessFactory.Param
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DataAccessFactory.Param
Account access keystatic final DataAccessFactory.Param
Set the blob name if the endpoint points to the account urlstatic final DataAccessFactory.Param
SAS token to use for authenticating requestsstatic final DataAccessFactory.Param
Google Cloud project IDstatic final DataAccessFactory.Param
Quota Project IDstatic final DataAccessFactory.Param
Whether to use the default application credentials chain, defaults tofalse
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
static final DataAccessFactory.Param
Apply block alignment for cached byte rangesstatic final DataAccessFactory.Param
Cache block size in bytes (power of 2)static final DataAccessFactory.Param
Enable memory cache for raw byte datastatic final DataAccessFactory.Param
Optional - uri of the FeatureType's namespacestatic final DataAccessFactory.Param
Optional parameter to force selecting a specificRangeReaderProvider
by itsid
static final DataAccessFactory.Param
AWS Access Keystatic final DataAccessFactory.Param
Force an AWS regionstatic final DataAccessFactory.Param
AWS Secret Access Keystatic final DataAccessFactory.Param
Default Credentials Profilestatic final DataAccessFactory.Param
Enable S3 path style accessstatic final DataAccessFactory.Param
Whether to use the Default Credentials Providerstatic final DataAccessFactory.Param
URI to the PMTiles file. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
canProcess
(Map<String, ?> params) Test to see if this factory is suitable for processing the data pointed to by the params map.createDataStore
(Map<String, ?> params) Construct a live data source using the params specifed.createNewDataStore
(Map<String, ?> params) Describe the nature of the datasource constructed by this factory.Name suitable for display to end user.Dynamically builds the list of configuration parameters based on whichRangeReaderProvider
s are avilable.boolean
Test to see if the implementation is available for use.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface Factory
getImplementationHints
-
Field Details
-
NAMESPACEP
Optional - uri of the FeatureType's namespace -
URIP
URI to the PMTiles file. -
RANGEREADER_PROVIDER_ID
Optional parameter to force selecting a specificRangeReaderProvider
by itsid
-
MEMORY_CACHE_ENABLED
Enable memory cache for raw byte data -
MEMORY_CACHE_BLOCK_ALIGNED
Apply block alignment for cached byte ranges -
MEMORY_CACHE_BLOCK_SIZE
Cache block size in bytes (power of 2) -
HTTP_CONNECTION_TIMEOUT_MILLIS
-
HTTP_TRUST_ALL_SSL_CERTIFICATES
-
HTTP_AUTH_USERNAME
-
HTTP_AUTH_PASSWORD
-
HTTP_AUTH_BEARER_TOKEN
-
HTTP_AUTH_API_KEY_HEADERNAME
-
HTTP_AUTH_API_KEY
-
HTTP_AUTH_API_KEY_VALUE_PREFIX
-
AZURE_BLOB_NAME
Set the blob name if the endpoint points to the account url -
AZURE_ACCOUNT_KEY
Account access key -
AZURE_SAS_TOKEN
SAS token to use for authenticating requests -
S3_FORCE_PATH_STYLE
Enable S3 path style access -
S3_AWS_REGION
Force an AWS region -
S3_AWS_ACCESS_KEY_ID
AWS Access Key -
S3_AWS_SECRET_ACCESS_KEY
AWS Secret Access Key -
S3_USE_DEFAULT_CREDENTIALS_PROVIDER
Whether to use the Default Credentials Provider -
S3_DEFAULT_CREDENTIALS_PROFILE
Default Credentials Profile -
GCS_PROJECT_ID
Google Cloud project ID -
GCS_QUOTA_PROJECT_ID
Quota Project ID -
GCS_USE_DEFAULT_APPLICTION_CREDENTIALS
Whether to use the default application credentials chain, defaults tofalse
-
-
Constructor Details
-
PMTilesDataStoreFactory
public PMTilesDataStoreFactory()
-
-
Method Details
-
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 interfaceDataAccessFactory
- Returns:
- A short name suitable for display in a user interface.
-
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 interfaceDataAccessFactory
- 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 interfaceDataAccessFactory
- Returns:
- true if and only if this factory has all the appropriate jars on the classpath to create DataStores.
-
getParametersInfo
Dynamically builds the list of configuration parameters based on whichRangeReaderProvider
s are avilable.- Specified by:
getParametersInfo
in interfaceDataAccessFactory
- Returns:
- Param array describing the Map for createDataStore
- See Also:
-
RangeReaderParams.appendAfter(org.geotools.api.data.DataAccessFactory.Param...)
-
createNewDataStore
- Specified by:
createNewDataStore
in interfaceDataStoreFactorySpi
-
canProcess
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 interfaceDataAccessFactory
- 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
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.
- Specified by:
createDataStore
in interfaceDataAccessFactory
- Specified by:
createDataStore
in interfaceDataStoreFactorySpi
- 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.
-