This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new 0a9afdf Cherry-pick DBCP2 Javadoc fix
0a9afdf is described below
commit 0a9afdfa6a481b29a954a67cf6ea352043201ed0
Author: Mark Thomas <[email protected]>
AuthorDate: Wed Jan 5 19:12:14 2022 +0000
Cherry-pick DBCP2 Javadoc fix
---
.../apache/tomcat/dbcp/dbcp2/BasicDataSource.java | 7 ++
.../apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java | 77 ++++++++++++++++++++++
2 files changed, 84 insertions(+)
diff --git a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
index f260a53..b0562e8 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
@@ -1063,6 +1063,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* @return the maximum permitted duration of a connection.
* @since 2.10.0
*/
+ @Override
public Duration getMaxConnDuration() {
return maxConnDuration;
}
@@ -1122,6 +1123,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* @return the maxWaitDuration property value.
* @since 2.10.0
*/
+ @Override
public synchronized Duration getMaxWaitDuration() {
return this.maxWaitDuration;
}
@@ -1146,6 +1148,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* @see #setMinEvictableIdle(Duration)
* @since 2.10.0
*/
+ @Override
public synchronized Duration getMinEvictableIdleDuration() {
return this.minEvictableIdleDuration;
}
@@ -1323,6 +1326,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* @return Timeout before an abandoned connection can be removed.
* @since 2.10.0
*/
+ @Override
public Duration getRemoveAbandonedTimeoutDuration() {
return abandonedConfig == null ? Duration.ofSeconds(300) :
abandonedConfig.getRemoveAbandonedTimeoutDuration();
}
@@ -1352,6 +1356,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* there are minIdle idle connections in the pool
* @since 2.10.0
*/
+ @Override
public synchronized Duration getSoftMinEvictableIdleDuration() {
return softMinEvictableIdleDuration;
}
@@ -1428,6 +1433,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
* @see #setDurationBetweenEvictionRuns(Duration)
* @since 2.10.0
*/
+ @Override
public synchronized Duration getDurationBetweenEvictionRuns() {
return this.durationBetweenEvictionRuns;
}
@@ -1481,6 +1487,7 @@ public class BasicDataSource implements DataSource,
BasicDataSourceMXBean, MBean
*
* @return the timeout in seconds before connection validation queries
fail.
*/
+ @Override
public Duration getValidationQueryTimeoutDuration() {
return validationQueryTimeoutDuration;
}
diff --git a/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
b/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
index 7315c58..a6d522b 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
@@ -17,6 +17,7 @@
package org.apache.tomcat.dbcp.dbcp2;
import java.sql.SQLException;
+import java.time.Duration;
/**
* Defines the methods that will be made available via
@@ -138,10 +139,21 @@ public interface DataSourceMXBean {
boolean getLogExpiredConnections();
/**
+ * See {@link BasicDataSource#getMaxConnDuration()}.
+ *
+ * @return {@link BasicDataSource#getMaxConnDuration()}.
+ * @since 2.10.0
+ */
+ Duration getMaxConnDuration();
+
+ /**
* See {@link BasicDataSource#getMaxConnLifetimeMillis()}.
*
* @return {@link BasicDataSource#getMaxConnLifetimeMillis()}.
+ *
+ * @deprecated Use {@link #getMaxConnDuration()}.
*/
+ @Deprecated
long getMaxConnLifetimeMillis();
/**
@@ -166,17 +178,39 @@ public interface DataSourceMXBean {
int getMaxTotal();
/**
+ * See {@link BasicDataSource#getMaxWaitDuration()}.
+ *
+ * @return {@link BasicDataSource#getMaxWaitDuration()}.
+ * @since 2.10.0
+ */
+ Duration getMaxWaitDuration();
+
+ /**
* See {@link BasicDataSource#getMaxWaitMillis()}.
*
* @return {@link BasicDataSource#getMaxWaitMillis()}.
+ *
+ * @deprecated Use {@link #getMaxWaitDuration()}.
*/
+ @Deprecated
long getMaxWaitMillis();
/**
+ * See {@link BasicDataSource#getMinEvictableIdleDuration()}.
+ *
+ * @return {@link BasicDataSource#getMinEvictableIdleDuration()}.
+ * @since 2.10.0
+ */
+ Duration getMinEvictableIdleDuration();
+
+ /**
* See {@link BasicDataSource#getMinEvictableIdleTimeMillis()}.
*
* @return {@link BasicDataSource#getMinEvictableIdleTimeMillis()}.
+ *
+ * @deprecated Use {@link #getMinEvictableIdleDuration()}.
*/
+ @Deprecated
long getMinEvictableIdleTimeMillis();
/**
@@ -222,17 +256,39 @@ public interface DataSourceMXBean {
boolean getRemoveAbandonedOnMaintenance();
/**
+ * See {@link BasicDataSource#getRemoveAbandonedTimeoutDuration()}.
+ *
+ * @return {@link BasicDataSource#getRemoveAbandonedTimeoutDuration()}.
+ * @since 2.10.0
+ */
+ Duration getRemoveAbandonedTimeoutDuration();
+
+ /**
* See {@link BasicDataSource#getRemoveAbandonedTimeout()}.
*
* @return {@link BasicDataSource#getRemoveAbandonedTimeout()}.
+ *
+ * @deprecated Use {@link #getRemoveAbandonedTimeoutDuration()}.
*/
+ @Deprecated
int getRemoveAbandonedTimeout();
/**
+ * See {@link BasicDataSource#getSoftMinEvictableIdleDuration()}.
+ *
+ * @return {@link BasicDataSource#getSoftMinEvictableIdleDuration()}.
+ * @since 2.10.0
+ */
+ Duration getSoftMinEvictableIdleDuration();
+
+ /**
* See {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}.
*
* @return {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}.
+ *
+ * @deprecated Use {@link #getSoftMinEvictableIdleDuration()}.
*/
+ @Deprecated
long getSoftMinEvictableIdleTimeMillis();
/**
@@ -257,10 +313,20 @@ public interface DataSourceMXBean {
boolean getTestWhileIdle();
/**
+ * See {@link BasicDataSource#getDurationBetweenEvictionRuns()}.
+ *
+ * @return {@link BasicDataSource#getDurationBetweenEvictionRuns()}.
+ * @since 2.10.0
+ */
+ Duration getDurationBetweenEvictionRuns();
+
+ /**
* See {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}.
*
* @return {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}.
+ * @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
*/
+ @Deprecated
long getTimeBetweenEvictionRunsMillis();
/**
@@ -285,10 +351,21 @@ public interface DataSourceMXBean {
String getValidationQuery();
/**
+ * See {@link BasicDataSource#getValidationQueryTimeoutDuration()}.
+ *
+ * @return {@link BasicDataSource#getValidationQueryTimeoutDuration()}.
+ * @since 2.10.0
+ */
+ Duration getValidationQueryTimeoutDuration();
+
+ /**
* See {@link BasicDataSource#getValidationQueryTimeout()}.
*
* @return {@link BasicDataSource#getValidationQueryTimeout()}.
+ *
+ * @deprecated Use {@link #getValidationQueryTimeoutDuration()}.
*/
+ @Deprecated
int getValidationQueryTimeout();
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
