svn commit: r123227 - /incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java /incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java

[ps...@apache.org]

Author: psteitz
Date: Thu Dec 23 13:34:15 2004
New Revision: 123227

URL: http://svn.apache.org/viewcvs?view=rev&rev=123227
Log:
Changed examples in javadoc to work with XmlConfigurator.
Modified:
   incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java
   incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java

Modified: incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java
Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java?view=diff&rev=123227&p1=incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java&r1=123226&p2=incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java&r2=123227
==============================================================================
--- incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java	(original)
+++ incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/MailSessionFactory.java	Thu Dec 23 13:34:15 2004
@@ -29,24 +29,18 @@
 import javax.naming.spi.ObjectFactory;
 
 /**
- * <p>Factory class that creates a JNDI named JavaMail Session factory,
+ * Factory class that creates a JNDI named JavaMail Session factory,
  * which can be used for managing inbound and outbound electronic mail
  * messages via JavaMail APIs.  All messaging environment properties
  * 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>
- *
- * <p>This factory can be configured in a <code>&lt;DefaultContext&gt;</code>
- * or <code>&lt;Context&gt;</code> element in your <code>conf/server.xml</code>
- * configuration file.  An example of factory configuration is:</p>
+ * factory.
+ * <p>
+ * This factory can be configured using the 
+ * {@link org.apache.naming.config.XmlConfigurator}.
+ *  An example of factory configuration is:</p>
  * <pre>
- * &lt;Resource name="mail/smtp" auth="CONTAINER"
- *           type="javax.mail.Session"/&gt;
- * &lt;ResourceParams name="mail/smtp"&gt;
+ * &lt;resource name="mail/smtp" auth="CONTAINER"
+ *           type="javax.mail.Session"&gt;
  *   &lt;parameter&gt;
  *     &lt;name&gt;factory&lt;/name&gt;
  *     &lt;value&gt;org.apache.naming.factory.MailSessionFactory&lt;/value&gt;
@@ -55,7 +49,7 @@
  *     &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&gt;
  * </pre>
  *
  * @author Craig R. McClanahan

Modified: incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java
Url: http://svn.apache.org/viewcvs/incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java?view=diff&rev=123227&p1=incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java&r1=123226&p2=incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java&r2=123227
==============================================================================
--- incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java	(original)
+++ incubator/directory/naming/trunk/factory/src/java/org/apache/naming/factory/SendMailFactory.java	Thu Dec 23 13:34:15 2004
@@ -36,40 +36,46 @@
  * Factory class that creates a JNDI named javamail MimePartDataSource
  * object which can be used for sending email using SMTP.
  * <p>
- * Can be configured in the DefaultContext or Context scope
- * of your server.xml configuration file.
+ * Can be configured using the {@link org.apache.naming.config.XmlConfigurator}.
  * <p>
  * Example:
  * <p>
  * <pre>
- * &lt;Resource name="mail/send" auth="CONTAINER"
- *           type="javax.mail.internet.MimePartDataSource"/>
- * &lt;ResourceParams name="mail/send">
- *   &lt;parameter>&lt;name>factory&lt;/name>
+ * &lt;resource name="mail/send" auth="CONTAINER"
+ *           type="javax.mail.internet.MimePartDataSource">
+ *   &lt;parameter>
+ *     &lt;name>factory&lt;/name>
  *     &lt;value>org.apache.naming.factory.SendMailFactory&lt;/value>
  *   &lt;/parameter>
- *   &lt;parameter>&lt;name>mail.smtp.host&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.smtp.host&lt;/name>
  *     &lt;value>your.smtp.host&lt;/value>
  *   &lt;/parameter>
- *   &lt;parameter>&lt;name>mail.smtp.user&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.smtp.user&lt;/name>
  *     &lt;value>someuser&lt;/value>
  *   &lt;/parameter>
- *   &lt;parameter>&lt;name>mail.from&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.from&lt;/name>
  *     &lt;value>someuser@some.host&lt;/value>
  *   &lt;/parameter>
- *   &lt;parameter>&lt;name>mail.smtp.sendpartial&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.smtp.sendpartial&lt;/name>
  *     &lt;value>true&lt;/value>
  *   &lt;/parameter>
- *  &lt;parameter>&lt;name>mail.smtp.dsn.notify&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.smtp.dsn.notify&lt;/name>
  *     &lt;value>FAILURE&lt;/value>
  *   &lt;/parameter>
- *   &lt;parameter>&lt;name>mail.smtp.dsn.ret&lt;/name>
+ *   &lt;parameter>
+ *     &lt;name>mail.smtp.dsn.ret&lt;/name>
  *     &lt;value>FULL&lt;/value>
  *   &lt;/parameter>
- * &lt;/ResourceParams>
+ * &lt;/resource>
  * </pre>
  *
- * @author Glenn Nielsen Rich Catlett
+ * @author Glenn Nielsen 
+ * @author Rich Catlett
  */
 
 public class SendMailFactory implements ObjectFactory