registrar.backend package

Submodules

registrar.backend.eoxserver module

backend.py

Contains implementations for different backends where data may be registered

class registrar.backend.eoxserver.AssetsToCoverageMapping(*args, **kwargs)

Bases: dict

Mapping structure to map specific STAC Item Assets to coverages

assets

list of asset names that shall be grouped to the same EOxServer Coverage

Type:

List[str]

assets: List[str]

class registrar.backend.eoxserver.ItemBackend(instance_base_path: str, instance_name: str, product_types: List[ItemToProductTypeMapping], auto_create_product_types: bool = False, automatic_visibilities: List[str] | None = None, simplify_footprint_tolerance: float | None = None)

Bases: Backend[Item]

EOxServer backend allows registration to be performed on a running EOxServer instance

Parameters:

• instance_base_path (str) – base path of the instance

• instance_name (str) – name of django instance

• product_types (str) – type of product to register

• auto_create_product_types (bool) – whether to create product types from the STAC Item

deregister(source: Source | None, item: Item)

Defers to deregister_identifier with the items identifier

deregister_identifier(identifier: str)

Attempts to deregister item

Parameters:

identifier (str) – identifier to be deregistered

exists(source: Source | None, item: Item) → bool

Checks whether the item exists in the given source

Parameters:

• source (Source) – source of the data

• item (Item) – item to be checked

Returns:

true if exists, false otherwise

Return type:

(bool)

register(source: Source | None, item: Item, replace: bool)

Registers the item to the endpoint

Parameters:

• source (Source) – source of the data

• item ('Item') – item to be registered

• replace (bool) – replace existing or not

class registrar.backend.eoxserver.ItemToProductTypeMapping(*args, **kwargs)

Bases: dict

Mapping structure to map STAC Items to EOxServer ProductTypes

product_type

the name of the EOxServer ProductType

Type:

str

filter

specific filters to limit on which STAC Items this mapping is applied

Type:

dict

coverages

a mapping of coverage type name to an AssetsToCoverageMapping

Type:

dict

collections

a list of collection names that products of this ProductType shall be inserted into

Type:

List[str]

collections: List[str]

coverages: dict

filter: dict

name: str

product_type: str

registrar.backend.utils module

Backend handling utilities

registrar.backend.utils.get_backends(backend_configs: List[BackendConfig]) → List[Backend]

Gets the backends for registering into

Parameters:

backend_configs (dict) – backend configurations

Returns:

list of backends where registration will be

carried out

Return type:

List[Backend]

Module contents

Registrar backends.

registrar.backend.get_backends(backend_configs: List[BackendConfig]) → List[Backend]

Gets the backends for registering into

Parameters:

backend_configs (dict) – backend configurations

Returns:

list of backends where registration will be

carried out

Return type:

List[Backend]