commit | 4ad026f931ee31bda9d9f72186a3bc62545685c9 | [log] [tgz] |
---|---|---|
author | David Bosschaert <bosschae@adobe.com> | Fri Feb 08 16:12:40 2019 -0800 |
committer | David Bosschaert <bosschae@adobe.com> | Fri Feb 08 16:12:40 2019 -0800 |
tree | 75e64c7c7f70fcac2e9fb24098b70c6fff5f7af0 | |
parent | c3f188f5539b0cfecca23d869f5905938c81d1f1 [diff] |
Update README.md
This component contains extensions relating to the API Regions component. The following extensions are registered via the ServiceLoader mechanism:
org.apache.sling.feature.builder.MergeHandler
Merge handlers are called when features are merged during the aggregation process.
APIRegionMergeHandler
- This handler knows how to merge API Regions extensions and adds the org-feature
key to the api-regions
sections to record what feature this section originally belonged.
org.apache.sling.feature.builder.PostProcessHandler
PostProcessHandlers are called when a feature contains an api-regions
section.
BundleMappingHandler
- This handler creates a mapping file idbsnver.properties
that maps the Artifact ID to a bundle symbolic name and version. A tilde ~
is used in the value of the map to separate BSN and version.
BundleArtifactFeatureHandler
- This handler creates 3 mapping files:
bundles.properties
: maps bundles to the original feature they were in. A bundle could be from more then one feature.features.properties
: maps features to regions. A feature can be in more than one region.regions.properties
: maps regions to packages. A region can expose more than one package.The location of the files created by the BundleArtifactFeatureHandler
handler is stored in a system property with name sling.feature.apiregions.resource.
+ filename. So to obtain the file name of the bundles.properties
file, make the following call:
System.getProperty("sling.feature.apiregions.resource.bundles.properties")
These properties are read by the https://github.com/apache/sling-org-apache-sling-feature-apiregions component for runtime enforcement of the API Regions.