svn commit: rev 30917 - excalibur/trunk/containerkit/logger/src/java/org/apache/avalon/excalibur/logger/factory

[le...@apache.org]

Author: leif
Date: Thu Jul 29 03:39:19 2004
New Revision: 30917

Modified:
   excalibur/trunk/containerkit/logger/src/java/org/apache/avalon/excalibur/logger/factory/SMTPTargetFactory.java
Log:
Add some more javadocs to make it clear how to use this factory.

Modified: excalibur/trunk/containerkit/logger/src/java/org/apache/avalon/excalibur/logger/factory/SMTPTargetFactory.java
==============================================================================
--- excalibur/trunk/containerkit/logger/src/java/org/apache/avalon/excalibur/logger/factory/SMTPTargetFactory.java	(original)
+++ excalibur/trunk/containerkit/logger/src/java/org/apache/avalon/excalibur/logger/factory/SMTPTargetFactory.java	Thu Jul 29 03:39:19 2004
@@ -50,6 +50,21 @@
  * </smtp>
  * </pre>
  *
+ * The Factory will look for a javax.mail.Session instance in the Context using
+ *  the specified context-key.   If your needs are simple, then it is also possible
+ *  to define a Session within the configuration by replacing the context-key
+ *  attribute with a session child element as follows:
+ * <p>
+ * <pre>
+ * &lt;session&gt;
+ *   &lt;parameter name="mail.host" value="mail.tanukisoftware.com"/&gt;
+ * &lt;/session&gt;
+ * </pre>
+ * The Session is created by calling Session.getInstance, providing a Properties
+ *  object whose values are defined in the above block.  Any valid name value
+ *  pair can be specified.
+ * <p>
+ *
  * <dl>
  *  <dt>&lt;format&gt;</dt>
  *  <dd>

---------------------------------------------------------------------
To unsubscribe, e-mail: scm-unsubscribe@excalibur.apache.org
For additional commands, e-mail: scm-help@excalibur.apache.org