Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

accessor method to obtain EntityManager #248

Merged
merged 1 commit into from
Sep 7, 2023

Conversation

njr-11
Copy link
Contributor

@njr-11 njr-11 commented Sep 6, 2023

Write up the approach for obtaining the EntityManager/DataSource/Connection that was discussed and decided upon during the Jakarta Data call.
fixes #202

@njr-11 njr-11 added the design Improvements or additions to design label Sep 6, 2023
@njr-11 njr-11 added this to the Jakarta Data 1.0 milestone Sep 6, 2023
@otaviojava
Copy link
Contributor

Way better, thank you.
I loved this approach.

@njr-11 njr-11 merged commit 2065731 into jakartaee:main Sep 7, 2023
2 checks passed
@keilw
Copy link
Member

keilw commented Sep 11, 2023

@njr-11 @otaviojava Why did that PR merge all sorts of HTML code into the module-info?
Was there a mix-up between files? I don't see how all of those aspects are relevant for the module-info/JPMS.

@njr-11
Copy link
Contributor Author

njr-11 commented Sep 11, 2023

@njr-11 @otaviojava Why did that PR merge all sorts of HTML code into the module-info? Was there a mix-up between files? I don't see how all of those aspects are relevant for the module-info/JPMS.

This information is included there as the main entry point for JavaDoc that developers will refer to when using Jakarta Data. Note that if you go to the Jakarta EE page for the Jakarta Data spec, https://jakarta.ee/specifications/data/1.0/
and then scroll to the section where it links to the JavaDoc, "Jakarta Data 1.0 Specification Javadoc", this link, https://jakarta.ee/specifications/data/1.0/apidocs, goes directly to the page that is created by module-info. At least this is how it works by default. Let us know if there is some other convention/approach for Jakarta specs to have a different JavaDoc page be the entry point. The information here is extremely important for developers as their primary reference and entry point for using Jakarta Data. Typical users never read the spec document (although the spec document is very useful for Jakarta Data providers and very advanced users). Most users will rely on JavaDoc alone.

@keilw
Copy link
Member

keilw commented Sep 12, 2023

Ok, so that's a bit like the one for JShell: https://docs.oracle.com/javase/9/docs/api/jdk.jshell-summary.html

Btw, I think the "api" in the module name should not be included, All others I checked including REST or Persistence don't include it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Improvements or additions to design
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Obtaining the EntityManager (or NoSQL equivalents) for a repository
3 participants