Details
-
Improvement
-
Status: Open
-
Minor
-
Resolution: Unresolved
-
None
-
None
-
None
Description
Our documentation on Sling Jobs mentions that:
The job topic follows the conventions for the topic of an OSGi event.
Which, after finding and reviewing the relevant documentation:
https://docs.osgi.org/specification/osgi.cmpn/7.0.0/service.event.html#d0e46909
https://docs.osgi.org/specification/osgi.core/7.0.0/ch01.html#framework.general.syntax
One could determine means a string which:
- Does not start or end with a slash
- Contains only ASCII alphanumeric, underscore, dash, and slash characters
- Does not contain double slashes
However, it would be more convenient for users of Apache Sling to document the rules on the Jobs page for easy reference and to indicate that attempting to add a Job with an invalid topic with JobManager#addJob will return null.