Skip to content

Commit 98086f3

Browse files
committed
Add missing configuration parameters to README
1 parent 49abb16 commit 98086f3

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ A [Bnd](https://bnd.bndtools.org/) plugin that validates OSGi bundle metadata co
1515
- **Bundle Symbolic Names** - Ensures bundle symbolic names conform to organizational standards
1616
- **OSGi DS Component Service Interfaces** - Validates service interface FQCNs in OSGi DS components
1717
- **OSGi 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-
- **Sling Servlet/Filter** - Validates Sling servlet paths, resource types, and resource super types as well as filter patterns/resource types
19-
- **Sling Authenticator** - Validates a Sling authenticator is registered to a specific path only
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+
- **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
2020

2121
## Features
2222

@@ -50,7 +50,8 @@ For DS components implementing `javax.servlet.Filter` or `jakarta.servlet.Filter
5050
- `sling.filter.pattern` - Servlet filter patterns
5151
- `sling.filter.resourceTypes` - Resource type patterns
5252

53-
53+
### Sling Authentication Handler
54+
For DS components implementing `org.apache.sling.auth.core.spi.AuthenticationHandler` validates property `path`.
5455

5556
## Configuration
5657

@@ -61,14 +62,19 @@ In general [Bnd's -plugin instruction](https://bnd.bndtools.org/instructions/plu
6162

6263
Parameter | Type | Description
6364
----------|------|-------------
64-
`allowedExportPackagePatterns` | Pattern[] | Regular expression for validating exported package names
65-
`allowedBundleSymbolicNamePatterns` | Pattern[] | Regular expression for validating Bundle-SymbolicName header
66-
`allowedServiceClassPatterns` | Pattern[] | Regular expression for validating OSGi service interface FQCNs
67-
`slingServletPathsPattern` | Pattern[] | Regular expression for validating Sling servlet paths
68-
`slingServletResourceTypesPattern` | Pattern[] | Regular expression for validating Sling servlet resource types
69-
`slingServletResourceSuperTypePattern` | Pattern[] | Regular expression for validating Sling servlet resource super types
70-
71-
Each parameter may take multiple regular expression patterns separated by comma. That makes the comma itself unusable within the regular expression pattern itself, however this shouldn't be necessary there.
65+
`allowedExportPackagePatterns` | Pattern[] | Regular expression(s) for validating exported package names
66+
`allowedBundleSymbolicNamePatterns` | Pattern[] | Regular expression(s) for validating Bundle-SymbolicName header
67+
`allowedServiceClassPatterns` | Pattern[] | Regular expression(s) for validating OSGi service interface FQCNs
68+
`allowedOsgiHttpWhiteboardServletPatterns` | Pattern[] | Regular expression(s) for validating OSGi HTTP Whiteboard servlet patterns (`osgi.http.whiteboard.servlet.pattern`)
69+
`allowedOsgiHttpWhiteboardFilterPatterns` | Pattern[] | Regular expression(s) for validating OSGi HTTP Whiteboard filter patterns (`osgi.http.whiteboard.filter.pattern`)
70+
`slingServletPathsPatterns` | Pattern[] | Regular expression(s) for validating Sling servlet paths (`sling.servlet.paths`)
71+
`slingServletResourceTypesPatterns` | Pattern[] | Regular expression(s) for validating Sling servlet resource types (`sling.servlet.resourceTypes`)
72+
`slingServletResourceSuperTypePatterns` | Pattern[] | Regular expression(s) for validating Sling servlet resource super types (`sling.servlet.resourceSuperType`)
73+
`slingFilterPatterns` | Pattern[] | Regular expression(s) for validating Sling filter patterns (`sling.filter.pattern`)
74+
`slingFilterResourceTypesPatterns` | Pattern[] | Regular expression(s) for validating Sling filter resource types (`sling.filter.resourceTypes`)
75+
`slingAuthHandlerPathPatterns` | Pattern[] | Regular expression(s) for validating Sling Authentication Handler path property (`path`)
76+
77+
Each parameter may take multiple [regular expression patterns](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html) separated by comma. That makes the comma itself unusable within the regular expression pattern itself, however this shouldn't be necessary there.
7278
All parameters are optional. If not set the according property/name/header is not validated.
7379

7480
## Usage
@@ -118,7 +124,4 @@ This project is licensed under the Eclipse Public License 2.0 - see the [LICENSE
118124

119125
- [AEM Content Package Namespace Validators](https://github.com/Netcentric/aem-content-package-namespace-validators) - Content package validation
120126
- [Bnd Tools](https://bnd.bndtools.org/) - OSGi development tools
121-
- [Apache Sling](https://sling.apache.org/) - Web framework for the JVM
122-
123-
124-
127+
- [Apache Sling](https://sling.apache.org/) - Web framework for the JVM

0 commit comments

Comments
 (0)