Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

SPI shouldn't expose impl types

Description

o.h.s.e.spi.AbstractDocumentBuilder exposes TypeMetadata which resides in the impl package:

public TypeMetadata getTypeMetadata() { ... }

I think TypeMetadata et al. should be moved to *.spi as well.

Activity

Show:

Yoann Rodière April 25, 2018 at 8:05 AM

Resolved as part of the Search 6 proof of concept groundwork.
We also set up tooling to prevent this from happening again in the future (https://hibernate.atlassian.net/browse/HSEARCH-1664#icft=HSEARCH-1664)

Gunnar Morling April 25, 2017 at 8:43 PM

You can also use the jQAssistant set-up we're having in HV to detect these inconsistencies: http://in.relation.to/2017/01/31/preventing-leaky-apis-with-jqassistant/.

Yoann Rodière April 25, 2017 at 2:57 PM

Note that build logs seem to actually highlight those problems:

[WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.backend.spi, has 2, private references [org.hibernate.search.backend.impl, org.hibernate.search.backend.configuration.impl], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.engine.spi, has 3, private references [org.hibernate.search.analyzer.spi, org.hibernate.search.engine.impl, org.hibernate.search.engine.metadata.impl], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.engine.integration.impl, has 3, private references [org.hibernate.search.indexes.impl, org.hibernate.search.analyzer.spi, org.hibernate.search.engine.impl], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.indexes.spi, has 3, private references [org.hibernate.search.analyzer.spi, org.hibernate.search.engine.nulls.impl, org.hibernate.search.backend.impl.lucene], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.spi, has 1, private references [org.hibernate.search.indexes.impl], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.store, has 1, private references [org.hibernate.search.backend.impl], [WARNING] Manifest org.hibernate:hibernate-search-engine:jar:5.8.0-SNAPSHOT : Export org.hibernate.search.util.logging.impl, has 2, private references [org.hibernate.search.analyzer.spi, org.hibernate.search.analyzer.impl],

Noticed while working on https://hibernate.atlassian.net/browse/HSEARCH-2698#icft=HSEARCH-2698

Hardy Ferentschik September 6, 2013 at 9:57 AM

> Is AbstractDocumentBuilder actually an SPI type, i.e. are we expecting others to extend it and build their own document builder types

Not in my world, but might know more

> Regarding the getter, if it is not intended to be used by integrators, who is the intended user then? Maybe it just could be removed? Or if required internally, moved to an internally-used extension of AbstractDocumentBuilder?

It is for internal use.

Gunnar Morling September 5, 2013 at 7:40 AM

Is AbstractDocumentBuilder actually an SPI type, i.e. are we expecting others to extend it and build their own document builder types (given all the types in *.spi it may be though that I'm having another definition of "SPI" in mind than the one used here)?

Regarding the getter, if it is not intended to be used by integrators, who is the intended user then? Maybe it just could be removed? Or if required internally, moved to an internally-used extension of AbstractDocumentBuilder?

Should we ever want to OSGi-ify SEARCH (or restrict the public packages of the JBoss module) such leakage of non-exported types via public signatures would cause some trouble.

Fixed

Details

Assignee

Reporter

Components

Fix versions

Affects versions

Priority

Created August 15, 2013 at 10:17 AM
Updated November 28, 2018 at 3:43 PM
Resolved April 25, 2018 at 8:05 AM
Configure