Fix a bug which can cause an invalid header id

Add javadocs Some minor refactoring git-svn-id: https://svn.apache.org/repos/asf/james/jspf/branches/asynch-jspf@536180 13f79535-47bb-0310-9956-ffa450edef68
apache · May 8, 2007 · e4b5533 · e4b5533
1 parent 502c4f2
commit e4b5533
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 17 deletions.
diff --git a/src/main/java/org/apache/james/jspf/FutureSPFResult.java b/src/main/java/org/apache/james/jspf/FutureSPFResult.java
@@ -29,6 +29,12 @@ public FutureSPFResult() {
         isReady = false;
     }
 
+    /**
+     * Set SPFResult using the given SPFsession
+     * 
+     * @param session 
+     * 
+     */
     public synchronized void setSPFResult(SPFSession session) {
         setSPFSession(session);
         isReady = true;
@@ -45,31 +51,51 @@ private synchronized void checkReady() {
         }
     }
 
+    /**
+     * @see org.apache.james.jspf.SPFResult#getExplanation()
+     */
     public String getExplanation() {
         checkReady();
         return super.getExplanation();
     }
 
+    /**
+     * @see org.apache.james.jspf.SPFResult#getHeader()
+     */
     public String getHeader() {
         checkReady();
         return super.getHeader();
     }
 
+    /**
+     * @see org.apache.james.jspf.SPFResult#getHeaderName()
+     */
     public String getHeaderName() {
         checkReady();
         return super.getHeaderName();
     }
 
+    /**
+     * @see org.apache.james.jspf.SPFResult#getHeaderText()
+     */
     public String getHeaderText() {
         checkReady();
         return super.getHeaderText();
     }
 
+    /**
+     * @see org.apache.james.jspf.SPFResult#getResult()
+     */
     public String getResult() {
         checkReady();
         return super.getResult();
     }
 
+    /**
+     * Return true if the result was fully builded 
+     * 
+     * @return true or false
+     */
     public boolean isReady() {
         return isReady;
     }

diff --git a/src/main/java/org/apache/james/jspf/SPF.java b/src/main/java/org/apache/james/jspf/SPF.java
@@ -277,6 +277,24 @@ public SPF(DNSService dnsProbe, SPFRecordParser parser, Logger logger, MacroExpa
         this.executor = executor;
     }
 
+
+    private static final class DefaultSPFChecker implements SPFChecker {
+
+        /**
+         * @see org.apache.james.jspf.core.SPFChecker#checkSPF(org.apache.james.jspf.core.SPFSession)
+         */
+        public DNSLookupContinuation checkSPF(SPFSession spfData)
+                throws PermErrorException, TempErrorException,
+                NeutralException, NoneException {
+            if (spfData.getCurrentResultExpanded() == null) {
+                String resultChar = spfData.getCurrentResult() != null ? spfData.getCurrentResult() : "";
+                String result = SPF1Utils.resultToName(resultChar);
+                spfData.setCurrentResultExpanded(result);
+            }
+            return null;
+        }
+    }
+
     /**
      * Run check for SPF with the given values.
      * 
@@ -300,20 +318,7 @@ public SPFResult checkSPF(String ipAddress, String mailFrom, String hostName) {
             spfData.setCurrentResultExpanded(e1.getResult());
         }
 
-        SPFChecker resultHandler = new SPFChecker() {
-
-            public DNSLookupContinuation checkSPF(SPFSession spfData)
-                    throws PermErrorException, TempErrorException,
-                    NeutralException, NoneException {
-                if (spfData.getCurrentResultExpanded() == null) {
-                    String resultChar = spfData.getCurrentResult() != null ? spfData.getCurrentResult() : "";
-                    String result = SPF1Utils.resultToName(resultChar);
-                    spfData.setCurrentResultExpanded(result);
-                }
-                return null;
-            }
-
-        };
+        SPFChecker resultHandler = new DefaultSPFChecker();
 
         spfData.pushChecker(resultHandler);
         spfData.pushChecker(this);

diff --git a/src/main/java/org/apache/james/jspf/core/SPFSession.java b/src/main/java/org/apache/james/jspf/core/SPFSession.java
@@ -79,7 +79,7 @@ public class SPFSession implements MacroData {
     private String currentResultExpanded;
 
     /**
-     * Build the SPF1Data from the given parameters
+     * Build the SPFSession from the given parameters
      * 
      * @param mailFrom
      *            The emailaddress of the sender

diff --git a/src/main/java/org/apache/james/jspf/core/StagedMultipleSPFExecutor.java b/src/main/java/org/apache/james/jspf/core/StagedMultipleSPFExecutor.java
@@ -62,9 +62,16 @@ public synchronized IResponse removeResponse() {
 
     }
 
-    private static int id = 1;
+    // Use short as id because the id header is limited to 16 bit
+    // From RFC1035 4.1.1. Header section format :
+    // 
+    // ID              A 16 bit identifier assigned by the program that
+    //                 generates any kind of query.  This identifier is copied
+    //                 the corresponding reply and can be used by the requester
+    //                 to match up replies to outstanding queries.
+    //
+    private static short id;
 
-    // TODO: sooner or later we have to avoid overflow and restart.
     private synchronized int nextId() {
         return id++;
     }

diff --git a/src/main/java/org/apache/james/jspf/policies/InitialChecksPolicy.java b/src/main/java/org/apache/james/jspf/policies/InitialChecksPolicy.java
@@ -38,6 +38,9 @@
  */
 public final class InitialChecksPolicy implements SPFChecker {
 
+    /**
+     * @see org.apache.james.jspf.core.SPFChecker#checkSPF(org.apache.james.jspf.core.SPFSession)
+     */
     public DNSLookupContinuation checkSPF(SPFSession spfData)
             throws PermErrorException, TempErrorException, NeutralException,
             NoneException {

diff --git a/src/main/java/org/apache/james/jspf/policies/SPFRetriever.java b/src/main/java/org/apache/james/jspf/policies/SPFRetriever.java
@@ -26,6 +26,9 @@ public class SPFRetriever implements SPFChecker {
 
     private static final class SPFRecordHandlerDNSResponseListener implements SPFCheckerDNSResponseListener {
 
+        /**
+         * @see org.apache.james.jspf.core.SPFCheckerDNSResponseListener#onDNSResponse(org.apache.james.jspf.core.DNSResponse, org.apache.james.jspf.core.SPFSession)
+         */
         public DNSLookupContinuation onDNSResponse(
                 DNSResponse response, SPFSession session)
                 throws PermErrorException,
@@ -50,6 +53,9 @@ public DNSLookupContinuation onDNSResponse(
 
     private static final class SPFRetrieverDNSResponseListener implements SPFCheckerDNSResponseListener {
 
+        /**
+         * @see org.apache.james.jspf.core.SPFCheckerDNSResponseListener#onDNSResponse(org.apache.james.jspf.core.DNSResponse, org.apache.james.jspf.core.SPFSession)
+         */
         public DNSLookupContinuation onDNSResponse(
                 DNSResponse response, SPFSession session)
                 throws PermErrorException, NoneException,

diff --git a/src/main/java/org/apache/james/jspf/policies/SPFStrictCheckerRetriever.java b/src/main/java/org/apache/james/jspf/policies/SPFStrictCheckerRetriever.java
@@ -27,6 +27,9 @@ public class SPFStrictCheckerRetriever extends SPFRetriever {
 
     private static final class SPFStrictSPFRecordsDNSResponseListener implements SPFCheckerDNSResponseListener {
 
+        /**
+         * @see org.apache.james.jspf.core.SPFCheckerDNSResponseListener#onDNSResponse(org.apache.james.jspf.core.DNSResponse, org.apache.james.jspf.core.SPFSession)
+         */
         public DNSLookupContinuation onDNSResponse(
                 DNSResponse response, SPFSession session)
                 throws PermErrorException,
@@ -55,6 +58,9 @@ public DNSLookupContinuation onDNSResponse(
 
     private static final class SPFStrictCheckDNSResponseListener implements SPFCheckerDNSResponseListener {
 
+        /**
+         * @see org.apache.james.jspf.core.SPFCheckerDNSResponseListener#onDNSResponse(org.apache.james.jspf.core.DNSResponse, org.apache.james.jspf.core.SPFSession)
+         */
         public DNSLookupContinuation onDNSResponse(
                 DNSResponse response, SPFSession session)
                 throws PermErrorException, NoneException,

diff --git a/src/main/java/org/apache/james/jspf/policies/local/DefaultExplanationPolicy.java b/src/main/java/org/apache/james/jspf/policies/local/DefaultExplanationPolicy.java
@@ -40,6 +40,10 @@ public final class DefaultExplanationPolicy implements PolicyPostFilter {
 
 
     private final class ExplanationChecker implements SPFChecker {
+
+        /**
+         * @see org.apache.james.jspf.core.SPFChecker#checkSPF(org.apache.james.jspf.core.SPFSession)
+         */
         public DNSLookupContinuation checkSPF(SPFSession spfData)
                 throws PermErrorException,
                 NoneException, TempErrorException,