You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by no...@apache.org on 2011/12/31 20:19:37 UTC

svn commit: r1226183 - in /james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core: AbstractAddHeadersFilter.java ReceivedDataLineFilter.java

Author: norman
Date: Sat Dec 31 19:19:37 2011
New Revision: 1226183

URL: http://svn.apache.org/viewvc?rev=1226183&view=rev
Log:
Add abstract base classes for header and body filtering / modification. See PROTOCOLS-77

Modified:
    james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java
    james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java

Modified: james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java
URL: http://svn.apache.org/viewvc/james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java?rev=1226183&r1=1226182&r2=1226183&view=diff
==============================================================================
--- james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java (original)
+++ james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java Sat Dec 31 19:19:37 2011
@@ -28,6 +28,11 @@ import org.apache.james.protocols.api.Re
 import org.apache.james.protocols.api.handler.LineHandler;
 import org.apache.james.protocols.smtp.SMTPSession;
 
+/**
+ * Abstract base class for {@link SeparatingDataLineFilter} implementations that add headers to a message
+ * 
+ *
+ */
 public abstract class AbstractAddHeadersFilter extends SeparatingDataLineFilter{
 
     private static final AtomicInteger COUNTER = new AtomicInteger(0);
@@ -63,7 +68,15 @@ public abstract class AbstractAddHeaders
         }
         return super.onHeadersLine(session, line, next);
     }
-    
+   
+    /**
+     * Add headers to the message
+     * 
+     * @param session
+     * @param line
+     * @param next
+     * @return response
+     */
     private Response addHeaders(SMTPSession session, ByteBuffer line, LineHandler<SMTPSession> next) {
         Response response;
         for (Header header: headers(session)) {

Modified: james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java
URL: http://svn.apache.org/viewvc/james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java?rev=1226183&r1=1226182&r2=1226183&view=diff
==============================================================================
--- james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java (original)
+++ james/protocols/trunk/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java Sat Dec 31 19:19:37 2011
@@ -30,6 +30,11 @@ import org.apache.james.protocols.api.Pr
 import org.apache.james.protocols.smtp.MailAddress;
 import org.apache.james.protocols.smtp.SMTPSession;
 
+/**
+ * {@link AbstractAddHeadersFilter} which adds the Received header for the message.
+ * 
+ *
+ */
 public class ReceivedDataLineFilter extends AbstractAddHeadersFilter {
     
     private static final ThreadLocal<DateFormat> DATEFORMAT = new ThreadLocal<DateFormat>() {
@@ -72,11 +77,17 @@ public class ReceivedDataLineFilter exte
         }
     }
 
+    /**
+     * The Received header is added in front of the received headers. So returns {@link Location#Suffix}
+     */
     @Override
     protected Location getLocation() {
         return Location.Prefix;
     }
 
+    /**
+     * Return the Received header for the message
+     */
     @SuppressWarnings("unchecked")
     @Override
     protected Collection<Header> headers(SMTPSession session) {



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org