Area Scheme and Subsets

Data in a catalog can be made available in subsets defined as restrictions on the total data available. Currently data can be restricted by areas only. If you want to apply some area restrictions you need to configure it at point of creation of the catalog and layer(s). Some settings you can update later. For the details, see Configure Catalogs.

There are 2 optional parameters at catalog configuration for location-aware access control.

Property Description
areaScheme The HERE Resource Name (HRN) of the area scheme used across the catalog. If the value is not set than no area scheme is applied to the catalog.
subsetRestrictions Indicates if the subsetRestrictions for a catalog is enabled or not. subsetRestrictions can only be enabled for catalogs that are defined within projects. It requires area scheme being set. If catalog subsetRestrictions are disabled, supported layer's subsetRestrictions will be disabled by default.

Note that the only area scheme currently available is hrn:here:areascheme::olp-here:default-countries.

Furthermore, you can control the subset restictions per versioned and volatile layer if enabled on catalog level. For that you should pass these new optional parameters when defining the layerType of a layer as

  • VersionedLayerType(secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None) or
  • VolatileLayerType(secureHandles: Option[Boolean] = None, subsetRestrictions: Option[Boolean] = None).
Property Description
secureHandles A boolean flag which indicates if the layer metadata and blob are in mode of secure data handles support. It requires catalog area scheme to be set and supports only heretile partitioning of the layer.
subsetRestrictions A boolean flag which indicates if the subsetRestrictions for a layer is enabled or not. subsetRestrictions can only be enabled for layers of catalogs that are defined within projects. It requires area scheme of the catalog being set. Supported layer subsetRestrictions are enabled by default when subsetRestrictions is enabled for the catalog. Layer subsetRestrictions requires catalog subsetRestrictions to be enabled. If catalog subsetRestrictions are disabled, supported layer's subsetRestrictions will be disabled by default. Supported only for layers with heretile partitioning.

There are 4 functions of AdminApi to get information about area subsets as there are

  • getSubsets: Get the list of all accessible subsets which match the optional areaId filter
  • getSubsetsAsSource: Get the list of all accessible subsets which match the optional areaId filter as an Akka Source
  • getSubset: Get the details of a subset
  • getSubsetsFingerprint: Get a fingerprint that represents the accessible subset configuration

results matching ""

    No results matching ""