You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/06/23 11:20:27 UTC

[commons-pool] branch master updated (b22bcfc -> 1f8c0b7)

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git.


    from b22bcfc  Add BaseObjectPoolConfig.setEvictorShutdownTimeoutDuration(Duration), setEvictorShutdownTimeoutMillis(Duration).
     new b40718e  Deprecate DEFAULT_MAX_WAIT_MILLIS in favor of DEFAULT_MAX_WAIT.
     new c95d94b  Javadoc.
     new 1f8c0b7  Replace deprecated API with current one. Update some tests to use both.

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../commons/pool2/impl/BaseObjectPoolConfig.java   |  6 +++++-
 .../commons/pool2/impl/GenericObjectPool.java      |  4 ++--
 .../pool2/impl/SecurityManagerCallStack.java       |  2 +-
 .../apache/commons/pool2/ObjectPoolIssue326.java   |  2 +-
 .../pool2/impl/TestGenericKeyedObjectPool.java     | 12 ++++++-----
 .../commons/pool2/impl/TestGenericObjectPool.java  | 23 ++++++++++++----------
 .../TestGenericObjectPoolFactoryCreateFailure.java | 10 ++++++----
 7 files changed, 35 insertions(+), 24 deletions(-)

[commons-pool] 03/03: Replace deprecated API with current one. Update some tests to use both.

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git

commit 1f8c0b7f0302be5142d4fffe359fe4515416e857
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Jun 23 07:19:22 2021 -0400

    Replace deprecated API with current one. Update some tests to use both.
---
 .../commons/pool2/impl/BaseObjectPoolConfig.java   |  4 +++-
 .../commons/pool2/impl/GenericObjectPool.java      |  4 ++--
 .../pool2/impl/SecurityManagerCallStack.java       |  2 +-
 .../apache/commons/pool2/ObjectPoolIssue326.java   |  2 +-
 .../pool2/impl/TestGenericKeyedObjectPool.java     | 12 ++++++-----
 .../commons/pool2/impl/TestGenericObjectPool.java  | 23 ++++++++++++----------
 .../TestGenericObjectPoolFactoryCreateFailure.java | 10 ++++++----
 7 files changed, 33 insertions(+), 24 deletions(-)

diff --git a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
index 2346b1f..4f9791b 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
@@ -51,7 +51,7 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
      * The default value for the {@code maxWait} configuration attribute.
      * @see GenericObjectPool#getMaxWaitDuration()
      * @see GenericKeyedObjectPool#getMaxWaitDuration()
-     * @deprecate Use {@link #DEFAULT_MAX_WAIT}.
+     * @deprecated Use {@link #DEFAULT_MAX_WAIT}.
      */
     @Deprecated
     public static final long DEFAULT_MAX_WAIT_MILLIS = -1L;
@@ -762,7 +762,9 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
      *
      * @see GenericObjectPool#getMaxWaitDuration()
      * @see GenericKeyedObjectPool#getMaxWaitDuration()
+     * @deprecated Use {@link #setMaxWaitDuration(Duration)}.
      */
+    @Deprecated
     public void setMaxWaitMillis(final long maxWaitMillis) {
         setMaxWaitDuration(Duration.ofMillis(maxWaitMillis));
     }
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
index 7263577..ca0af35 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -223,14 +223,14 @@ public class GenericObjectPool<T> extends BaseGenericObjectPool<T>
 
     /**
      * Equivalent to <code>{@link #borrowObject(long)
-     * borrowObject}({@link #getMaxWaitMillis()})</code>.
+     * borrowObject}({@link #getMaxWaitDuration()})</code>.
      * <p>
      * {@inheritDoc}
      * </p>
      */
     @Override
     public T borrowObject() throws Exception {
-        return borrowObject(getMaxWaitMillis());
+        return borrowObject(getMaxWaitDuration());
     }
 
     /**
diff --git a/src/main/java/org/apache/commons/pool2/impl/SecurityManagerCallStack.java b/src/main/java/org/apache/commons/pool2/impl/SecurityManagerCallStack.java
index 27af175..8a9ce42 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SecurityManagerCallStack.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SecurityManagerCallStack.java
@@ -26,7 +26,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * CallStack strategy using a {@link SecurityManager}. Obtaining the current call stack is much faster via a
+ * A {@link CallStack} strategy using a {@link SecurityManager}. Obtaining the current call stack is much faster via a
  * SecurityManger, but access to the underlying method may be restricted by the current SecurityManager. In environments
  * where a SecurityManager cannot be created, {@link ThrowableCallStack} should be used instead.
  *
diff --git a/src/test/java/org/apache/commons/pool2/ObjectPoolIssue326.java b/src/test/java/org/apache/commons/pool2/ObjectPoolIssue326.java
index 2ceca46..157faf5 100644
--- a/src/test/java/org/apache/commons/pool2/ObjectPoolIssue326.java
+++ b/src/test/java/org/apache/commons/pool2/ObjectPoolIssue326.java
@@ -115,7 +115,7 @@ public final class ObjectPoolIssue326 {
         poolConfig.setMaxIdlePerKey(-1);
         poolConfig.setLifo(true);
         poolConfig.setFairness(true);
-        poolConfig.setMaxWaitMillis(30 * 1000);
+        poolConfig.setMaxWaitDuration(Duration.ofSeconds(30));
         poolConfig.setMinEvictableIdleTime(Duration.ofMillis(-1));
         poolConfig.setSoftMinEvictableIdleTime(Duration.ofMillis(-1));
         poolConfig.setNumTestsPerEvictionRun(1);
diff --git a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
index 5512c0c..62a1f0a 100644
--- a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
@@ -1155,7 +1155,8 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool {
         // Make constructor arguments all different from defaults
         final int maxTotalPerKey = 1;
         final int minIdle = 2;
-        final long maxWait = 3;
+        final Duration maxWaitDuration = Duration.ofMillis(3);
+        final long maxWaitMillis = maxWaitDuration.toMillis();
         final int maxIdle = 4;
         final int maxTotal = 5;
         final long minEvictableIdleTimeMillis = 6;
@@ -1204,7 +1205,7 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool {
         config.setMaxIdlePerKey(maxIdle);
         config.setMinIdlePerKey(minIdle);
         config.setMaxTotal(maxTotal);
-        config.setMaxWaitMillis(maxWait);
+        config.setMaxWaitDuration(maxWaitDuration);
         config.setMinEvictableIdleTime(Duration.ofMillis(minEvictableIdleTimeMillis));
         config.setNumTestsPerEvictionRun(numTestsPerEvictionRun);
         config.setTestOnBorrow(testOnBorrow);
@@ -1215,7 +1216,8 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool {
         try (GenericKeyedObjectPool<Object, Object> objPool = new GenericKeyedObjectPool<>(dummyFactory, config)) {
             assertEquals(maxTotalPerKey, objPool.getMaxTotalPerKey());
             assertEquals(maxIdle, objPool.getMaxIdlePerKey());
-            assertEquals(maxWait, objPool.getMaxWaitMillis());
+            assertEquals(maxWaitDuration, objPool.getMaxWaitDuration());
+            assertEquals(maxWaitMillis, objPool.getMaxWaitMillis());
             assertEquals(minIdle, objPool.getMinIdlePerKey());
             assertEquals(maxTotal, objPool.getMaxTotal());
             assertEquals(minEvictableIdleTimeMillis, objPool.getMinEvictableIdleTimeMillis());
@@ -1573,7 +1575,7 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool {
         try {
             gkoPool.evict();
             fail("Expecting RuntimeException");
-        } catch (RuntimeException e) {
+        } catch (final RuntimeException e) {
             // expected
         }
         assertEquals(0, gkoPool.getNumActive());
@@ -1646,7 +1648,7 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool {
         config.setMaxTotal(2);
         config.setBlockWhenExhausted(true);
         config.setMinIdlePerKey(0);
-        config.setMaxWaitMillis(-1);
+        config.setMaxWaitDuration(Duration.ofMillis(-1));
         config.setNumTestsPerEvictionRun(Integer.MAX_VALUE); // always test all idle objects
         config.setTestOnBorrow(true);
         config.setTestOnReturn(false);
diff --git a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
index e5e040e..f95132d 100644
--- a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java
@@ -1252,10 +1252,12 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
 
         // Make constructor arguments all different from defaults
         final int minIdle = 2;
-        final long maxWait = 3;
+        final Duration maxWaitDuration = Duration.ofMillis(3);
+        final long maxWaitMillis = maxWaitDuration.toMillis();
         final int maxIdle = 4;
         final int maxTotal = 5;
-        final long minEvictableIdleTimeMillis = 6;
+        final Duration minEvictableIdleDuration = Duration.ofMillis(6);
+        final long minEvictableIdleMillis = minEvictableIdleDuration.toMillis();
         final int numTestsPerEvictionRun = 7;
         final boolean testOnBorrow = true;
         final boolean testOnReturn = true;
@@ -1295,9 +1297,9 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
         config.setMaxIdle(maxIdle);
         config.setMinIdle(minIdle);
         config.setMaxTotal(maxTotal);
-        config.setMaxWaitMillis(maxWait);
-        config.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
-        assertEquals(minEvictableIdleTimeMillis, config.getMinEvictableIdleTime().toMillis());
+        config.setMaxWaitDuration(maxWaitDuration);
+        config.setMinEvictableIdleTimeMillis(minEvictableIdleMillis);
+        assertEquals(minEvictableIdleMillis, config.getMinEvictableIdleTime().toMillis());
         config.setNumTestsPerEvictionRun(numTestsPerEvictionRun);
         config.setTestOnBorrow(testOnBorrow);
         config.setTestOnReturn(testOnReturn);
@@ -1307,10 +1309,11 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
         config.setBlockWhenExhausted(blockWhenExhausted);
         try (GenericObjectPool<Object> dummyPool = new GenericObjectPool<>(dummyFactory, config)) {
             assertEquals(maxIdle, dummyPool.getMaxIdle());
-            assertEquals(maxWait, dummyPool.getMaxWaitMillis());
+            assertEquals(maxWaitDuration, dummyPool.getMaxWaitDuration());
+            assertEquals(maxWaitMillis, dummyPool.getMaxWaitMillis());
             assertEquals(minIdle, dummyPool.getMinIdle());
             assertEquals(maxTotal, dummyPool.getMaxTotal());
-            assertEquals(minEvictableIdleTimeMillis, dummyPool.getMinEvictableIdleTimeMillis());
+            assertEquals(minEvictableIdleMillis, dummyPool.getMinEvictableIdleTimeMillis());
             assertEquals(numTestsPerEvictionRun, dummyPool.getNumTestsPerEvictionRun());
             assertEquals(Boolean.valueOf(testOnBorrow), Boolean.valueOf(dummyPool.getTestOnBorrow()));
             assertEquals(Boolean.valueOf(testOnReturn), Boolean.valueOf(dummyPool.getTestOnReturn()));
@@ -1718,7 +1721,7 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
         genericObjectPool.setMinEvictableIdleTime(Duration.ZERO);
         genericObjectPool.setTestWhileIdle(true);
 
-        String active = genericObjectPool.borrowObject();
+        final String active = genericObjectPool.borrowObject();
         genericObjectPool.returnObject(active);
 
         simpleFactory.setThrowExceptionOnValidate(true);
@@ -1726,7 +1729,7 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
         try {
             genericObjectPool.evict();
             fail("Expecting RuntimeException");
-        } catch (RuntimeException e) {
+        } catch (final RuntimeException e) {
             // expected
         }
         assertEquals(0, genericObjectPool.getNumActive());
@@ -2613,7 +2616,7 @@ public class TestGenericObjectPool extends TestBaseObjectPool {
         assertConfiguration(expected,genericObjectPool);
         expected.setMaxTotal(2);
         expected.setMaxIdle(3);
-        expected.setMaxWaitMillis(5L);
+        expected.setMaxWaitDuration(Duration.ofMillis(5));
         expected.setMinEvictableIdleTime(Duration.ofMillis(7L));
         expected.setNumTestsPerEvictionRun(9);
         expected.setTestOnCreate(true);
diff --git a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPoolFactoryCreateFailure.java b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPoolFactoryCreateFailure.java
index 3a567ac..dcf02dd 100644
--- a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPoolFactoryCreateFailure.java
+++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPoolFactoryCreateFailure.java
@@ -34,6 +34,8 @@ import org.junit.jupiter.api.Timeout;
  */
 public class TestGenericObjectPoolFactoryCreateFailure {
 
+    private static final Duration NEG_ONE_DURATION = Duration.ofMillis(-1);
+
     private static class SingleObjectFactory extends BasePooledObjectFactory<Object> {
         private final AtomicBoolean created = new AtomicBoolean();
 
@@ -113,11 +115,11 @@ public class TestGenericObjectPoolFactoryCreateFailure {
         config.setTestOnBorrow(true);
         config.setTestOnReturn(true);
         config.setTestWhileIdle(false);
-        config.setTimeBetweenEvictionRuns(Duration.ofMillis(-1));
-        config.setMinEvictableIdleTime(Duration.ofMillis(-1));
-        config.setSoftMinEvictableIdleTime(Duration.ofMillis(-1));
+        config.setTimeBetweenEvictionRuns(NEG_ONE_DURATION);
+        config.setMinEvictableIdleTime(NEG_ONE_DURATION);
+        config.setSoftMinEvictableIdleTime(NEG_ONE_DURATION);
 
-        config.setMaxWaitMillis(-1);
+        config.setMaxWaitDuration(NEG_ONE_DURATION);
         try (GenericObjectPool<Object> pool = new GenericObjectPool<>(factory, config)) {
 
             final AtomicBoolean failed = new AtomicBoolean();

[commons-pool] 01/03: Deprecate DEFAULT_MAX_WAIT_MILLIS in favor of DEFAULT_MAX_WAIT.

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git

commit b40718eb114f66417f5cc049ca0727cdb6150a24
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jun 22 20:39:06 2021 -0400

    Deprecate DEFAULT_MAX_WAIT_MILLIS in favor of DEFAULT_MAX_WAIT.
---
 src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
index 1a45bbc..ce85bc0 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
@@ -51,7 +51,9 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
      * The default value for the {@code maxWait} configuration attribute.
      * @see GenericObjectPool#getMaxWaitDuration()
      * @see GenericKeyedObjectPool#getMaxWaitDuration()
+     * @deprecate Use {@link #DEFAULT_MAX_WAIT}.
      */
+    @Deprecated
     public static final long DEFAULT_MAX_WAIT_MILLIS = -1L;
 
     /**

[commons-pool] 02/03: Javadoc.

Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git

commit c95d94b6f820e25f569f5e54a8a97851f21755e6
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Jun 22 20:41:21 2021 -0400

    Javadoc.
---
 src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
index ce85bc0..2346b1f 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
@@ -682,7 +682,7 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
      *
      * @see GenericObjectPool#getEvictorShutdownTimeoutMillis()
      * @see GenericKeyedObjectPool#getEvictorShutdownTimeoutMillis()
-     * @deprecated Use {@link #setEvictorShutdownTimeoutMillis(Duration)}.
+     * @deprecated Use {@link #setEvictorShutdownTimeoutDuration(Duration)}.
      */
     @Deprecated
     public void setEvictorShutdownTimeoutMillis(final long evictorShutdownTimeoutMillis) {