add EntityTransaction.setTimeout

see #573
jakartaee · Feb 26, 2024 · 92ef50d · 92ef50d
1 parent a77d9b7
commit 92ef50d
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 6 deletions.
diff --git a/api/src/main/java/jakarta/persistence/EntityTransaction.java b/api/src/main/java/jakarta/persistence/EntityTransaction.java
@@ -11,6 +11,7 @@
  */
 
 // Contributors:
+//     Gavin King      - 3.2
 //     Linda DeMichiel - 2.1
 //     Linda DeMichiel - 2.0
 
@@ -71,4 +72,18 @@ public interface EntityTransaction {
       *         condition is encountered
       */
      boolean isActive();
+
+     /**
+      * Set the transaction timeout, in seconds. This is a hint.
+      * @param timeout the timeout, in seconds, or null to indicate
+      *                that the database server should set the timeout
+      * @since 3.2
+      */
+     void setTimeout(Integer timeout);
+
+     /**
+      * The transaction timeout.
+      * @since 3.2
+      */
+     Integer getTimeout();
 }
diff --git a/api/src/main/java/jakarta/persistence/Query.java b/api/src/main/java/jakarta/persistence/Query.java
@@ -558,8 +558,11 @@ Query setParameter(int position, Date value,
     CacheStoreMode getCacheStoreMode();
 
     /**
-     * Set the query timeout.
-     * @param timeout the timeout, or null to indicate no timeout
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
      * @return the same query instance
      * @since 3.2
      */

diff --git a/api/src/main/java/jakarta/persistence/StoredProcedureQuery.java b/api/src/main/java/jakarta/persistence/StoredProcedureQuery.java
@@ -269,8 +269,11 @@ StoredProcedureQuery setParameter(int position,
     StoredProcedureQuery setCacheStoreMode(CacheStoreMode cacheStoreMode);
 
     /**
-     * Set the query timeout.
-     * @param timeout the timeout, or null to indicate no timeout
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
      * @return the same query instance
      * @since 3.2
      */

diff --git a/api/src/main/java/jakarta/persistence/TypedQuery.java b/api/src/main/java/jakarta/persistence/TypedQuery.java
@@ -346,8 +346,11 @@ TypedQuery<X> setParameter(int position, Date value,
     TypedQuery<X> setCacheStoreMode(CacheStoreMode cacheStoreMode);
 
     /**
-     * Set the query timeout.
-     * @param timeout the timeout, or null to indicate no timeout
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
      * @return the same query instance
      * @since 3.2
      */

diff --git a/spec/src/main/asciidoc/ch03-entity-operations.adoc b/spec/src/main/asciidoc/ch03-entity-operations.adoc
@@ -4907,6 +4907,23 @@ public interface Query {
      */
     CacheStoreMode getCacheStoreMode();
 
+    /**
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
+     * @return the same query instance
+     * @since 3.2
+     */
+    Query setTimeout(Integer timeout);
+
+    /**
+     * The query timeout.
+     * @since 3.2
+     */
+    Integer getTimeout();
+
     /**
      * Return an object of the specified type to allow access to
      * the provider-specific API.  If the provider's query
@@ -5249,6 +5266,16 @@ public interface TypedQuery<X> extends Query {
      */
     TypedQuery<X> setCacheStoreMode(CacheStoreMode cacheStoreMode);
 
+    /**
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
+     * @return the same query instance
+     * @since 3.2
+     */
+    TypedQuery<X> setTimeout(Integer timeout);
 }
 ----
 
@@ -5690,6 +5717,17 @@ public interface StoredProcedureQuery extends Query {
      */
     StoredProcedureQuery setCacheStoreMode(CacheStoreMode cacheStoreMode);
 
+    /**
+     * Set the query timeout, in milliseconds. This is a hint,
+     * and is an alternative to {@linkplain #setHint setting
+     * the hint} {@code jakarta.persistence.query.timeout}.
+     * @param timeout the timeout, in milliseconds, or null to
+     *                indicate no timeout
+     * @return the same query instance
+     * @since 3.2
+     */
+    StoredProcedureQuery setTimeout(Integer timeout);
+
     /**
      * Register a positional parameter.
      * All parameters must be registered.

diff --git a/spec/src/main/asciidoc/ch07-entitymanagers-and-persistence-contexts.adoc b/spec/src/main/asciidoc/ch07-entitymanagers-and-persistence-contexts.adoc
@@ -653,6 +653,20 @@ public interface EntityTransaction {
       *         condition is encountered
       */
      public boolean isActive();
+
+     /**
+      * Set the transaction timeout, in seconds. This is a hint.
+      * @param timeout the timeout, in seconds, or null to indicate
+      *                that the database server should set the timeout
+      * @since 3.2
+      */
+     void setTimeout(Integer timeout);
+
+     /**
+      * The transaction timeout.
+      * @since 3.2
+      */
+     Integer getTimeout();
 }
 ----