The API Regions runtime component is implemented as an OSGi Framework Extension bundle. This ensures that the runtime component is always present early in the startup process. For more information about API Regions see https://github.com/apache/sling-org-apache-sling-feature/blob/master/apicontroller.md
This component registers an OSGi resolver hook service which enforces the API regions at runtime. The component looks for properties files that provide the configuration of the API regions. The properties files are generated by the https://github.com/apache/sling-org-apache-sling-feature-extension-apiregions component during the extension post-processing.
As the component has no dependencies on any other component, the properties files are obtained via Framework Properties lookups:
sling.feature.apiregions.resource.idbsnver.properties- provides the location of the
sling.feature.apiregions.resource.bundles.properties- provides the location of the
sling.feature.apiregions.resource.features.properties- provides the location of the
sling.feature.apiregions.resource.regions.properties- provides the location of the
Alternatively, the directory where all of the above files can be found can be specified using one Framework Property instead of using the above framework properties:
sling.feature.apiregions.location- provides the location where all properties file can be found. If this property is specified the above properties are not necessary. However if both are provided the file-specific properties take precedence.
File locations are either provided as an absolute file path or by URL. The URL handling mechanism supports one special pseudo-protocol:
classloader://. URLs specified with this protocol are passed through the framework classloader's
getResource() method to obtain the actual URL.
The component is enabled by setting the following framework property:
If this framework property is not set the component will be disabled.
The following framework properties are also recognised:
sling.feature.apiregions.default- a comma-separated list of region names. Each bundle installed will be added to these regions, regardless of whether it's installed in a feature or not.
sling.feature.apiregions.joinglobal- a comma-separated list of region names. All packages exported by these regions are added to the
If this component runs in a framework with Configuration Admin present, and it is set to be enabled using the framework property, it can be disabled at runtime through Configuration Admin configuration.
Runtime configuration supported:
No meta type is defined for this configuration since it's not a typical user setting. However, when using the web console the configuration can be created using
curl -u <user>:<pass> -X POST -d "apply=true" -d "propertylist=disable" -d "disable=true" http://localhost:8080/system/console/configMgr/org.apache.sling.feature.apiregions.impl
idbsnver.propertiescontains a mapping from Maven artifact ID to BSN+Version in the following format:
bundles.propertieslists what feature a bundle (by Maven ID) is defined in, could be more than one feature, so the value is comma-separated e.g.:
features.propertieslists for a feature ID what regions this feature is in, also comma separated, e.g:
regions.propertiescontains for each region a list of package names that are exported in this region, e.g.