[jboss-jira] [JBoss JIRA] (WFWIP-108) OpenTracing modules need jboss-api=private in module.xml

[Juraci Paixão Kröhling (JIRA)]

    [ https://issues.jboss.org/browse/WFWIP-108?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13619315#comment-13619315 ] 

Juraci Paixão Kröhling commented on WFWIP-108:
----------------------------------------------

The modules are:

org.eclipse.microprofile.opentracing
org.wildfly.microprofile.opentracing-smallrye
org.wildfly.extension.microprofile.opentracing

As the MP-Config one (org.eclipse.microprofile.config.api) does *not* specify this property, I'd like to confirm whether ours should indeed include it.

> OpenTracing modules need jboss-api=private in module.xml
> --------------------------------------------------------
>
>                 Key: WFWIP-108
>                 URL: https://issues.jboss.org/browse/WFWIP-108
>             Project: WildFly WIP
>          Issue Type: Bug
>          Components: MP Request Tracing
>            Reporter: Brian Stansberry
>            Assignee: Juraci Paixão Kröhling
>            Priority: Blocker
>
> The 3 modules added in https://github.com/wildfly/wildfly/pull/11454 need this in their module.xml:
> {code}
>     <properties>
>         <property name="jboss.api" value="private"/>
>     </properties>
> {code}
> This ensures that we log a WARN if the user tries to _directly_ use these modules as application dependencies. (Directly == via their own deployment configuration, not via our subsystem wiring them in as a dependency. See [1] for the impl.) 
> These log WARNs and the setting in the file itself are important both to prevent the user making mistakes and as the formal the mechanism by which we control how we support use of the various libraries we ship in the appserver. Marking modules private, deprecated etc gives us the freedom to rework implementations without worrying about breaking unexpected uses of things.
> [1] https://github.com/wildfly/wildfly-core/blob/master/server/src/main/java/org/jboss/as/server/moduleservice/ModuleLoadService.java#L69



--
This message was sent by Atlassian JIRA
(v7.5.0#75005)