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 2024/10/10 19:59:48 UTC
(tomcat) 03/06: Update Javadoc references to use Java 21
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
commit 9c6304ad789c5c4b6063d60c591f79aaf5d3c722
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Oct 10 12:53:22 2024 -0600
Update Javadoc references to use Java 21
---
java/org/apache/tomcat/util/digester/package.html | 2 +-
java/org/apache/tomcat/util/net/SocketProperties.java | 6 +++---
java/org/apache/tomcat/util/net/openssl/OpenSSLEngine.java | 2 +-
java/org/apache/tomcat/util/net/openssl/panama/OpenSSLEngine.java | 2 +-
modules/jdbc-pool/build.xml | 2 +-
modules/jdbc-pool/doc/jdbc-pool.xml | 4 ++--
webapps/docs/config/ajp.xml | 6 +++---
webapps/docs/config/cluster-sender.xml | 2 +-
webapps/docs/config/context.xml | 4 ++--
webapps/docs/config/http.xml | 6 +++---
webapps/docs/config/http2.xml | 2 +-
webapps/docs/config/realm.xml | 2 +-
webapps/docs/jndi-datasource-examples-howto.xml | 2 +-
webapps/docs/logging.xml | 2 +-
14 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/java/org/apache/tomcat/util/digester/package.html b/java/org/apache/tomcat/util/digester/package.html
index 7a66d0dbc2..d61d2d61e2 100644
--- a/java/org/apache/tomcat/util/digester/package.html
+++ b/java/org/apache/tomcat/util/digester/package.html
@@ -867,7 +867,7 @@ There are many good regex libraries available. (For example
<a href='https://jakarta.apache.org/oro/index.html'>Jakarta ORO</a>,
<a href='https://jakarta.apache.org/regexp/index.html'>Jakarta Regex</a>,
<a href='http://www.cacas.org/java/gnu/regexp/'>GNU Regex</a> and
-<a href='https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/package-summary.html'>
+<a href='https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/regex/package-summary.html'>
Java Regex</a>)
Not only do different people have different personal tastes when it comes to
regular expression matching but these products all offer different functionality
diff --git a/java/org/apache/tomcat/util/net/SocketProperties.java b/java/org/apache/tomcat/util/net/SocketProperties.java
index a7c193f3b7..433902f048 100644
--- a/java/org/apache/tomcat/util/net/SocketProperties.java
+++ b/java/org/apache/tomcat/util/net/SocketProperties.java
@@ -152,7 +152,7 @@ public class SocketProperties {
/**
* Performance preferences according to
- * https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
+ * https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
* All three performance attributes must be set or the JVM defaults will be
* used.
*/
@@ -160,7 +160,7 @@ public class SocketProperties {
/**
* Performance preferences according to
- * https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
+ * https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
* All three performance attributes must be set or the JVM defaults will be
* used.
*/
@@ -168,7 +168,7 @@ public class SocketProperties {
/**
* Performance preferences according to
- * https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
+ * https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)
* All three performance attributes must be set or the JVM defaults will be
* used.
*/
diff --git a/java/org/apache/tomcat/util/net/openssl/OpenSSLEngine.java b/java/org/apache/tomcat/util/net/openssl/OpenSSLEngine.java
index 890d473374..0087c0b6ea 100644
--- a/java/org/apache/tomcat/util/net/openssl/OpenSSLEngine.java
+++ b/java/org/apache/tomcat/util/net/openssl/OpenSSLEngine.java
@@ -146,7 +146,7 @@ public final class OpenSSLEngine extends SSLEngine implements SSLUtil.ProtocolIn
private volatile boolean destroyed;
// Use an invalid cipherSuite until the handshake is completed
- // See https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLEngine.html#getSession()
+ // See https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/net/ssl/SSLEngine.html#getSession()
private volatile String version;
private volatile String cipher;
private volatile String applicationProtocol;
diff --git a/java/org/apache/tomcat/util/net/openssl/panama/OpenSSLEngine.java b/java/org/apache/tomcat/util/net/openssl/panama/OpenSSLEngine.java
index a528df7676..5a349ba22a 100644
--- a/java/org/apache/tomcat/util/net/openssl/panama/OpenSSLEngine.java
+++ b/java/org/apache/tomcat/util/net/openssl/panama/OpenSSLEngine.java
@@ -131,7 +131,7 @@ public final class OpenSSLEngine extends SSLEngine implements SSLUtil.ProtocolIn
private volatile boolean destroyed;
// Use an invalid cipherSuite until the handshake is completed
- // See https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLEngine.html#getSession()
+ // See https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/net/ssl/SSLEngine.html#getSession()
private volatile String version;
private volatile String cipher;
private volatile String applicationProtocol;
diff --git a/modules/jdbc-pool/build.xml b/modules/jdbc-pool/build.xml
index 86fab9bc1e..d4524f7950 100644
--- a/modules/jdbc-pool/build.xml
+++ b/modules/jdbc-pool/build.xml
@@ -145,7 +145,7 @@
additionalparam="-breakiterator -notimestamp"
verbose="false">
<classpath refid="tomcat.jdbc.classpath"/>
- <link href="https://docs.oracle.com/en/java/javase/17/docs/api/"/>
+ <link href="https://docs.oracle.com/en/java/javase/21/docs/api/"/>
<sourcepath location="${basedir}/src/main/java"/>
</javadoc>
<!-- connection pool API file-->
diff --git a/modules/jdbc-pool/doc/jdbc-pool.xml b/modules/jdbc-pool/doc/jdbc-pool.xml
index e893d7af4f..5de19e8075 100644
--- a/modules/jdbc-pool/doc/jdbc-pool.xml
+++ b/modules/jdbc-pool/doc/jdbc-pool.xml
@@ -510,13 +510,13 @@
</attribute>
<attribute name="alternateUsernameAllowed" required="false">
<p>(boolean) By default, the jdbc-pool will ignore the
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)"><code>DataSource.getConnection(username,password)</code></a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)"><code>DataSource.getConnection(username,password)</code></a>
call, and simply return a previously pooled connection under the globally configured properties <code>username</code> and <code>password</code>, for performance reasons.
</p>
<p>
The pool can however be configured to allow use of different credentials
each time a connection is requested. To enable the functionality described in the
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)"><code>DataSource.getConnection(username,password)</code></a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)"><code>DataSource.getConnection(username,password)</code></a>
call, simply set the property <code>alternateUsernameAllowed</code>
to <code>true</code>.<br />
Should you request a connection with the credentials user1/password1 and the connection
diff --git a/webapps/docs/config/ajp.xml b/webapps/docs/config/ajp.xml
index 605ac3bf98..dd60a247cf 100644
--- a/webapps/docs/config/ajp.xml
+++ b/webapps/docs/config/ajp.xml
@@ -630,19 +630,19 @@
</attribute>
<attribute name="socket.performanceConnectionTime" required="false">
<p>(int)The first value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
<attribute name="socket.performanceLatency" required="false">
<p>(int)The second value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
<attribute name="socket.performanceBandwidth" required="false">
<p>(int)The third value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
diff --git a/webapps/docs/config/cluster-sender.xml b/webapps/docs/config/cluster-sender.xml
index 9f246bbf0a..a0d26f014d 100644
--- a/webapps/docs/config/cluster-sender.xml
+++ b/webapps/docs/config/cluster-sender.xml
@@ -142,7 +142,7 @@
<attribute name="soTrafficClass" required="false">
Sets the traffic class level for the socket, the value is between 0 and 255.
Default value is <code>int soTrafficClass = 0x04 | 0x08 | 0x010;</code>
- Different values are defined in <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setTrafficClass(int)">
+ Different values are defined in <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setTrafficClass(int)">
java.net.Socket#setTrafficClass(int)</a>.
</attribute>
<attribute name="tcpNoDelay" required="false">
diff --git a/webapps/docs/config/context.xml b/webapps/docs/config/context.xml
index 0c9b61433a..9e59e39bb9 100644
--- a/webapps/docs/config/context.xml
+++ b/webapps/docs/config/context.xml
@@ -1364,8 +1364,8 @@
two additional attributes to allow a shared data source to be used with different credentials.
When these two additional attributes are used in combination with the <code>javax.sql.DataSource</code>
type, different contexts can share a global data source with different credentials.
- Under the hood, what happens is that a call to <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html#getConnection())"><code>getConnection()</code></a>
- is simply translated to a call <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)">
+ Under the hood, what happens is that a call to <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/javax/sql/DataSource.html#getConnection())"><code>getConnection()</code></a>
+ is simply translated to a call <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/javax/sql/DataSource.html#getConnection(java.lang.String,java.lang.String)">
<code>getConnection(username, password)</code></a> on the global data source. This is an easy way to get code to be transparent to what schemas are being used,
yet be able to control connections (or pools) in the global configuration.
</p>
diff --git a/webapps/docs/config/http.xml b/webapps/docs/config/http.xml
index 50cbc621d2..6088715bcb 100644
--- a/webapps/docs/config/http.xml
+++ b/webapps/docs/config/http.xml
@@ -792,19 +792,19 @@
</attribute>
<attribute name="socket.performanceConnectionTime" required="false">
<p>(int)The first value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
<attribute name="socket.performanceLatency" required="false">
<p>(int)The second value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
<attribute name="socket.performanceBandwidth" required="false">
<p>(int)The third value for the performance settings. See
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/Socket.html#setPerformancePreferences(int,int,int)">Socket Performance Options</a>.
All three performance attributes must be set else the JVM defaults will
be used for all three.</p>
</attribute>
diff --git a/webapps/docs/config/http2.xml b/webapps/docs/config/http2.xml
index 49592bc9e1..079ad57f51 100644
--- a/webapps/docs/config/http2.xml
+++ b/webapps/docs/config/http2.xml
@@ -215,7 +215,7 @@
<strong>useAsyncIO</strong> attribute of the associated
<strong>Connector</strong> is set to <code>false</code>.</p>
<p>The HTTP/2 sendfile capability uses <a
- href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/MappedByteBuffer.html"
+ href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/MappedByteBuffer.html"
>MappedByteBuffer</a> which is known to cause file locking on Windows.</p>
</attribute>
diff --git a/webapps/docs/config/realm.xml b/webapps/docs/config/realm.xml
index 2d559008eb..2bf9bb12e2 100644
--- a/webapps/docs/config/realm.xml
+++ b/webapps/docs/config/realm.xml
@@ -470,7 +470,7 @@
connection. This attribute should be a comma-separated list of values
selected from <code>auth-conf</code>, <code>auth-int</code> and
<code>auth</code>. See <a
- href="https://docs.oracle.com/en/java/javase/17/docs/api/java.security.sasl/javax/security/sasl/Sasl.html#QOP"
+ href="https://docs.oracle.com/en/java/javase/21/docs/api/java.security.sasl/javax/security/sasl/Sasl.html#QOP"
rel="nofollow">Java documentation</a> for more details.</p>
<p>The default value is <code>auth-conf</code>.</p>
</attribute>
diff --git a/webapps/docs/jndi-datasource-examples-howto.xml b/webapps/docs/jndi-datasource-examples-howto.xml
index 024c338ead..13ff2b2ce1 100644
--- a/webapps/docs/jndi-datasource-examples-howto.xml
+++ b/webapps/docs/jndi-datasource-examples-howto.xml
@@ -72,7 +72,7 @@ the section about Automatic Application Deployment in the latter reference.
<section name="DriverManager, the service provider mechanism and memory leaks">
<p><code>java.sql.DriverManager</code> supports the
-<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/DriverManager.html">service
+<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/DriverManager.html">service
provider</a> mechanism. This feature is that all the available JDBC drivers
that announce themselves by providing a <code>META-INF/services/java.sql.Driver</code>
file are automatically discovered, loaded and registered,
diff --git a/webapps/docs/logging.xml b/webapps/docs/logging.xml
index 2e9ec308e7..91b3a7777f 100644
--- a/webapps/docs/logging.xml
+++ b/webapps/docs/logging.xml
@@ -401,7 +401,7 @@ java.util.logging.ConsoleHandler.encoding = UTF-8]]></source>
package.
</li>
<li>Oracle Java 11 Javadoc for the
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.logging/java/util/logging/package-summary.html"><code>java.util.logging</code></a>
+ <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.logging/java/util/logging/package-summary.html"><code>java.util.logging</code></a>
package.
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org