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

Editorial updates to changelog, schemas #581

Merged
merged 9 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# Copyright (c) 2022, 2023 Contributors to the Eclipse Foundation
# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v. 2.0 which is available at
Expand Down Expand Up @@ -27,9 +27,9 @@ jobs:

steps:
- name: Checkout for build
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
distribution: 'zulu'
java-version: ${{ matrix.java_version }}
Expand Down
15 changes: 8 additions & 7 deletions api/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2018, 2023 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
Expand Down Expand Up @@ -108,22 +108,22 @@
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.4.0</version>
<version>3.5.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.3.0</version>
<version>3.4.1</version>
</plugin>
<plugin>
<groupId>org.glassfish.build</groupId>
<artifactId>spec-version-maven-plugin</artifactId>
<version>2.1</version>
<version>2.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<version>3.12.1</version>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
Expand All @@ -148,7 +148,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.5.0</version>
<version>3.6.3</version>
</plugin>
<plugin>
<groupId>org.glassfish.copyright</groupId>
Expand Down Expand Up @@ -212,7 +212,8 @@
<configuration>
<rules>
<requireJavaVersion>
<version>[11,)</version>
<version>[21,)</version>
<message>The build requires Java SE 21 or newer</message>
</requireJavaVersion>
</rules>
</configuration>
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/jakarta/persistence/Column.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/jakarta/persistence/MapKeyColumn.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/jakarta/persistence/MapsId.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/jakarta/persistence/Query.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/jakarta/persistence/TypedQuery.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/resources/jakarta/persistence/orm_3_2.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2023, 2024 Oracle and/or its affiliates. All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
Expand Down
10 changes: 5 additions & 5 deletions api/src/main/resources/jakarta/persistence/persistence_3_2.xsd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2008, 2024 Oracle and/or its affiliates. All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
Expand All @@ -18,7 +18,7 @@
xmlns:persistence="https://jakarta.ee/xml/ns/persistence"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
version="3.1">
version="3.2">

<xsd:annotation>
<xsd:documentation><![CDATA[
Expand All @@ -38,8 +38,8 @@
<persistence xmlns="https://jakarta.ee/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence
https://jakarta.ee/xml/ns/persistence/persistence_3_1.xsd"
version="3.1">
https://jakarta.ee/xml/ns/persistence/persistence_3_2.xsd"
version="3.2">
...
</persistence>

Expand Down Expand Up @@ -323,7 +323,7 @@
</xsd:element>
</xsd:sequence>
<xsd:attribute name="version" type="persistence:versionType"
fixed="3.0" use="required"/>
fixed="3.2" use="required"/>
</xsd:complexType>
</xsd:element>

Expand Down
12 changes: 6 additions & 6 deletions spec/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2018, 2023 Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0 which is available at
Expand All @@ -24,13 +24,13 @@
<groupId>jakarta.persistence</groupId>
<artifactId>persistence-spec</artifactId>
<packaging>pom</packaging>
<version>3.3-SNAPSHOT</version>
<version>3.2-SNAPSHOT</version>
<name>Jakarta Persistence Specification</name>

<properties>
<site.output.dir>${project.build.directory}/staging</site.output.dir>
<maven.site.skip>true</maven.site.skip>
<asciidoctor.maven.plugin.version>2.2.4</asciidoctor.maven.plugin.version>
<asciidoctor.maven.plugin.version>2.2.6</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>2.3.9</asciidoctorj.pdf.version>
<spec.name>jakarta-${project.artifactId}-${project.version}</spec.name>
<!-- status: DRAFT, BETA, etc., or blank for final -->
Expand Down Expand Up @@ -60,7 +60,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.3.0</version>
<version>3.4.1</version>
<executions>
<execution>
<id>enforce-versions</id>
Expand All @@ -70,8 +70,8 @@
<configuration>
<rules>
<requireJavaVersion>
<version>[11,)</version>
<message>You need Java SE 11 or newer</message>
<version>[17,)</version>
<message>The build requires Java SE 17 or newer</message>
</requireJavaVersion>
</rules>
</configuration>
Expand Down
18 changes: 14 additions & 4 deletions spec/src/main/asciidoc/appendixes.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (c) 2017, 2023 Contributors to the Eclipse Foundation
// Copyright (c) 2017, 2024 Contributors to the Eclipse Foundation
//

[appendix]
Expand Down Expand Up @@ -67,6 +67,8 @@ Added `runInTransaction()` and `callInTransaction()` to `EntityManagerFactory`

Added `getName()` to `EntityManagerFactory`

Added `setTimeout(Integer)` and `getTimeout()` to `EntityTransaction`

Added programmatic API to obtain `EntityManagerFactory` using `PersistenceConfiguration`

Added constants for properties defined by the specification to the `PersistenceConfiguration`
Expand All @@ -77,7 +79,13 @@ Added options member to elements which result in DDL generation

Added `EnumeratedValue` allowing custom mapping of fields of Java enums

Added `comment` and `check` members to table and column annotations, along with `CheckConstraint`
Added `comment` and `check` members to `@Table` and `@Column` annotations, along with `@CheckConstraint`

Added `secondPrecision` to `@Column` annotation and clarified semantics of `@Column` members

Added factory-level access to named queries and named entity graphs

Added integration points for dependency injection

Made the `name` member of `TableGenerator` and `SequenceGenerator` optional and allow usage of these annotations
at the java package level
Expand All @@ -86,21 +94,23 @@ Clarified the primary key types supported for each `GenerationType`

Clarified availability of `SEQUENCE`, `TABLE` and `UUID` generated IDs on `PrePersist`

Clarified semantics of numeric literals and added support for `bi` and `bd` suffixes
Clarified semantics of numeric literals and numeric type promotions, and added support for `bi` and `bd` suffixes

Clarified semantics of `Convert`/`Converter` annotations

Clarified rules around distinction of entity names and identification variables and case-sensitivity in Jakarta Persistence QL queries

Clarified the semantics of `Bindable.ENTITY_TYPE` in javadoc

Clarified the semantics of collection-valued query parameters

Entity and embeddable classes may now be static inner classes

Primary key classes are no longer required to be public and serializable

Pulled `getParameters()` up from `CriteriaQuery` to `CommonAbstractCriteria`

Updated object/relational mapping schema
Updated persistence and object/relational mapping schemas

Fixed wildcard types in `addSubgraph` and `addAttributeNode` in `Graph`

Expand Down
51 changes: 46 additions & 5 deletions spec/src/main/asciidoc/ch08-entity-packaging.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (c) 2017, 2020 Contributors to the Eclipse Foundation
// Copyright (c) 2017, 2024 Contributors to the Eclipse Foundation
//

== Entity Packaging [[a12229]]
Expand Down Expand Up @@ -781,7 +781,7 @@ This section provides the XML schema for the `persistence.xml` file.
xmlns:persistence="https://jakarta.ee/xml/ns/persistence"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
version="3.0">
version="3.2">

<xsd:annotation>
<xsd:documentation><![CDATA[
Expand All @@ -801,8 +801,8 @@ This section provides the XML schema for the `persistence.xml` file.
<persistence xmlns="https://jakarta.ee/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence
https://jakarta.ee/xml/ns/persistence/persistence_3_0.xsd"
version="3.0">
https://jakarta.ee/xml/ns/persistence/persistence_3_2.xsd"
version="3.2">
...
</persistence>

Expand Down Expand Up @@ -864,6 +864,32 @@ This section provides the XML schema for the `persistence.xml` file.

<!-- **************************************************** -->

<xsd:element name="qualifier" type="xsd:string"
minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>

Qualifier annotation class used for dependency injection.

</xsd:documentation>
</xsd:annotation>
</xsd:element>

<!-- **************************************************** -->

<xsd:element name="scope" type="xsd:string"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>

Scope annotation class used for dependency injection.

</xsd:documentation>
</xsd:annotation>
</xsd:element>

<!-- **************************************************** -->

<xsd:element name="jta-data-source" type="xsd:string"
minOccurs="0">
<xsd:annotation>
Expand Down Expand Up @@ -1014,6 +1040,20 @@ This section provides the XML schema for the `persistence.xml` file.
</xsd:complexType>
</xsd:element>

<xsd:any namespace="##other" processContents="lax">
<xsd:annotation>
<xsd:documentation>
An extension point for integration related configuration, e.g. cdi:
<!--
<persistence-unit name="my-unit" xmlns:cdi="https://jakarta.ee/xml/ns/persistence-cdi">
...
<cdi:scope>com.example.jpa.ACustomScope</cdi:scope>
<cdi:qualifier>com.example.jpa.CustomQualifier</cdi:qualifier>
</persistence-unit>
-->
</xsd:documentation>
</xsd:annotation>
</xsd:any>
</xsd:sequence>

<!-- **************************************************** -->
Expand Down Expand Up @@ -1046,7 +1086,7 @@ This section provides the XML schema for the `persistence.xml` file.
</xsd:element>
</xsd:sequence>
<xsd:attribute name="version" type="persistence:versionType"
fixed="3.0" use="required"/>
fixed="3.2" use="required"/>
</xsd:complexType>
</xsd:element>

Expand Down Expand Up @@ -1103,4 +1143,5 @@ This section provides the XML schema for the `persistence.xml` file.
</xsd:simpleType>

</xsd:schema>

----
4 changes: 2 additions & 2 deletions spec/src/main/asciidoc/ch09-container-provider-contracts.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (c) 2017, 2021 Contributors to the Eclipse Foundation
// Copyright (c) 2017, 2024 Contributors to the Eclipse Foundation
//

== Container and Provider Contracts for Deployment and Bootstrapping
Expand All @@ -20,7 +20,7 @@ discovering the `persistence.xml` files and processing them.
When the container finds a `persistence.xml`
file, it must process the persistence unit definitions that it contains.
The container must validate the `persistence.xml` file against the
`persistence_3_0.xsd` or `persistence_2_2.xsd` schema in accordance with
`persistence_3_2.xsd`, `persistence_3_0.xsd` or `persistence_2_2.xsd` schema in accordance with
the version specified by the `persistence.xml` file and report any validation errors.
Provider or data source information not specified in the `persistence.xml` file
must be provided at deployment time or defaulted by the container. The
Expand Down
Loading