Uploaded image for project: 'Sling'
  1. Sling
  2. SLING-11067

Extend URIProvider to not rely on exceptions if URIs can not be provided for a resource

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: In Progress
    • Major
    • Resolution: Unresolved
    • None
    • None
    • API
    • None

    Description

      Currently URIProvider is not allowed to return null according to https://github.com/apache/sling-org-apache-sling-api/blob/333fa20f07a1d42897c9e0b6253bec5dcedb3e0b/src/main/java/org/apache/sling/api/resource/external/URIProvider.java#L48.
      This forces every URIProvider to throw an exception for the (pretty common) case it cannot provide a URI for a resource.

      As creating exceptions comes with quite some overhead, I would propose to enhance that interface.
      As just allowing null return values would be backwards-incompatible I would propose to instead add a second method called Optional<URI> getOptionalUriForResource(Resource, Scope, Operation) with a default implementation which calls toUri(...) and properly catches and logs IllegalArgumentExceptions. At the same time I would deprecate the existing method toURI(...).

      Compare with the discussion at https://lists.apache.org/thread/xfgmrxbv6n1k5y57v6kq9pxnkyr6hcyb

      Attachments

        Issue Links

          Activity

            People

              kwin Konrad Windszus
              kwin Konrad Windszus
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2h 40m
                  2h 40m