Skip to content

Commit 3bf530d

Browse files
committed
HHH-13062 - Migrate User Guide links from Java EE 7 to 8
1 parent 2517fbf commit 3bf530d

File tree

14 files changed

+126
-126
lines changed

14 files changed

+126
-126
lines changed

documentation/src/main/asciidoc/userguide/appendices/Annotations.adoc

+93-93
Large diffs are not rendered by default.

documentation/src/main/asciidoc/userguide/chapters/bootstrap/Bootstrap.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,11 @@ include::{sourcedir}/BootstrapTest.java[tags=bootstrap-jpa-compliant-EntityManag
248248
[NOTE]
249249
====
250250
If you don't want to provide a `persistence.xml` configuration file, JPA allows you to provide all the configuration options in a
251-
http://docs.oracle.com/javaee/7/api/javax/persistence/spi/PersistenceUnitInfo.html[`PersistenceUnitInfo`] implementation and call
251+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/spi/PersistenceUnitInfo.html[`PersistenceUnitInfo`] implementation and call
252252
https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/jpa/HibernatePersistenceProvider.html#createContainerEntityManagerFactory-javax.persistence.spi.PersistenceUnitInfo-java.util.Map-[`HibernatePersistenceProvider.html#createContainerEntityManagerFactory`].
253253
====
254254

255-
To inject the default Persistence Context, you can use the http://docs.oracle.com/javaee/7/api/javax/persistence/PersistenceContext.html[`@PersistenceContext`] annotation.
255+
To inject the default Persistence Context, you can use the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PersistenceContext.html[`@PersistenceContext`] annotation.
256256

257257
[[bootstrap-jpa-compliant-PersistenceContext-example]]
258258
.Inject the default `EntityManager`
@@ -264,9 +264,9 @@ include::{sourcedir}/BootstrapTest.java[tags=bootstrap-jpa-compliant-Persistence
264264
====
265265

266266
To inject a specific Persistence Context,
267-
you can use the http://docs.oracle.com/javaee/7/api/javax/persistence/PersistenceContext.html[`@PersistenceContext`] annotation,
267+
you can use the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PersistenceContext.html[`@PersistenceContext`] annotation,
268268
and you can even pass `EntityManager`-specific properties using the
269-
http://docs.oracle.com/javaee/7/api/javax/persistence/PersistenceProperty.html[`@PersistenceProperty`] annotation.
269+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PersistenceProperty.html[`@PersistenceProperty`] annotation.
270270

271271

272272
[[bootstrap-jpa-compliant-PersistenceContext-configurable-example]]

documentation/src/main/asciidoc/userguide/chapters/caching/Caching.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ include::{sourcedir}/SecondLevelCacheTest.java[tags=caching-query-region-store-m
376376

377377
[NOTE]
378378
====
379-
When using http://docs.oracle.com/javaee/7/api/javax/persistence/CacheStoreMode.html#REFRESH[`CacheStoreMode.REFRESH`] or https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/CacheMode.html#REFRESH[`CacheMode.REFRESH`] in conjunction with the region you have defined for the given query,
379+
When using https://javaee.github.io/javaee-spec/javadocs/javax/persistence/CacheStoreMode.html#REFRESH[`CacheStoreMode.REFRESH`] or https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/CacheMode.html#REFRESH[`CacheMode.REFRESH`] in conjunction with the region you have defined for the given query,
380380
Hibernate will selectively force the results cached in that particular region to be refreshed.
381381
382382
This is particularly useful in cases where underlying data may have been updated via a separate process
@@ -393,8 +393,8 @@ include::{sourcedir}/SecondLevelCacheTest.java[tags=caching-query-region-native-
393393

394394
Traditionally, Hibernate defined the https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/CacheMode.html[`CacheMode`] enumeration to describe
395395
the ways of interactions with the cached data.
396-
JPA split cache modes by storage (http://docs.oracle.com/javaee/7/api/javax/persistence/CacheStoreMode.html[`CacheStoreMode`])
397-
and retrieval (http://docs.oracle.com/javaee/7/api/javax/persistence/CacheRetrieveMode.html[`CacheRetrieveMode`]).
396+
JPA split cache modes by storage (https://javaee.github.io/javaee-spec/javadocs/javax/persistence/CacheStoreMode.html[`CacheStoreMode`])
397+
and retrieval (https://javaee.github.io/javaee-spec/javadocs/javax/persistence/CacheRetrieveMode.html[`CacheRetrieveMode`]).
398398

399399
The relationship between Hibernate and JPA cache modes can be seen in the following table:
400400

documentation/src/main/asciidoc/userguide/chapters/domain/collections.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ include::{extrasdir}/collections-customizing-ordered-list-ordinal-persist-exampl
414414
===== Customizing ORDER BY SQL clause
415415

416416
While the JPA
417-
http://docs.oracle.com/javaee/7/api/javax/persistence/OrderBy.html[`@OrderBy`] annotation allows you to specify the entity attributes used for sorting
417+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/OrderBy.html[`@OrderBy`] annotation allows you to specify the entity attributes used for sorting
418418
when fetching the current annotated collection, the Hibernate specific
419419
https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/OrderBy.html[`@OrderBy`] annotation is used to specify a *SQL* clause instead.
420420

@@ -644,7 +644,7 @@ include::{sourcedir}/MapKeyClassTest.java[tags=collections-map-key-class-type-ma
644644
====
645645

646646
If you want to use the `PhoneNumber` interface as a `java.util.Map` key, then you need to supply the
647-
http://docs.oracle.com/javaee/7/api/javax/persistence/MapKeyClass.html[`@MapKeyClass`] annotation as well.
647+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/MapKeyClass.html[`@MapKeyClass`] annotation as well.
648648

649649
[[collections-map-key-class-mapping-example]]
650650
.`@MapKeyClass` mapping example

documentation/src/main/asciidoc/userguide/chapters/domain/embeddables.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ JPA defines the `@AttributeOverride` annotation to handle this scenario.
9595
This way, the mapping conflict is resolved by setting up explicit name-based property-column type mappings.
9696

9797
If an Embeddable type is used multiple times in some entity, you need to use the
98-
http://docs.oracle.com/javaee/7/api/javax/persistence/AttributeOverride.html[`@AttributeOverride`] and
99-
http://docs.oracle.com/javaee/7/api/javax/persistence/AssociationOverride.html[`@AssociationOverride`] annotations
98+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/AttributeOverride.html[`@AttributeOverride`] and
99+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/AssociationOverride.html[`@AssociationOverride`] annotations
100100
to override the default column names defined by the Embeddable.
101101

102102
Considering you have the following `Publisher` embeddable type
@@ -204,13 +204,13 @@ Embeddable types that are used as collection entries, map keys or entity type id
204204

205205
The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/Target.html[`@Target`] annotation is used to specify the implementation class of a given association that is mapped via an interface.
206206
The
207-
http://docs.oracle.com/javaee/7/api/javax/persistence/ManyToOne.html[`@ManyToOne`],
208-
http://docs.oracle.com/javaee/7/api/javax/persistence/OneToOne.html[`@OneToOne`],
209-
http://docs.oracle.com/javaee/7/api/javax/persistence/OneToMany.html[`@OneToMany`], and
210-
http://docs.oracle.com/javaee/7/api/javax/persistence/ManyToMany.html[`@ManyToMany`]
211-
feature a http://docs.oracle.com/javaee/7/api/javax/persistence/ManyToOne.html#targetEntity--[`targetEntity`] attribute to specify the actual class of the entity association when an interface is used for the mapping.
207+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ManyToOne.html[`@ManyToOne`],
208+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/OneToOne.html[`@OneToOne`],
209+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/OneToMany.html[`@OneToMany`], and
210+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ManyToMany.html[`@ManyToMany`]
211+
feature a https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ManyToOne.html#targetEntity--[`targetEntity`] attribute to specify the actual class of the entity association when an interface is used for the mapping.
212212

213-
The http://docs.oracle.com/javaee/7/api/javax/persistence/ElementCollection.html[`@ElementCollection`] association has a http://docs.oracle.com/javaee/7/api/javax/persistence/ElementCollection.html#targetClass--[`targetClass`] attribute for the same purpose.
213+
The https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ElementCollection.html[`@ElementCollection`] association has a https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ElementCollection.html#targetClass--[`targetClass`] attribute for the same purpose.
214214

215215
However, for simple embeddable types, there is no such construct and so you need to use the Hibernate-specific `@Target` annotation instead.
216216

documentation/src/main/asciidoc/userguide/chapters/domain/entity.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,9 @@ Hibernate offers multiple identifier generation strategies, see the <<chapters/d
113113
[[entity-pojo-mapping]]
114114
==== Mapping the entity
115115

116-
The main piece in mapping the entity is the http://docs.oracle.com/javaee/7/api/javax/persistence/Entity.html[`javax.persistence.Entity`] annotation.
116+
The main piece in mapping the entity is the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/Entity.html[`javax.persistence.Entity`] annotation.
117117

118-
The `@Entity` annotation defines just the https://docs.oracle.com/javaee/7/api/javax/persistence/Entity.html#name--[`name`] attribute which is used to give a specific entity name for use in JPQL queries.
118+
The `@Entity` annotation defines just the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/Entity.html#name--[`name`] attribute which is used to give a specific entity name for use in JPQL queries.
119119

120120
By default, if the name attribute the `@Entity` annotation is missing, the unqualified name of the entity class itself will be used as the entity name
121121

documentation/src/main/asciidoc/userguide/chapters/domain/identifiers.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ If no table name is given Hibernate assumes an implicit name of `hibernate_seque
351351
Additionally, because no `javax.persistence.TableGenerator#pkColumnValue` is specified,
352352
Hibernate will use the default segment (`sequence_name='default'`) from the hibernate_sequences table.
353353

354-
However, you can configure the table identifier generator using the http://docs.oracle.com/javaee/7/api/javax/persistence/TableGenerator.html[`@TableGenerator`] annotation.
354+
However, you can configure the table identifier generator using the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/TableGenerator.html[`@TableGenerator`] annotation.
355355

356356
[[identifiers-generators-table-configured-mapping-example]]
357357
.Configured table generator

documentation/src/main/asciidoc/userguide/chapters/events/Events.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ include::{extrasdir}/events-default-listener-update-example.sql[]
247247

248248
If you already registered a default entity listener, but you don't want to apply it to a particular entity,
249249
you can use the
250-
http://docs.oracle.com/javaee/7/api/javax/persistence/ExcludeDefaultListeners.html[`@ExcludeDefaultListeners`] and
251-
http://docs.oracle.com/javaee/7/api/javax/persistence/ExcludeSuperclassListeners.html[`@ExcludeSuperclassListeners`] JPA annotations.
250+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ExcludeDefaultListeners.html[`@ExcludeDefaultListeners`] and
251+
https://javaee.github.io/javaee-spec/javadocs/javax/persistence/ExcludeSuperclassListeners.html[`@ExcludeSuperclassListeners`] JPA annotations.
252252

253253
`@ExcludeDefaultListeners` instructs the current class to ignore the default entity listeners for the current entity
254254
while `@ExcludeSuperclassListeners` is used to ignore the default entity listeners propagated to the `BaseEntity` super-class.

documentation/src/main/asciidoc/userguide/chapters/fetching/Fetching.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ An EntityGraph is the root of a "load plan" and must correspond to an EntityType
221221
==== JPA (key) subgraphs
222222

223223
A sub-graph is used to control the fetching of sub-attributes of the AttributeNode it is applied to.
224-
It is generally defined via the http://docs.oracle.com/javaee/7/api/javax/persistence/NamedSubgraph.html[`@NamedSubgraph`] annotation.
224+
It is generally defined via the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/NamedSubgraph.html[`@NamedSubgraph`] annotation.
225225

226226
If we have a `Project` parent entity which has an `employees` child associations,
227227
and we'd like to fetch the `department` for the `Employee` child association.
@@ -589,7 +589,7 @@ The possible values are given by the `https://docs.jboss.org/hibernate/orm/{majo
589589
`FALSE`:: Eagerly load it.
590590
`EXTRA`:: Prefer extra queries over full collection loading.
591591

592-
The `TRUE` and `FALSE` values are deprecated since you should be using the JPA http://docs.oracle.com/javaee/7/api/javax/persistence/FetchType.html[`FetchType`] attribute of the <<annotations-jpa-elementcollection>>, <<annotations-jpa-onetomany>>, or <<annotations-jpa-manytomany>> collection.
592+
The `TRUE` and `FALSE` values are deprecated since you should be using the JPA https://javaee.github.io/javaee-spec/javadocs/javax/persistence/FetchType.html[`FetchType`] attribute of the <<annotations-jpa-elementcollection>>, <<annotations-jpa-onetomany>>, or <<annotations-jpa-manytomany>> collection.
593593

594594
The `EXTRA` value has no equivalent in the JPA specification, and it's used to avoid loading the entire collection even when the collection is accessed for the first time.
595595
Each element is fetched individually using a secondary query.

documentation/src/main/asciidoc/userguide/chapters/locking/Locking.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ Hibernate always uses the locking mechanism of the database, and never lock obje
312312
=== `LockMode` and `LockModeType`
313313

314314
Long before JPA 1.0, Hibernate already defined various explicit locking strategies through its `LockMode` enumeration.
315-
JPA comes with its own http://docs.oracle.com/javaee/7/api/javax/persistence/LockModeType.html[`LockModeType`] enumeration which defines similar strategies as the Hibernate-native `LockMode`.
315+
JPA comes with its own https://javaee.github.io/javaee-spec/javadocs/javax/persistence/LockModeType.html[`LockModeType`] enumeration which defines similar strategies as the Hibernate-native `LockMode`.
316316

317317
[cols=",,",, options="header"]
318318
|=======================================================================
@@ -351,7 +351,7 @@ This ensures that applications are portable.
351351
JPA 2.0 introduced two query hints:
352352

353353
javax.persistence.lock.timeout:: it gives the number of milliseconds a lock acquisition request will wait before throwing an exception
354-
javax.persistence.lock.scope:: defines the http://docs.oracle.com/javaee/7/api/javax/persistence/PessimisticLockScope.html[_scope_] of the lock acquisition request.
354+
javax.persistence.lock.scope:: defines the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PessimisticLockScope.html[_scope_] of the lock acquisition request.
355355
The scope can either be `NORMAL` (default value) or `EXTENDED`. The `EXTENDED` scope will cause a lock acquisition request to be passed to other owned table structured (e.g. `@Inheritance(strategy=InheritanceType.JOINED)`, `@ElementCollection`)
356356

357357
[[locking-jpa-query-hints-timeout-example]]

documentation/src/main/asciidoc/userguide/chapters/pc/PersistenceContext.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,7 @@ Certain methods of the JPA `EntityManager` or the Hibernate `Session` will not l
12831283

12841284
Rolling back the database transaction does not put your business objects back into the state they were at the start of the transaction. This means that the database state and the business objects will be out of sync. Usually, this is not a problem because exceptions are not recoverable and you will have to start over after rollback anyway.
12851285

1286-
The JPA https://docs.oracle.com/javaee/7/api/javax/persistence/PersistenceException.html[`PersistenceException`] or the
1286+
The JPA https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PersistenceException.html[`PersistenceException`] or the
12871287
https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/HibernateException.html[`HibernateException`] wraps most of the errors that can occur in a Hibernate persistence layer.
12881288

12891289
Both the `PersistenceException` and the `HibernateException` are runtime exceptions because, in our opinion, we should not force the application developer to catch an unrecoverable exception at a low layer. In most systems, unchecked and fatal exceptions are handled in one of the first frames of the method call stack (i.e., in higher layers) and either an error message is presented to the application user or some other appropriate action is taken. Note that Hibernate might also throw other unchecked exceptions that are not a `HibernateException`. These are not recoverable either, and appropriate action should be taken.
@@ -1326,7 +1326,7 @@ SQLGrammarException::
13261326
[NOTE]
13271327
====
13281328
Starting with Hibernate 5.2, the Hibernate `Session` extends the JPA `EntityManager`. For this reason, when a `SessionFactory` is built via Hibernate's native bootstrapping,
1329-
the `HibernateException` or `SQLException` can be wrapped in a JPA https://docs.oracle.com/javaee/7/api/javax/persistence/PersistenceException.html[`PersistenceException`] when thrown
1329+
the `HibernateException` or `SQLException` can be wrapped in a JPA https://javaee.github.io/javaee-spec/javadocs/javax/persistence/PersistenceException.html[`PersistenceException`] when thrown
13301330
by `Session` methods that implement `EntityManager` methods (e.g., https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/Session.html#merge-java.lang.Object-[Session.merge(Object object)],
13311331
https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/Session.html#flush--[Session.flush()]).
13321332

documentation/src/main/asciidoc/userguide/chapters/query/hql/HQL.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ include::{sourcedir}/HQLTest.java[tags=jpql-api-basic-usage-example]
9898
----
9999
====
100100

101-
For complete details, see the `Query` http://docs.oracle.com/javaee/7/api/javax/persistence/Query.html[Javadocs].
101+
For complete details, see the `Query` https://javaee.github.io/javaee-spec/javadocs/javax/persistence/Query.html[Javadocs].
102102
Many of the settings controlling the execution of the query are defined as hints.
103103
JPA defines some standard hints (like timeout in the example), but most are provider specific.
104104
Relying on provider specific hints limits your applications portability to some degree.
@@ -1929,7 +1929,7 @@ include::{extrasdir}/hql-read-only-entities-example.sql[]
19291929

19301930
As you can see, there is no SQL `UPDATE` being executed.
19311931

1932-
You can also pass the read-only hint to named queries using the JPA http://docs.oracle.com/javaee/7/api/javax/persistence/QueryHint.html[`@QueryHint`] annotation.
1932+
You can also pass the read-only hint to named queries using the JPA https://javaee.github.io/javaee-spec/javadocs/javax/persistence/QueryHint.html[`@QueryHint`] annotation.
19331933

19341934
[[jpa-read-only-entities-native-example]]
19351935
.Fetching read-only entities using a named query and the read-only hint

documentation/src/main/asciidoc/userguide/chapters/query/native/Native.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,7 @@ For SQL Server, if you can enable `SET NOCOUNT ON` in your procedure it will pro
840840
=== Using named queries to call stored procedures
841841

842842
Just like with SQL statements, you can also use named queries to call stored procedures.
843-
For this purpose, JPA defines the http://docs.oracle.com/javaee/7/api/javax/persistence/NamedStoredProcedureQuery.html[`@NamedStoredProcedureQuery`] annotation.
843+
For this purpose, JPA defines the https://javaee.github.io/javaee-spec/javadocs/javax/persistence/NamedStoredProcedureQuery.html[`@NamedStoredProcedureQuery`] annotation.
844844

845845
[[sql-sp-ref-cursor-oracle-named-query-example]]
846846
.Oracle `REF_CURSOR` named query stored procedure

documentation/src/main/asciidoc/userguide/chapters/schema/Schema.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ include::{extrasdir}/schema-generation-column-default-value-persist-example.sql[
163163
[[schema-generation-columns-unique-constraint]]
164164
=== Columns unique constraint
165165

166-
The http://docs.oracle.com/javaee/7/api/javax/persistence/UniqueConstraint.html[`@UniqueConstraint`] annotation is used to specify a unique constraint to be included by the automated schema generator for the primary or secondary table associated with the current annotated entity.
166+
The https://javaee.github.io/javaee-spec/javadocs/javax/persistence/UniqueConstraint.html[`@UniqueConstraint`] annotation is used to specify a unique constraint to be included by the automated schema generator for the primary or secondary table associated with the current annotated entity.
167167

168168
Considering the following entity mapping, Hibernate generates the unique constraint DDL when creating the database schema:
169169

@@ -203,7 +203,7 @@ The second INSERT statement fails because of the unique constraint violation.
203203
[[schema-generation-columns-index]]
204204
=== Columns index
205205

206-
The http://docs.oracle.com/javaee/7/api/javax/persistence/Index.html[`@Index`] annotation is used by the automated schema generation tool to create a database index.
206+
The https://javaee.github.io/javaee-spec/javadocs/javax/persistence/Index.html[`@Index`] annotation is used by the automated schema generation tool to create a database index.
207207

208208
Considering the following entity mapping, Hibernate generates the index when creating the database schema:
209209

0 commit comments

Comments
 (0)