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

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


The following commit(s) were added to refs/heads/11.0.x by this push:
     new 887502ce2c Remove references to ResourceParams
887502ce2c is described below

commit 887502ce2caa569037df0687887be192c9bff01e
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Nov 26 12:21:20 2024 +0000

    Remove references to ResourceParams
---
 java/org/apache/naming/factory/BeanFactory.java    | 53 ++++++----------------
 .../apache/naming/factory/MailSessionFactory.java  | 18 ++------
 .../org/apache/naming/factory/SendMailFactory.java | 36 +++++----------
 webapps/docs/changelog.xml                         |  9 ++++
 webapps/docs/jndi-resources-howto.xml              |  4 +-
 5 files changed, 40 insertions(+), 80 deletions(-)

diff --git a/java/org/apache/naming/factory/BeanFactory.java 
b/java/org/apache/naming/factory/BeanFactory.java
index 57f9785c61..d4369b8fee 100644
--- a/java/org/apache/naming/factory/BeanFactory.java
+++ b/java/org/apache/naming/factory/BeanFactory.java
@@ -42,46 +42,19 @@ import org.apache.naming.StringManager;
  * in your <code>conf/server.xml</code>
  * configuration file.  An example of factory configuration is:</p>
  * <pre>
- * &lt;Resource name="jdbc/myDataSource" auth="SERVLET"
- *   type="oracle.jdbc.pool.OracleConnectionCacheImpl"/&gt;
- * &lt;ResourceParams name="jdbc/myDataSource"&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;factory&lt;/name&gt;
- *     &lt;value&gt;org.apache.naming.factory.BeanFactory&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;driverType&lt;/name&gt;
- *     &lt;value&gt;thin&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;serverName&lt;/name&gt;
- *     &lt;value&gt;hue&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;networkProtocol&lt;/name&gt;
- *     &lt;value&gt;tcp&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;databaseName&lt;/name&gt;
- *     &lt;value&gt;XXXX&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;portNumber&lt;/name&gt;
- *     &lt;value&gt;NNNN&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;user&lt;/name&gt;
- *     &lt;value&gt;XXXX&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;password&lt;/name&gt;
- *     &lt;value&gt;XXXX&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;maxLimit&lt;/name&gt;
- *     &lt;value&gt;5&lt;/value&gt;
- *   &lt;/parameter&gt;
- * &lt;/ResourceParams&gt;
+ * &lt;Resource name="jdbc/myDataSource"
+ *           auth="SERVLET"
+ *           type="oracle.jdbc.pool.OracleConnectionCacheImpl"
+ *           factory="org.apache.naming.factory.BeanFactory"
+ *           driverType="thin"
+ *           serverName="hue"
+ *           networkProtocol="tcp"
+ *           databaseName="XXXX"
+ *           portNumber="NNNN"
+ *           user="XXXX"
+ *           password="XXXX"
+ *           maxLimit="5"
+ *           /&gt;
  * </pre>
  *
  * @author Aner Perez [aner at ncstech.com]
diff --git a/java/org/apache/naming/factory/MailSessionFactory.java 
b/java/org/apache/naming/factory/MailSessionFactory.java
index c0c92e03fb..4a1344a712 100644
--- a/java/org/apache/naming/factory/MailSessionFactory.java
+++ b/java/org/apache/naming/factory/MailSessionFactory.java
@@ -37,7 +37,6 @@ import jakarta.mail.Session;
  * described in the JavaMail Specification may be passed to the Session
  * factory; however the following properties are the most commonly used:</p>
  * <ul>
- * <li>
  * <li><strong>mail.smtp.host</strong> - Hostname for outbound transport
  *     connections.  Defaults to <code>localhost</code> if not specified.</li>
  * </ul>
@@ -46,18 +45,11 @@ import jakarta.mail.Session;
  * <code>&lt;Context&gt;</code> element in your <code>conf/server.xml</code>
  * configuration file.  An example of factory configuration is:</p>
  * <pre>
- * &lt;Resource name="mail/smtp" auth="CONTAINER"
- *           type="jakarta.mail.Session"/&gt;
- * &lt;ResourceParams name="mail/smtp"&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;factory&lt;/name&gt;
- *     &lt;value&gt;org.apache.naming.factory.MailSessionFactory&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;
- *     &lt;name&gt;mail.smtp.host&lt;/name&gt;
- *     &lt;value&gt;mail.mycompany.com&lt;/value&gt;
- *   &lt;/parameter&gt;
- * &lt;/ResourceParams&gt;
+ * &lt;Resource name="mail/smtp"
+ *           auth="CONTAINER"
+ *           type="jakarta.mail.Session"
+ *           mail.smtp.host="mail.mycompany.com"
+ *           /&gt;
  * </pre>
  *
  * @author Craig R. McClanahan
diff --git a/java/org/apache/naming/factory/SendMailFactory.java 
b/java/org/apache/naming/factory/SendMailFactory.java
index 9590b1a5c2..e8295f02a7 100644
--- a/java/org/apache/naming/factory/SendMailFactory.java
+++ b/java/org/apache/naming/factory/SendMailFactory.java
@@ -42,31 +42,17 @@ import org.apache.tomcat.util.ExceptionUtils;
  * <p>
  * Example:
  * <pre>
- * &lt;Resource name="mail/send" auth="CONTAINER"
- *           type="jakarta.mail.internet.MimePartDataSource"/&gt;
- * &lt;ResourceParams name="mail/send"&gt;
- *   &lt;parameter&gt;&lt;name&gt;factory&lt;/name&gt;
- *     &lt;value&gt;org.apache.naming.factory.SendMailFactory&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;&lt;name&gt;mail.smtp.host&lt;/name&gt;
- *     &lt;value&gt;your.smtp.host&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;&lt;name&gt;mail.smtp.user&lt;/name&gt;
- *     &lt;value&gt;someuser&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;&lt;name&gt;mail.from&lt;/name&gt;
- *     &lt;value&gt;someu...@some.host&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;&lt;name&gt;mail.smtp.sendpartial&lt;/name&gt;
- *     &lt;value&gt;true&lt;/value&gt;
- *   &lt;/parameter&gt;
- *  &lt;parameter&gt;&lt;name&gt;mail.smtp.dsn.notify&lt;/name&gt;
- *     &lt;value&gt;FAILURE&lt;/value&gt;
- *   &lt;/parameter&gt;
- *   &lt;parameter&gt;&lt;name&gt;mail.smtp.dsn.ret&lt;/name&gt;
- *     &lt;value&gt;FULL&lt;/value&gt;
- *   &lt;/parameter&gt;
- * &lt;/ResourceParams&gt;
+ * &lt;Resource name="mail/send"
+ *           auth="CONTAINER"
+ *           type="jakarta.mail.internet.MimePartDataSource"
+ *           factory="org.apache.naming.factory.SendMailFactory"
+ *           mail.smtp.host="your.smtp.host"
+ *           mail.smtp.user="someuser"
+ *           mail.from="someu...@some.host"
+ *           mail.smtp.sendpartial="true"
+ *           mail.smtp.dsn.notify="FAILURE"
+ *           mail.smtp.dsn.ret="FULL"
+ *           /&gt;
  * </pre>
  *
  * @author Glenn Nielsen Rich Catlett
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 4f71713bac..be3f95e641 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -208,6 +208,15 @@
       </fix>
     </changelog>
   </subsection>
+  <subsection name="Web applications">
+    <changelog>
+      <fix>
+        Documentation. Remove references to the <code>ResourceParams</code>
+        element. Support for <code>ResourceParams</code> was removed in Tomcat
+        5.5.x. (markt)
+      </fix>
+    </changelog>
+  </subsection>
 </section>
 <section name="Tomcat 11.0.1 (markt)" rtext="2024-11-10">
   <subsection name="Catalina">
diff --git a/webapps/docs/jndi-resources-howto.xml 
b/webapps/docs/jndi-resources-howto.xml
index 12b238dddb..e978234a43 100644
--- a/webapps/docs/jndi-resources-howto.xml
+++ b/webapps/docs/jndi-resources-howto.xml
@@ -1108,8 +1108,8 @@ public class MyBeanFactory implements ObjectFactory {
 
   <p>In this example, we are unconditionally creating a new instance of
   the <code>com.mycompany.MyBean</code> class, and populating its properties
-  based on the parameters included in the <code>&lt;ResourceParams&gt;</code>
-  element that configures this factory (see below).  You should note that any
+  based on the parameters included in the <code>&lt;Resource&gt;</code>
+  element that configures this resource (see below).  You should note that any
   parameter named <code>factory</code> should be skipped - that parameter is
   used to specify the name of the factory class itself (in this case,
   <code>com.mycompany.MyBeanFactory</code>) rather than a property of the


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

Reply via email to