[OAK-3919] Properly manage APIs / SPIs intended for public consumption

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: core
• Labels: modularization technical_debt
• Epic Link: Modularisation of Oak
• Assignee: Unassigned
• Reporter: Michael Dürig
• Created: 25/Jan/16 10:05
• Updated: 26/May/21 14:52

Description

This is a follow up to OAK-3842, which removed package export declarations for all packages that we either do not want to be used outside of Oak or that are not stable enough yet.

This issue is to identify those APIs and SPIs of Oak that we actually want to export and to refactor those such we can export them.

Candidates that are currently used from upstream projects I know of are:

      org.apache.jackrabbit.oak.plugins.observation
      org.apache.jackrabbit.oak.spi.commit
      org.apache.jackrabbit.oak.spi.state
      org.apache.jackrabbit.oak.commons
      org.apache.jackrabbit.oak.plugins.index.lucene

I suggest to create subtask for those we want to go forward with.

Issue Links

• is blocked by: OAK-6826 Refactor Jcr class to remove dependency on o.a.j.oak.plugins.index
• is related to: OAK-6408 Review package exports for o.a.j.oak.plugins.index.*
• is related to: OAK-3842 Adjust package export declarations
• relates to: OAK-3842 Adjust package export declarations

Sub-Tasks

• Add package export version for spi.xml: Closed
• Add package export versions for core-spi: Closed
• Non-existing package o.a.j.oak.util is exported twice: Closed
• org.apache.jackrabbit.oak.management is exported but not used outside of oak-core: Closed
• Add package export versions for oak-commons: Closed
• org.apache.jackrabbit.oak.security.authentication.ldap must not be exported / filtered in parent: Closed
• Add package export versions for oak-store-spi: Open
• Non-existing package o.a.j.oak.util is filtered in parent/pom.xml: Closed
• Add package export versions for oak-query-spi: Closed
• Remove export for org.apache.jackrabbit.oak.plugins.itemsave: Closed
• Remove export for org.apache.jackrabbit.oak.security: Closed
• Remove package export for org.apache.jackrabbit.oak.plugins.atomic: Closed
• Remove package export for org.apache.jackrabbit.oak.plugins.index.counter: Closed
• Remove package export for org.apache.jackrabbit.oak.plugins.index.nodetype: Closed
• Remove package export for org.apache.jackrabbit.oak.plugins.index.property.jmx: Closed
• Remove package oaj.oak.commons.hash and move SipHash to oak-core: Closed