Skip to content

Commit

Permalink
Jakarta Data 1.0 (#737)
Browse files Browse the repository at this point in the history
* Initial upload for Jakarta Data 1.0.0 release review

* Updates to documentation

* review comments
  • Loading branch information
KyleAure authored Jun 6, 2024
1 parent f5bb50e commit b74bd45
Show file tree
Hide file tree
Showing 129 changed files with 3,629 additions and 3,781 deletions.
50 changes: 36 additions & 14 deletions data/1.0/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Jakarta Data 1.0 (under development)"
date: 2023-05-30
summary: "Release supporting Jakarta EE 11"
title: "Jakarta Data 1.0"
date: 2024-05-03
summary: "Release for Jakarta EE 11"
---

The Jakarta Data specification provides an API for easier data access. A Java developer can split the persistence from the model with several features, such as the ability to compose custom query methods on a Repository interface.
Expand Down Expand Up @@ -34,24 +34,43 @@ garage.save(ferrari);

### New features, enhancements or additions

* The CrudRepository feature
* Allows pagination on repository with PageableRepository
* Define the Repository pattern
* Allows pagination on Repository
* Enhance type safety with a StaticMetamodel
* Define platform integrations with CDI, Persistence, NoSQL, Transactions, and Validation
* Produce a TCK with the ability to run against the following matrix:
* Profiles: none (standalone), core, web, platform
* Entities: persistence, nosql

### Removals, deprecations or backwards incompatible changes
None - first release

### Minimum Java SE Version
<!-- Specify the minimum required Java SE version for this specification -->
**Java SE 17 or higher**


* **Java SE 17 or higher**

# Details

* [Jakarta Data 1.0 Release Record](https://projects.eclipse.org/projects/ee4j.data/releases/1.0)
* [Jakarta Data 1.0 Specification Document](./data-1.0.0-RC1.pdf) (PDF)
* [Jakarta Data 1.0 Specification Document](./data-1.0.0-RC1.html) (HTML)
* [Jakarta Data 1.0 Specification Javadoc](./apidocs)
* [Jakarta Data 1.0 Release Plan](https://projects.eclipse.org/projects/ee4j.data/releases/1.0/plan)
* [Jakarta EE Platform 11 Release Plan](https://projects.eclipse.org/projects/ee4j.jakartaee-platform/releases/11/plan)
* [Jakarta Data 1.0 Specification Document](./jakarta-data-1.0.pdf) (PDF)
* [Jakarta Data 1.0 Specification Addendum](./jakarta-data-addendum-1.0.pdf) (PDF)
* [Jakarta Data 1.0 Specification Document](./jakarta-data-1.0.html) (HTML)
* [Jakarta Data 1.0 Specification Addendum](./jakarta-data-addendum-1.0.html) (HTML)
* [Jakarta Data 1.0 Javadoc](./apidocs)
* [Jakarta Data 1.0 TCK](https://download.eclipse.org/jakartaee/data/1.0/data-tck-1.0.0.zip), ([sig](https://download.eclipse.org/jakartaee/data/1.0/data-tck-1.0.0.zip.sig), [sha](https://download.eclipse.org/jakartaee/data/1.0/data-tck-1.0.0.zip.sha256), [pub](https://raw.githubusercontent.com/jakartaee/specification-committee/master/jakartaee-spec-committee.pub))
* Signature tests are included with the TCK and run automatically as part of it
* Maven coordinates
* [jakarta-data-api:jakarta.data:jar:1.0.0-RC1](https://repo1.maven.org/maven2/jakarta/data/jakarta.data-api/1.0.0-RC1/)
* [jakarta-data-api:jakarta.data:jar:1.0.0](https://repo1.maven.org/maven2/jakarta/data/jakarta.data-api/1.0.0/)
* Compatible Implementation used for [ratification](https://www.eclipse.org/projects/efsp/?version=1.2#efsp-ratification)
* Persistence (Hibernate): https://github.com/jakartaee/data/issues/714
* Persistence (Open Liberty): https://github.com/jakartaee/data/issues/741
<!-- TODO add NoSQL once they have submitted a CCR -->

# Compatible Implementations

* [Hibername](https://hibernate.org/orm/releases/6.6/)
* [Open Liberty](https://public.dhe.ibm.com/ibmdl/export/pub/software/openliberty/runtime/tck/2024-05-06_1951/openliberty-24.0.0.6-beta.zip)

# Ballots

Expand All @@ -70,8 +89,11 @@ The Specification Committee Ballot concluded successfully on 2023-04-03 with the
| Marcelo Ancelmo, Abraham Marin-Perez | Participant Members | +1 |
| Werner Keil | Committer Members | +1 |
| Zhai Luchao | Enterprise Members | +1 |
| Scott Stark, Scott Marlow | Enterprise Members | no vote |
| Scott Stark, Scott Marlow | Enterprise Members | no vote |
| | **Total** | **8** |

The ballot was run in the [jakarta.ee-spec mailing list](https://www.eclipse.org/lists/jakarta.ee-spec/msg02857.html)

## Release Review

TBD
107 changes: 56 additions & 51 deletions data/1.0/apidocs/allclasses-index.html

Large diffs are not rendered by default.

17 changes: 9 additions & 8 deletions data/1.0/apidocs/allpackages-index.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>All Packages (Jakarta Data API 1.0.0-RC1 API)</title>
<!-- Generated by javadoc (17) -->
<title>All Packages (Jakarta Data API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
Expand All @@ -23,8 +24,9 @@
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta Data API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.data/module-summary.html">Module</a></li>
<li>Package</li>
Expand All @@ -36,10 +38,9 @@
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
Expand Down Expand Up @@ -85,7 +86,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:data-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2024 Eclipse Foundation. All rights reserved.<br> Use is subject to <a href="./doc-files/speclicense.html" target="_top">license terms</a>.</small></p>
</footer>
</div>
</div>
Expand Down
25 changes: 13 additions & 12 deletions data/1.0/apidocs/constant-values.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>Constant Field Values (Jakarta Data API 1.0.0-RC1 API)</title>
<!-- Generated by javadoc (17) -->
<title>Constant Field Values (Jakarta Data API documentation)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
Expand All @@ -23,8 +24,9 @@
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><br>Jakarta Data API v1.0</div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="jakarta.data/module-summary.html">Module</a></li>
<li>Package</li>
Expand All @@ -36,10 +38,9 @@
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></div>
<div class="nav-list-search"><a href="search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
Expand All @@ -49,15 +50,15 @@
<main role="main">
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
</div>
<section class="packages">
<h2 title="Contents">Contents</h2>
<ul class="contents-list">
<ul>
<li><a href="#jakarta.data">jakarta.data.*</a></li>
</ul>
</section>
<section class="constants-summary" id="jakarta.data">
<h2 title="jakarta.data.*">jakarta.data.*</h2>
</div>
<section class="constants-summary" id="jakarta.data.repository">
<h2 title="jakarta.data">jakarta.data.*</h2>
<ul class="block-list">
<li>
<div class="caption"><span>jakarta.data.repository.<a href="jakarta.data/jakarta/data/repository/By.html" title="annotation interface in jakarta.data.repository">By</a></span></div>
Expand Down Expand Up @@ -89,7 +90,7 @@ <h2 title="jakarta.data.*">jakarta.data.*</h2>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2020 <a href="https://www.eclipse.org">Eclipse Foundation</a>. All rights reserved.</small></p>
<p class="legal-copy"><small>Comments to: <a href="mailto:data-dev@eclipse.org">[email protected]</a>.<br> Copyright &#169; 2024 Eclipse Foundation. All rights reserved.<br> Use is subject to <a href="./doc-files/speclicense.html" target="_top">license terms</a>.</small></p>
</footer>
</div>
</div>
Expand Down
33 changes: 0 additions & 33 deletions data/1.0/apidocs/copy.svg

This file was deleted.

71 changes: 71 additions & 0 deletions data/1.0/apidocs/doc-files/speclicense.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<html>
<head>
<title>Eclipse Foundation Specification License - v1.1</title>
</head>
<body>
<h1>Eclipse Foundation Specification License - v1.1</h1>
<p>By using and/or copying this document, or the Eclipse Foundation
document from which this statement is linked or incorporated by reference, you (the licensee) agree
that you have read, understood, and will comply with the following
terms and conditions:</p>

<p>Permission to copy, and distribute the contents of this document, or
the Eclipse Foundation document from which this statement is linked, in
any medium for any purpose and without fee or royalty is hereby
granted, provided that you include the following on ALL copies of the
document, or portions thereof, that you use:</p>

<ul>
<li> link or URL to the original Eclipse Foundation document.</li>
<li>All existing copyright notices, or if one does not exist, a notice
(hypertext is preferred, but a textual representation is permitted)
of the form: "Copyright © [$date-of-document]
Eclipse Foundation AISBL &lt;&lt;url to this license&gt;&gt;
"
</li>
</ul>

<p>Inclusion of the full text of this NOTICE must be provided. We
request that authorship attribution be provided in any software,
documents, or other items or products that you create pursuant to the
implementation of the contents of this document, or any portion
thereof.</p>

<p>No right to create modifications or derivatives of Eclipse Foundation
documents is granted pursuant to this license, except anyone may
prepare and distribute derivative works and portions of this document
in software that implements the specification, in supporting materials
accompanying such software, and in documentation of such software,
PROVIDED that all such works include the notice below. HOWEVER, the
publication of derivative works of this document for use as a technical
specification is expressly prohibited.</p>

<p>The notice is:</p>

<p>"Copyright © 2022, 2024 Eclipse Foundation AISBL. This software or
document includes material copied from or derived from Jakarta Data and https://jakarta.ee/specifications/data/1.0/."</p>

<h2>Disclaimers</h2>

<p>THIS DOCUMENT IS PROVIDED "AS IS," AND TO THE EXTENT PERMITTED BY APPLICABLE LAW THE COPYRIGHT
HOLDERS AND THE ECLIPSE FOUNDATION AISBL MAKE NO REPRESENTATIONS OR
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE
SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS
WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR
OTHER RIGHTS.</p>

<p>TO THE EXTENT PERMITTED BY APPLICABLE LAW THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION AISBL WILL NOT BE LIABLE
FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT
OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE
CONTENTS THEREOF.</p>

<p>The name and trademarks of the copyright holders or the Eclipse
Foundation AISBL may NOT be used in advertising or publicity pertaining to
this document or its contents without specific, written prior
permission. Title to copyright in this document will at all times
remain with copyright holders.</p>

</body>
</html>
Loading

0 comments on commit b74bd45

Please sign in to comment.