Re: [jakartaee-spec-project-leads] Automatic Module Names for Jakarta EE

[Mark Thomas <markt@xxxxxxxxxx>]

On 29/01/2020 22:28, David Blevins wrote:
> Related question, what module name should we use for Geronimo JavaMail?

My suggestion (and it is only a suggestion) would be to follow the
guidelines here for OSGi BundleSymbolicName for implementations:

https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules

and replace "-" (if any) with ".".

which I think would give you something like

org.apache.geronimo.jakarta.mail

Mark


> 
> On Wed, Jan 29, 2020 at 10:21 AM Anthony Vanelverdinghe
> <anthonyv.be@xxxxxxxxxxx <mailto:anthonyv.be@xxxxxxxxxxx>> wrote:
> 
>     Why is the Jakarta Mail implementation allowed to use a module name
>     in the jakarta namespace? Isn't the "jakarta.*" namespace reserved
>     for specifications?
>     I always assumed it was, in which case the ".api" suffix doesn't add
>     any value & should be dropped.
> 
>     Kind regards, Anthony
> 
>     On 29/01/2020 17:49, Kevin Sutter wrote:
>>     Lukas,
>>     We are only trying to establish a convention for the Specification
>>     (API) Projects.  The implementations might need to establish their
>>     own module naming conventions.
>>
>>     For the specific case you referenced
>>     <https://github.com/eclipse-ee4j/mail/issues/409>, isn't that a
>>     quirk with Jakarta Mail?  Under normal conditions, there should be
>>     a clear separation between the API and the Implementation.
>>
>>     ---------------------------------------------------
>>     Kevin Sutter
>>     STSM, MicroProfile and Jakarta EE architect @ IBM
>>     e-mail:  sutter@xxxxxxxxxx <mailto:sutter@xxxxxxxxxx>     Twitter:
>>      @kwsutter
>>     phone: tl-553-3620 (office), 507-253-3620 (office)    
>>     LinkedIn: https://www.linkedin.com/in/kevinwsutter
>>
>>
>>
>>     From:        Lukas Jungmann <lukas.jungmann@xxxxxxxxxx>
>>     <mailto:lukas.jungmann@xxxxxxxxxx>
>>     To:        jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     Date:        01/29/2020 09:59
>>     Subject:        [EXTERNAL] Re: [jakartaee-spec-project-leads]
>>     Automatic Module Names for Jakarta EE 9
>>     Sent by:        jakartaee-spec-project-leads-bounces@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads-bounces@xxxxxxxxxxx>
>>     ------------------------------------------------------------------------
>>
>>
>>
>>     On 1/29/20 3:43 PM, Kevin Sutter wrote:
>>     > Is it a requirement that all of the Projects use the OSGI
>>     > Bundle-SymbolicName?  (It probably is due to the use of the
>>     maven bundle
>>     > plugin, but I thought I would ask...)
>>
>>     Yes; GF is based on OSGi so whatever gets there, needs to be OSGi
>>     bundle
>>     and "The Bundle-SymbolicName manifest header is a mandatory
>>     header."[1]
>>
>>     >
>>     > Just to be clear with an example, I looked at Servlet:
>>     > <bundle.symbolicName>jakarta.servlet-api</bundle.symbolicName>
>>     >
>>     > Thus, your proposed Automatic Module name would be (given your
>>     proposed
>>     > rules)?
>>     > jakarta.servlet.api
>>     >
>>     > Are we good with this approach across the Jakarta EE Projects?
>>
>>     no on my end as it may require implementation module to be called
>>     API in
>>     certain cases, ie https://github.com/eclipse-ee4j/mail/issues/409 has
>>     some details. JDK does not use "api" in their module names too.
>>     But if
>>     majority wants it this way...
>>
>>     thanks,
>>     --lukas
>>
>>     [1]:
>>     https://osgi.org/specification/osgi.core/7.0.0/framework.module.html#framework.module.bsn
>>     >
>>     > ---------------------------------------------------
>>     > Kevin Sutter
>>     > STSM, MicroProfile and Jakarta EE architect @ IBM
>>     > e-mail:  sutter@xxxxxxxxxx <mailto:sutter@xxxxxxxxxx>    
>>     Twitter:  @kwsutter
>>     > phone: tl-553-3620 (office), 507-253-3620 (office)
>>     > LinkedIn: https://www.linkedin.com/in/kevinwsutter
>>     >
>>     >
>>     >
>>     > From: Mark Thomas <markt@xxxxxxxxxx> <mailto:markt@xxxxxxxxxx>
>>     > To: JakartaEE Spec Project Leadership discussions
>>     > <jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     > Date: 01/29/2020 06:40
>>     > Subject: [EXTERNAL] Re: [jakartaee-spec-project-leads] Automatic
>>     Module
>>     > Names for Jakarta EE 9
>>     > Sent by: jakartaee-spec-project-leads-bounces@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads-bounces@xxxxxxxxxxx>
>>     >
>>     ------------------------------------------------------------------------
>>     >
>>     >
>>     >
>>     > Thanks for the links.
>>     >
>>     > My reading of this is that my proposal to:
>>     >
>>     > - Take the OSGi Bundle-SymbolicName
>>     > - Replace any "-" with "."
>>     > - Use that as the automatic module name
>>     >
>>     > is consistent with the requirement that the module names start with
>>     > "jakarta." and not inconsistent with any other Jakarta EE wide
>>     policy.
>>     >
>>     > I therefore intend to proceed with this approach in the projects in
>>     > which I am involved.
>>     >
>>     > Separately, I'd like to recommend this proposed approach for
>>     adoption
>>     > across Jakarta EE.
>>     >
>>     > Thanks,
>>     >
>>     > Mark
>>     >
>>     >
>>     > On 28/01/2020 18:13, Kevin Sutter wrote:
>>     >> Thanks for the pointer to the Issue.  Here's the reference to
>>      the PMC
>>     >> minutes regarding Module Names:
>>     >>  https://www.eclipse.org/ee4j/minutes/?date=2018-11-06#module-names
>>     >>
>>     >> This was the discussion previous to the Jakarta EE 8 release.
>>      It  has
>>     >> not been formally addressed for the Jakarta EE 9 release.  I
>>      still stand
>>     >> by the "jakarta." prefix, but we haven't declared the required
>>     >> definition of module names across all individual projects.
>>     >>
>>     >> ---------------------------------------------------
>>     >> Kevin Sutter
>>     >> STSM, MicroProfile and Jakarta EE architect @ IBM
>>     >> e-mail:  sutter@xxxxxxxxxx <mailto:sutter@xxxxxxxxxx>    
>>     Twitter:  @kwsutter
>>     >> phone: tl-553-3620 (office), 507-253-3620 (office)    
>>     >> LinkedIn: https://www.linkedin.com/in/kevinwsutter
>>     >>
>>     >>
>>     >>
>>     >> From:        Anthony Vanelverdinghe <anthonyv.be@xxxxxxxxxxx>
>>     <mailto:anthonyv.be@xxxxxxxxxxx>
>>     >> To:        JakartaEE Spec Project Leadership discussions
>>     >> <jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>, Mark Thomas
>>     <markt@xxxxxxxxxx> <mailto:markt@xxxxxxxxxx>
>>     >> Date:        01/28/2020 11:53
>>     >> Subject:        [EXTERNAL] Re: [jakartaee-spec-project-leads]
>>      Automatic
>>     >> Module Names for Jakarta EE 9
>>     >> Sent by:      
>>      jakartaee-spec-project-leads-bounces@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads-bounces@xxxxxxxxxxx>
>>     >>
>>     ------------------------------------------------------------------------
>>     >>
>>     >>
>>     >>
>>     >> Hi Mark
>>     >>
>>     >> There's [1], which says that module names must be "jakarta.*",
>>      so e.g.
>>     >> jakarta.el, jakarta.websocket, jakarta.servlet
>>     >> I've been unable to find the issued PMC statement though.
>>     >>
>>     >> [1]
>>     https://github.com/eclipse-ee4j/ee4j/issues/34#issuecomment-436605211
>>     >>
>>     >> Kind regards,
>>     >> Anthony
>>     >>
>>     >> On 28/01/2020 18:02, Mark Thomas wrote:
>>     >>> Hi,
>>     >>>
>>     >>> A number of projects I am involved in have open issues for
>>     JPMS  names to
>>     >>> be defined [1][2][3]. Using the JAR name is inherently
>>     unstable  and
>>     >>> triggers warnings in various build systems.
>>     >>>
>>     >>> Is there an official view on what project should be using? I
>>     looked  in
>>     >>> [4] but module names are explicitly excluded.
>>     >>>
>>     >>> Absent an official view, is there any objection to projects using:
>>     >>> - Take the OSGi Bundle-SymbolicName
>>     >>> - Replace any "-" with "."
>>     >>> - Use that as the automatic module name
>>     >>> ?
>>     >>>
>>     >>> Thanks,
>>     >>>
>>     >>> Mark
>>     >>>
>>     >>>
>>     >>> [1] https://github.com/eclipse-ee4j/el-ri/issues/46
>>     >>> [2] https://github.com/eclipse-ee4j/websocket-api/issues/260
>>     >>> [3] https://github.com/eclipse-ee4j/servlet-api/issues/201
>>     >>>
>>     >>> [4] https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules
>>     >>>
>>     >>>
>>     >>> _______________________________________________
>>     >>> jakartaee-spec-project-leads mailing list
>>     >>> jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     >>> To change your delivery options, retrieve your password, or
>>     unsubscribe  from this list, visit
>>     >>>
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>>     >> _______________________________________________
>>     >> jakartaee-spec-project-leads mailing list
>>     >> jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     >> To change your delivery options, retrieve your password, or
>>     unsubscribe
>>     >> from this list, visit
>>     >>
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>>     >>
>>     >>
>>     >>
>>     >>
>>     >
>>     > _______________________________________________
>>     > jakartaee-spec-project-leads mailing list
>>     > jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     > To change your delivery options, retrieve your password, or
>>     unsubscribe
>>     > from this list, visit
>>     >
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>>     >
>>     >
>>     >
>>     >
>>     >
>>     > _______________________________________________
>>     > jakartaee-spec-project-leads mailing list
>>     > jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     > To change your delivery options, retrieve your password, or
>>     unsubscribe from this list, visit
>>     >
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>>     >
>>     _______________________________________________
>>     jakartaee-spec-project-leads mailing list
>>     jakartaee-spec-project-leads@xxxxxxxxxxx
>>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     To change your delivery options, retrieve your password, or
>>     unsubscribe from this list, visit
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>>
>>
>>
>>
>>
>>     _______________________________________________
>>     jakartaee-spec-project-leads mailing list
>>     jakartaee-spec-project-leads@xxxxxxxxxxx <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>>     To change your delivery options, retrieve your password, or unsubscribe from this list, visit
>>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>     _______________________________________________
>     jakartaee-spec-project-leads mailing list
>     jakartaee-spec-project-leads@xxxxxxxxxxx
>     <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
>     To change your delivery options, retrieve your password, or
>     unsubscribe from this list, visit
>     https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
> 
> -- 
> Sent from Gmail Mobile
> 
> _______________________________________________
> jakartaee-spec-project-leads mailing list
> jakartaee-spec-project-leads@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
>