Apache Sling Feature API Regions Runtime

Clone this repo:
  1. c4ce349 SLING-12094 - Use GitHub for the Maven scm.url value by Robert Munteanu · 6 months ago master
  2. 459acca [maven-release-plugin] prepare for next development iteration by Konrad Windszus · 11 months ago
  3. db3dd37 [maven-release-plugin] prepare release org.apache.sling.feature.apiregions-1.1.10 by Konrad Windszus · 11 months ago org.apache.sling.feature.apiregions-1.1.10
  4. b2e1131 SLING-11405 Update to Bundle Parent 49 by Konrad Windszus · 11 months ago
  5. 04734b9 SLING-11709 - Set up Jira autolinks to all Sling Github projects by Robert Munteanu · 1 year, 1 month ago

Apache Sling

Build Status Test Status Coverage Sonarcloud Status JavaDoc Maven Central feature License

Apache Sling API Regions runtime component

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 idbsnver.properties file.
  • sling.feature.apiregions.resource.bundles.properties - provides the location of the bundles.properties file.
  • sling.feature.apiregions.resource.features.properties - provides the location of the features.properties file.
  • sling.feature.apiregions.resource.regions.properties - provides the location of the regions.properties file.

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.

Enabling / disabling this component

The component is enabled by setting the following framework property:


If this framework property is not set the component will be disabled.

Additional Configuration

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 global region.

Runtime Configuration

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:

PID: org.apache.sling.feature.apiregions.impl

disableif true then the API Regions component is disabled. Otherwise the component is enabled.

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:

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

Configuration Files

  • idbsnver.properties contains a mapping from Maven artifact ID to BSN+Version in the following format: groupid:artifactId:version=bsn~1.0.0
  • bundles.properties lists what feature a bundle (by Maven ID) is defined in, could be more than one feature, so the value is comma-separated e.g.: org.sling:mybundles:1=some.other:feature:123,org.sling:something:1.2.3:slingosgifeature:myclassifier
  • features.properties lists for a feature ID what regions this feature is in, also comma separated, e.g: org.sling:myfeature:1.2.3=internal,global
  • regions.properties contains for each region a list of package names that are exported in this region, e.g. global=d.e.f,test,a.b.c