You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2022/02/11 10:22:25 UTC

[tomcat] branch 10.0.x updated (c7b3502 -> 7ca1b25)

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

markt pushed a change to branch 10.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git.


    from c7b3502  Remove accidental add
     new 559a3b0  Revert "Cherry-pick DBCP2 Javadoc fix"
     new 7ca1b25  Suppress Javadoc warnings

The 2 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:
 .../apache/tomcat/dbcp/dbcp2/BasicDataSource.java  |  7 --
 .../apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java | 84 ++--------------------
 webapps/docs/changelog.xml                         |  5 ++
 3 files changed, 12 insertions(+), 84 deletions(-)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[tomcat] 02/02: Suppress Javadoc warnings

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

markt pushed a commit to branch 10.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit 7ca1b250136d0fdae15965f09538fde96859568b
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Feb 11 10:15:31 2022 +0000

    Suppress Javadoc warnings
    
    The MXBean has to use the deprecated methods as the replacement methods
    use Duration which isn't a valid type for use in an MXBean
---
 java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java b/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
index 7315c58..f6dbef1 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
@@ -142,6 +142,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getMaxConnLifetimeMillis()}.
      */
+    @SuppressWarnings("javadoc")
     long getMaxConnLifetimeMillis();
 
     /**
@@ -170,6 +171,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getMaxWaitMillis()}.
      */
+    @SuppressWarnings("javadoc")
     long getMaxWaitMillis();
 
     /**
@@ -177,6 +179,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getMinEvictableIdleTimeMillis()}.
      */
+    @SuppressWarnings("javadoc")
     long getMinEvictableIdleTimeMillis();
 
     /**
@@ -226,6 +229,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getRemoveAbandonedTimeout()}.
      */
+    @SuppressWarnings("javadoc")
     int getRemoveAbandonedTimeout();
 
     /**
@@ -233,6 +237,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getSoftMinEvictableIdleTimeMillis()}.
      */
+    @SuppressWarnings("javadoc")
     long getSoftMinEvictableIdleTimeMillis();
 
     /**
@@ -261,6 +266,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getTimeBetweenEvictionRunsMillis()}.
      */
+    @SuppressWarnings("javadoc")
     long getTimeBetweenEvictionRunsMillis();
 
     /**
@@ -289,6 +295,7 @@ public interface DataSourceMXBean {
      *
      * @return {@link BasicDataSource#getValidationQueryTimeout()}.
      */
+    @SuppressWarnings("javadoc")
     int getValidationQueryTimeout();
 
     /**

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


[tomcat] 01/02: Revert "Cherry-pick DBCP2 Javadoc fix"

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

markt pushed a commit to branch 10.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit 559a3b0d7e4d7de741691359fab546e03c710cd0
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Feb 11 10:10:27 2022 +0000

    Revert "Cherry-pick DBCP2 Javadoc fix"
    
    This reverts commit 0a9afdfa6a481b29a954a67cf6ea352043201ed0.
---
 .../apache/tomcat/dbcp/dbcp2/BasicDataSource.java  |  7 --
 .../apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java | 77 ----------------------
 webapps/docs/changelog.xml                         |  5 ++
 3 files changed, 5 insertions(+), 84 deletions(-)

diff --git a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
index b0562e8..f260a53 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/BasicDataSource.java
@@ -1063,7 +1063,6 @@ 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;
     }
@@ -1123,7 +1122,6 @@ public class BasicDataSource implements DataSource, BasicDataSourceMXBean, MBean
      * @return the maxWaitDuration property value.
      * @since 2.10.0
      */
-    @Override
     public synchronized Duration getMaxWaitDuration() {
         return this.maxWaitDuration;
     }
@@ -1148,7 +1146,6 @@ public class BasicDataSource implements DataSource, BasicDataSourceMXBean, MBean
      * @see #setMinEvictableIdle(Duration)
      * @since 2.10.0
      */
-    @Override
     public synchronized Duration getMinEvictableIdleDuration() {
         return this.minEvictableIdleDuration;
     }
@@ -1326,7 +1323,6 @@ 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();
     }
@@ -1356,7 +1352,6 @@ 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;
     }
@@ -1433,7 +1428,6 @@ public class BasicDataSource implements DataSource, BasicDataSourceMXBean, MBean
      * @see #setDurationBetweenEvictionRuns(Duration)
      * @since 2.10.0
      */
-    @Override
     public synchronized Duration getDurationBetweenEvictionRuns() {
         return this.durationBetweenEvictionRuns;
     }
@@ -1487,7 +1481,6 @@ 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 a6d522b..7315c58 100644
--- a/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
+++ b/java/org/apache/tomcat/dbcp/dbcp2/DataSourceMXBean.java
@@ -17,7 +17,6 @@
 package org.apache.tomcat.dbcp.dbcp2;
 
 import java.sql.SQLException;
-import java.time.Duration;
 
 /**
  * Defines the methods that will be made available via
@@ -139,21 +138,10 @@ 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();
 
     /**
@@ -178,39 +166,17 @@ 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();
 
     /**
@@ -256,39 +222,17 @@ 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();
 
     /**
@@ -313,20 +257,10 @@ 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();
 
     /**
@@ -351,21 +285,10 @@ 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();
 
     /**
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 57f3593..0393544 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -213,6 +213,11 @@
       <update>
         Update the OWB module to Apache OpenWebBeans 2.0.26. (remm)
       </update>
+      <fix>
+        Revert the cherry-pick of JavaDoc fix from DBCP applied in 10.0.15
+        that broke the <code>DataSourceMXBean</code> by using a type that isn't
+        supported by MXBeans. (markt) 
+      </fix>
     </changelog>
   </subsection>
 </section>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org