Most spec project have a root package which holds all of its APIs. The module name should generally be equal to the root package name as this is then easy for mental mapping of API to containing module name.
For the mentioned specs:
bean-validation -> jakarta.validation
dependency-injection -> This project does not have a common root package (sigh). jakarta.enterprise.inject is probably the better name or jakarta.enterprise.context.
enterprise-beans -> jakarta.ejb
Only when the API does not have a common root package does additional thought need to be put into the module name.
--
BJ Hargrave
Senior Technical Staff Member, IBM // office: +1 386 848 1781
OSGi Fellow and OSGi Specification Project lead // mobile: +1 386 848 3788
hargrave@xxxxxxxxxx
----- Original message -----
From: "Scott Stark" <starksm64@xxxxxxxxx>
Sent by: "jakartaee-platform-dev" <jakartaee-platform-dev-bounces@xxxxxxxxxxx>
To: "jakartaee-platform developer discussions" <jakartaee-platform-dev@xxxxxxxxxxx>
Cc:
Subject: Re: [jakartaee-platform-dev] [External] : Re: [jakartaee-spec-project-leads] Module-info handling conventions for EE10
Date: Tue, Nov 2, 2021 13:18
Ok, thanks Lukas. So specName should be from the Code column, but this still does not completely work as module names cannot have a hyphen in them. It seems that we need to add a JPMS name column and copy the Code column with updates to those which are using a hyphen:
bean-validation -> validation
dependency-injection -> injection
enterprise-beans -> ejb or beans?
On 11/2/21 5:29 PM, Scott Stark wrote:
Ok, apologies, I thought that we had decided on that document as the
base with the API_PACKAGE as the JMPS module name. I'll verify this on
the platform list and update that document accordingly.
should be jakarta.<specName>, so for servlet, the name becomes
jakarta.servlet; see also
https://eclipse-ee4j.github.io/jakartaee-platform/jakartaee10/JakartaEE10ReleasePlanthanks,
--lukas
On Nov 2, 2021 at 10:21:29 AM, Mark Thomas <markt@xxxxxxxxxx
<mailto:markt@xxxxxxxxxx>> wrote:
Scott,
I read that document before I wrote my email.
<quote>
NOTE: This document does not yet specify requirements for Java
platform module system names.
</quote>
Given that:
- module-info is now being mandated; and
- module name is a required part of module-info;
where can I find rules / guidance / etc for the JPMS module name?
The projects I am involved with have automatic module names defined in
the manifest. We could just use those but I'd very much prefer to check
them against the rules / guidance / etc before doing so.
Mark
On 02/11/2021 15:59, Scott Stark wrote:
> Mark,
>
> These the conventions that we came up with for EE since EE8:
> https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules
> <https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules>
>
> <https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules
> <https://wiki.eclipse.org/JakartaEE_Maven_Versioning_Rules>>
>
> Follow up with any questions.
>
> Scott
>
> On Nov 2, 2021 at 9:05:16 AM, Mark Thomas <markt@xxxxxxxxxx
> <mailto:markt@xxxxxxxxxx>
> <mailto:markt@xxxxxxxxxx <mailto:markt@xxxxxxxxxx>>> wrote:
>
> Scott,
>
> I'm starting to look at this for the various specs I am
> involved in.
>
> Where can I find the rules / guidance / etc for what the
> module name
> should be?
>
> Thanks,
>
> Mark
>
>
> On 18/10/2021 15:49, Scott Stark wrote:
> > The last platform group meeting seemed to settle on the
> following
> > requirements for spec project API jars:
> >
> https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars>
> >
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars>>
> >
> >
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars>
> >
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars
> <https://github.com/eclipse-ee4j/jakartaee-platform/wiki/Modularized-Jars>>>
> >
> > If you are producing a Java 8 compatible service release for
> EE10, an
> > example of how to produce the expected format is given there.
> >
> >
> > _______________________________________________
> > jakartaee-spec-project-leads mailing list
> > jakartaee-spec-project-leads@xxxxxxxxxxx
> <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>
> > <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx
> <mailto:jakartaee-spec-project-leads@xxxxxxxxxxx>>
> > To unsubscribe from this list, visit
> >
> https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
> <https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads>
> >
> <https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
> <https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads>>
> >
>
_______________________________________________
jakartaee-spec-project-leads mailing list
jakartaee-spec-project-leads@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads
_______________________________________________
jakartaee-platform-dev mailing list
jakartaee-platform-dev@xxxxxxxxxxxTo unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakartaee-platform-dev
