Author: norman
Date: Mon Jun 28 20:51:21 2010
New Revision: 958722

URL: http://svn.apache.org/viewvc?rev=958722&view=rev
Log:
Add javadocs for STARTTLS (IMAP-169)

Modified:
    
james/imap/trunk/seda/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java

Modified: 
james/imap/trunk/seda/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
URL: 
http://svn.apache.org/viewvc/james/imap/trunk/seda/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java?rev=958722&r1=958721&r2=958722&view=diff
==============================================================================
--- 
james/imap/trunk/seda/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
 (original)
+++ 
james/imap/trunk/seda/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
 Mon Jun 28 20:51:21 2010
@@ -30,7 +30,8 @@ import org.apache.james.imap.api.process
 import org.apache.james.imap.api.process.SelectedMailbox;
 
 /**
- * Implements a session.
+ * Implements a session which not support STARTTLS. If you want to support 
STARTTLS you need to override
+ * the {...@link #supportStartTLS()} and the {...@link #startTLS()} method
  */
 public class ImapSessionImpl implements ImapSession, ImapConstants {
     private static final Log IMAP_LOG = 
LogFactory.getLog("org.apache.james.imap");
@@ -155,6 +156,11 @@ public class ImapSessionImpl implements 
     }
 
 
+    /**
+     * This implementation does not support STARTTLS. 
+     * 
+     * @return false
+     */
     public boolean supportStartTLS() {
         return false;
     }



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to