Adding sonarqube badges as per SLING-9682
1 file changed
tree: 7271b67d6891b943f42cf654d345e92f16606746
  1. .asf.yaml
  2. .gitignore
  5. Jenkinsfile
  8. pom.xml
  9. src/

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

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 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:

  • - provides the location of the file.
  • - provides the location of the file.
  • - provides the location of the file.
  • - provides the location of the 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:


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/

Configuration Files

  • contains a mapping from Maven artifact ID to BSN+Version in the following format: groupid:artifactId:version=bsn~1.0.0
  • 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.:,
  • lists for a feature ID what regions this feature is in, also comma separated, e.g:,global
  • 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