|
11 | 11 |
|
12 | 12 | A [Bnd](https://bnd.bndtools.org/) plugin that validates OSGi bundle metadata compliance with configurable namespacing rules. This plugin helps ensure consistent naming conventions and organizational standards across OSGi bundles in enterprise projects. It validates the following aspects of an OSGi bundle |
13 | 13 |
|
14 | | -- **Export Packages** - Validates that [exported packages](https://docs.osgi.org/specification/osgi.core/8.0.0/framework.module.html#framework.module.exportpackage) follow naming conventions |
15 | | -- **Bundle Symbolic Names** - Ensures [bundle symbolic names](https://docs.osgi.org/specification/osgi.core/8.0.0/framework.module.html#framework.module.bsn) conform to organizational standards |
| 14 | +- **Export Package** - Validates that [exported packages](https://docs.osgi.org/specification/osgi.core/8.0.0/framework.module.html#framework.module.exportpackage) follow naming conventions |
| 15 | +- **Bundle Symbolic Name** - Ensures [bundle symbolic names](https://docs.osgi.org/specification/osgi.core/8.0.0/framework.module.html#framework.module.bsn) follow naming conventions |
16 | 16 | - **DS Component Provided Services** - Validates [provided service FQCNs in DS components](https://docs.osgi.org/specification/osgi.cmpn/8.1.0/service.component.html#service.component-service.element) |
17 | 17 | - **HTTP/Servlet Whiteboard** - Validates that HTTP servlets/filters registered via [HTTP/servlet whiteboard](https://docs.osgi.org/specification/osgi.cmpn/8.1.0/service.servlet.html) are listening to specific paths only |
18 | 18 | - **Sling Servlet/Filter** - Validates [Sling servlet](https://sling.apache.org/documentation/the-sling-engine/servlets.html) paths, resource types, and resource super types as well as [Sling filter](https://sling.apache.org/documentation/the-sling-engine/filters.html) patterns/resource types |
19 | 19 | - **Sling Authentication Handler** - Validates a [Sling Authentication Handler](https://sling.apache.org/documentation/the-sling-engine/authentication/authentication-authenticationhandler.html) is registered to a specific path only |
20 | 20 |
|
21 | 21 | ## Features |
22 | 22 |
|
23 | | -### Export Packages |
| 23 | +### Export Package |
24 | 24 | Validates that all exported packages match a specified regular expression pattern. |
25 | 25 |
|
26 | | -### Bundle Symbolic Name sn |
| 26 | +### Bundle Symbolic Name |
27 | 27 | Ensures Bundle-SymbolicName headers conform to naming conventions, with support for parameter handling (e.g., `singleton:=true`). |
28 | 28 |
|
29 | 29 | ### DS Component Provided Services |
@@ -65,7 +65,7 @@ Parameter | Type | Description |
65 | 65 | ----------|------|------------- |
66 | 66 | `allowedExportPackagePatterns` | Pattern[] | Regular expression(s) for validating exported package names |
67 | 67 | `allowedBundleSymbolicNamePatterns` | Pattern[] | Regular expression(s) for validating Bundle-SymbolicName header |
68 | | -`allowedServiceClassPatterns` | Pattern[] | Regular expression(s) for validating OSGi service interface FQCNs |
| 68 | +`allowedServiceClassPatterns` | Pattern[] | Regular expression(s) for validating provided service FQCNs of DS components |
69 | 69 | `allowedHttpWhiteboardServletPatterns` | Pattern[] | Regular expression(s) for validating HTTP Whiteboard servlet patterns (`osgi.http.whiteboard.servlet.pattern`) |
70 | 70 | `allowedHttpWhiteboardFilterPatterns` | Pattern[] | Regular expression(s) for validating HTTP Whiteboard filter patterns (`osgi.http.whiteboard.filter.pattern`) |
71 | 71 | `allowedSlingServletPathsPatterns` | Pattern[] | Regular expression(s) for validating Sling servlet paths (`sling.servlet.paths`) |
@@ -125,4 +125,4 @@ This project is licensed under the Eclipse Public License 2.0 - see the [LICENSE |
125 | 125 |
|
126 | 126 | - [AEM Content Package Namespace Validators](https://github.com/Netcentric/aem-content-package-namespace-validators) - Content package validation |
127 | 127 | - [Bnd Tools](https://bnd.bndtools.org/) - OSGi development tools |
128 | | -- [Apache Sling](https://sling.apache.org/) - Web framework for the JVM |
| 128 | +- [Apache Sling](https://sling.apache.org/) - Web framework for the JVM |
0 commit comments