JAMES-1626 All ProtocolHandler should be lifeCycle aware

If fixes a longstanding error in SMTPServerTest that return code 554 on DNS blacklist test git-svn-id: https://svn.apache.org/repos/asf/james/project/trunk@1712325 13f79535-47bb-0310-9956-ffa450edef68
apache · Nov 3, 2015 · d0bfc00 · d0bfc00
1 parent c60a92e
commit d0bfc00
Show file tree

Hide file tree

Showing 90 changed files with 1,012 additions and 162 deletions.
diff --git a/protocols/api/pom.xml b/protocols/api/pom.xml
@@ -34,8 +34,11 @@
     <name>Apache James :: Protocols :: API</name>
 
     <dependencies>
-
-      <!-- Logging frameworks - completely optional -->
+        <dependency>
+            <groupId>commons-configuration</groupId>
+            <artifactId>commons-configuration</artifactId>
+        </dependency>
+        <!-- Logging frameworks - completely optional -->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>

diff --git a/...pi/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java b/...pi/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java
@@ -81,8 +81,8 @@ public void wireExtensibleHandlers() throws WiringException {
      * @see org.apache.james.protocols.api.handler.ProtocolHandlerChain#destroy()
      */
     public void destroy() {
-        List<LifecycleAwareProtocolHandler> handlers = getHandlers(LifecycleAwareProtocolHandler.class);
-        for (LifecycleAwareProtocolHandler handler: handlers) {
+        List<ProtocolHandler> handlers = getHandlers(ProtocolHandler.class);
+        for (ProtocolHandler handler: handlers) {
             handler.destroy();
         }
     }

diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java
@@ -29,6 +29,8 @@
 import java.util.List;
 import java.util.Locale;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.BaseRequest;
 import org.apache.james.protocols.api.ProtocolSession;
 import org.apache.james.protocols.api.Request;
@@ -60,7 +62,17 @@ public CommandDispatcher(Collection<String> mandatoryCommands) {
     public CommandDispatcher() {
         this(Collections.<String>emptyList());
     }
-
+
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * Add it to map (key as command name, value is an array list of CommandHandlers)
      *

diff --git a/.../api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java b/.../api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java
@@ -18,6 +18,8 @@
  ****************************************************************/
 package org.apache.james.protocols.api.handler;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.ProtocolSession;
 import org.apache.james.protocols.api.Response;
 import org.apache.james.protocols.api.logger.Logger;
@@ -53,4 +55,13 @@ protected void log(ProtocolSession session, Response response, String logmessage
         }
     }
 
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
 }
diff --git a/...i/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java b/...i/src/main/java/org/apache/james/protocols/api/handler/LifecycleAwareProtocolHandler.java
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java
@@ -19,6 +19,8 @@
 
 package org.apache.james.protocols.api.handler;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 
 /**
  * Just the base interface for all kind of "protocol" handlers.
@@ -27,5 +29,18 @@
  * 
  */
 public interface ProtocolHandler {
+
+    /**
+     * Init with the given {@link Configuration}
+     *
+     * @param config
+     * @throws ConfigurationException
+     */
+    void init(Configuration config) throws ConfigurationException;
+
+    /**
+     * Destroy object
+     */
+    void destroy();
 
 }
diff --git a/protocols/imap/src/main/java/org/apache/james/protocols/imap/core/IMAPCommandDispatcher.java b/protocols/imap/src/main/java/org/apache/james/protocols/imap/core/IMAPCommandDispatcher.java
@@ -23,6 +23,8 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.ProtocolSession.State;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
@@ -44,7 +46,17 @@ protected Request parseRequest(IMAPSession session, ByteBuffer buffer) throws Ex
             MultiLineHandler<IMAPSession> handler = new MultiLineHandler<IMAPSession>() {
 
                 private static final String BYTES_READ = "BYTES_READ";
-
+
+                @Override
+                public void init(Configuration config) throws ConfigurationException {
+
+                }
+
+                @Override
+                public void destroy() {
+
+                }
+
                 /*
                  * (non-Javadoc)
                  * @see org.apache.james.protocols.api.handler.MultiLineHandler#isReady(org.apache.james.protocols.api.ProtocolSession, java.nio.ByteBuffer)

diff --git a/protocols/lmtp/src/test/java/org/apache/james/protocols/lmtp/AbstractLMTPServerTest.java b/protocols/lmtp/src/test/java/org/apache/james/protocols/lmtp/AbstractLMTPServerTest.java
@@ -27,6 +27,8 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.commons.net.smtp.RelayPath;
 import org.apache.commons.net.smtp.SMTPClient;
 import org.apache.commons.net.smtp.SMTPReply;
@@ -328,7 +330,16 @@ public HookResult deliver(SMTPSession session, MailAddress recipient, MailEnvelo
             } 
             return result;
         }
-
+
+        @Override
+        public void init(Configuration config) throws ConfigurationException {
+
+        }
+
+        @Override
+        public void destroy() {
+
+        }
     }
 
     private final class TestDeliverHook implements DeliverToRecipientHook {
@@ -351,6 +362,16 @@ public HookResult deliver(SMTPSession session, MailAddress recipient, MailEnvelo
         public List<MailEnvelope> getDelivered() {
             return delivered;
         }
-    };
+
+        @Override
+        public void init(Configuration config) throws ConfigurationException {
+
+        }
+
+        @Override
+        public void destroy() {
+
+        }
+    }
 
 }
diff --git a/protocols/pom.xml b/protocols/pom.xml
@@ -121,6 +121,21 @@
                 <artifactId>commons-codec</artifactId>
                 <version>${commons-codec.version}</version>
             </dependency>
+            <dependency>
+                <groupId>commons-configuration</groupId>
+                <artifactId>commons-configuration</artifactId>
+                <version>1.9</version>
+                <exclusions>
+                    <exclusion>
+                        <artifactId>commons-digester</artifactId>
+                        <groupId>commons-digester</groupId>
+                    </exclusion>
+                    <exclusion>
+                        <artifactId>commons-beanutils-core</artifactId>
+                        <groupId>commons-beanutils</groupId>
+                    </exclusion>
+                </exclusions>
+            </dependency>
             <dependency>
                 <groupId>commons-lang</groupId>
                 <artifactId>commons-lang</artifactId>

diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCmdHandler.java
@@ -28,6 +28,8 @@
 import java.util.Set;
 
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
 import org.apache.james.protocols.api.handler.CommandHandler;
@@ -44,6 +46,16 @@ public class CapaCmdHandler implements CommandHandler<POP3Session>, ExtensibleHa
     private static final Collection<String> COMMANDS = Collections.unmodifiableCollection(Arrays.asList("CAPA"));
     private static final Set<String> CAPS = Collections.unmodifiableSet(new HashSet<String>(Arrays.asList("PIPELINING")));
 
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * @see
      * org.apache.james.protocols.api.handler.CommandHandler

diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/DeleCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/DeleCmdHandler.java
@@ -24,6 +24,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.ProtocolSession.State;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
@@ -41,6 +43,16 @@ public class DeleCmdHandler implements CommandHandler<POP3Session> {
     private static final Response SYNTAX_ERROR = new POP3Response(POP3Response.ERR_RESPONSE, "Usage: DELE [mail number]").immutable();
     private static final Response DELETED = new POP3Response(POP3Response.OK_RESPONSE, "Message deleted").immutable();
 
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * Handler method called upon receipt of a DELE command. This command
      * deletes a particular mail message from the mailbox.

diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/ListCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/ListCmdHandler.java
@@ -25,6 +25,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.ProtocolSession.State;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
@@ -37,8 +39,19 @@
  * Handles LIST command
  */
 public class ListCmdHandler implements CommandHandler<POP3Session> {
+
     private static final Collection<String> COMMANDS = Collections.unmodifiableCollection(Arrays.asList("LIST"));
 
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * Handler method called upon receipt of a LIST command. Returns the number
      * of messages in the mailbox and its aggregate size, or optionally, the

diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/NoopCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/NoopCmdHandler.java
@@ -23,6 +23,8 @@
 import java.util.Collection;
 import java.util.Collections;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
 import org.apache.james.protocols.api.handler.CommandHandler;
@@ -33,8 +35,19 @@
  * Handles NOOP command
  */
 public class NoopCmdHandler implements CommandHandler<POP3Session> {
+
     private static final Collection<String> COMMANDS = Collections.unmodifiableCollection(Arrays.asList("NOOP"));
 
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * Handler method called upon receipt of a NOOP command. Like all good
      * NOOPs, does nothing much.

diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/QuitCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/QuitCmdHandler.java
@@ -25,6 +25,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.james.protocols.api.Request;
 import org.apache.james.protocols.api.Response;
 import org.apache.james.protocols.api.ProtocolSession.State;
@@ -37,9 +39,11 @@
  * Handles QUIT command
  */
 public class QuitCmdHandler implements CommandHandler<POP3Session> {
+
     private static final Collection<String> COMMANDS = Collections.unmodifiableCollection(Arrays.asList("QUIT"));
     private static final Response SIGN_OFF;
     private static final Response SIGN_OFF_NOT_CLEAN;
+
     static {
         POP3Response response = new POP3Response(POP3Response.OK_RESPONSE, "Apache James POP3 Server signing off.");
         response.setEndSession(true);
@@ -49,6 +53,17 @@ public class QuitCmdHandler implements CommandHandler<POP3Session> {
         response.setEndSession(true);
         SIGN_OFF_NOT_CLEAN = response.immutable();
     }
+
+    @Override
+    public void init(Configuration config) throws ConfigurationException {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+
     /**
      * Handler method called upon receipt of a QUIT command. This method handles
      * cleanup of the POP3Handler state.