| commit | 9ea872a7894d5a30d03778110a5c36c77bbef869 | [log] [tgz] |
|---|---|---|
| author | David Bosschaert <bosschae@adobe.com> | Fri Feb 21 13:32:23 2020 +0000 |
| committer | David Bosschaert <bosschae@adobe.com> | Fri Feb 21 13:32:23 2020 +0000 |
| tree | 2e932b0a6d4264b01bb5268fb10afca49fc8c193 | |
| parent | 533f4d45cbb4d3ea879d115f877c902e895af80f [diff] |
Updated README.md
This component contains extensions relating to the API Regions component. For more information about API Regions see https://github.com/apache/sling-org-apache-sling-feature/blob/master/apicontroller.md
The following extensions are registered via the ServiceLoader mechanism:
org.apache.sling.feature.builder.MergeHandlerMerge handlers are called when features are merged during the aggregation process.
APIRegionMergeHandler - This handler knows how to merge API Regions extensions
This component also contains Feature Model Analysers they are contributed through the Service Loader mechanism to the set of Analysers.
These analysers relate to API Region definitions in Feature Models.
api-regions: This analyser ensures that packages listed as exports in API-Regions sections are actually exported by a bundle that's part of the feature.
api-regions-dependencies: This analyser checks that packages in API regions listed earlier in the API-Regions declaration have no dependency on API regions listed later in the list. This include Import-Package style dependencies and also uses-clause type dependencies. Later API regions also include packages from earlier declared API regions, but not the other way around.
exporting-apis: the name of the region that provides the visible APIs.hiding-apis: the name of the region that is ‘hidden’ i.e. not as visible as the exporting one. The packages in the exporting-api cannot depend on any packages from this region.api-regions-duplicates: This analyser ensures that packages are only listed in one region in a given feature. If the same package is listed in multiple regions this will be an error.
api-regions-check-order: This analyser checks that regions are defined in the specified order and that the same region is only declared once. Later regions inherit the packages expose in earlier regions in the list, so the order is important.
order: A comma separated list of the region names declaring the order in which they should be found. Not all regions declared must be present, but if they are present this order must be obeyed.The following extensions are also implemented by this component and made available through the Service Loader mechanism: