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 2006/09/23 15:51:34 UTC

svn commit: r449243 - in /james/server/trunk/src/java/org/apache/james: remotemanager/RemoteManager.java transport/JamesSpoolManager.java transport/LinearProcessor.java transport/Loader.java transport/StateAwareProcessorList.java

Author: norman
Date: Sat Sep 23 06:51:34 2006
New Revision: 449243

URL: http://svn.apache.org/viewvc?view=rev&rev=449243
Log:
Fix/Add javadocs. See JAMES-628
Remove some unused imports and code

Modified:
    james/server/trunk/src/java/org/apache/james/remotemanager/RemoteManager.java
    james/server/trunk/src/java/org/apache/james/transport/JamesSpoolManager.java
    james/server/trunk/src/java/org/apache/james/transport/LinearProcessor.java
    james/server/trunk/src/java/org/apache/james/transport/Loader.java
    james/server/trunk/src/java/org/apache/james/transport/StateAwareProcessorList.java

Modified: james/server/trunk/src/java/org/apache/james/remotemanager/RemoteManager.java
URL: http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/remotemanager/RemoteManager.java?view=diff&rev=449243&r1=449242&r2=449243
==============================================================================
--- james/server/trunk/src/java/org/apache/james/remotemanager/RemoteManager.java (original)
+++ james/server/trunk/src/java/org/apache/james/remotemanager/RemoteManager.java Sat Sep 23 06:51:34 2006
@@ -84,26 +84,56 @@
     
     private BayesianAnalyzerManagementService bayesianAnalyzerManagement;
     
+    /**
+     * Set the UserStore 
+     * 
+     * @param usersStore the UserStore
+     */
     public void setUsersStore(UsersStore usersStore) {
         this.usersStore = usersStore;
     }
 
+    /**
+     * Set the UsersRepository
+     * 
+     * @param users the UsersRepository
+     */
     public void setUsers(UsersRepository users) {
         this.users = users;
     }
 
+    /**
+     * Set the SpoolManagementService
+     * 
+     * @param spoolManagement the SpoolManagementService
+     */
     public void setSpoolManagement(SpoolManagementService spoolManagement) {
         this.spoolManagement = spoolManagement;
     }
 
+    /**
+     * Set the MailServer 
+     * 
+     * @param mailServer the MailServer
+     */
     public void setMailServer(MailServer mailServer) {
         this.mailServer = mailServer;
     }
 
+    /**
+     * Set the Store
+     * 
+     * @param store the Store
+     */
     public void setStore(Store store) {
         this.store = store;
     }
     
+    /**
+     * Set the BayesianAnalyzerManagementService
+     * 
+     * @param bayesianAnalyzerManagement the BayesianAnalyzerManagementService
+     */
     public void setBayesianAnalyzerManagement(BayesianAnalyzerManagementService bayesianAnalyzerManagement) {
         this.bayesianAnalyzerManagement = bayesianAnalyzerManagement;
     }

Modified: james/server/trunk/src/java/org/apache/james/transport/JamesSpoolManager.java
URL: http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/JamesSpoolManager.java?view=diff&rev=449243&r1=449242&r2=449243
==============================================================================
--- james/server/trunk/src/java/org/apache/james/transport/JamesSpoolManager.java (original)
+++ james/server/trunk/src/java/org/apache/james/transport/JamesSpoolManager.java Sat Sep 23 06:51:34 2006
@@ -102,6 +102,11 @@
      */
     private MailProcessor processorList;
 
+    /**
+     * Set the SpoolRepository
+     * 
+     * @param spool the SpoolRepository
+     */
     public void setSpool(SpoolRepository spool) {
         this.spool = spool;
     }
@@ -261,7 +266,8 @@
      *
      * This implementation shuts down the LinearProcessors managed by this
      * JamesSpoolManager
-     *
+     * 
+     * @see org.apache.avalon.framework.activity.Disposable#dispose()
      */
     public void dispose() {
         getLogger().info("JamesSpoolManager dispose...");

Modified: james/server/trunk/src/java/org/apache/james/transport/LinearProcessor.java
URL: http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/LinearProcessor.java?view=diff&rev=449243&r1=449242&r2=449243
==============================================================================
--- james/server/trunk/src/java/org/apache/james/transport/LinearProcessor.java (original)
+++ james/server/trunk/src/java/org/apache/james/transport/LinearProcessor.java Sat Sep 23 06:51:34 2006
@@ -138,10 +138,20 @@
         this.spool = spool;
     }
 
+    /**
+     * Set the MailetLoader
+     * 
+     * @param mailetLoader the MailetLoader
+     */
     public void setMailetLoader(MailetLoader mailetLoader) {
         this.mailetLoader = mailetLoader;
     }
 
+    /**
+     * Set the MatcherLoader
+     * 
+     * @param matchLoader the MatcherLoader
+     */
     public void setMatchLoader(MatcherLoader matchLoader) {
         this.matchLoader = matchLoader;
     }
@@ -154,6 +164,7 @@
      * <p>This implementation disposes of all the mailet instances added to the
      * processor</p>
      *
+     * @see org.apache.avalon.framework.activity.Disposable#dispose()
      */
     public void dispose() {
         Iterator it = mailets.iterator();
@@ -256,22 +267,7 @@
     }
 
     /**
-     * <p>Processes a single mail message through the chain of matchers and mailets.</p>
-     *
-     * <p>Calls to this method before setSpool has been called with a non-null argument
-     * will result in an <code>IllegalStateException</code>.</p>
-     *
-     * <p>If the matcher/mailet lists have not been closed by a call to the closeProcessorLists
-     * method then a call to this method will result in an <code>IllegalStateException</code>.
-     * The end of the matcher/mailet chain must be a matcher that matches all mails and 
-     * a mailet that sets every mail to GHOST status.  This is necessary to ensure that 
-     * mails are removed from the spool in an orderly fashion.  The closeProcessorLists method
-     * ensures this.</p>
-     * 
-     * @param mail the new mail to be processed
-     *
-     * @throws IllegalStateException when this method is called before the processor lists have been closed
-     *                                  or the spool has been initialized
+     * @see org.apache.james.services.MailProcessor#service(org.apache.mailet.Mail)
      */
     public void service(Mail mail) throws MessagingException {
         if (spool == null) {
@@ -489,7 +485,6 @@
      * Create a unique new primary key name.
      *
      * @param mail the mail to use as the basis for the new mail name
-     * 
      * @return a new name
      */
     private String newName(Mail mail) {

Modified: james/server/trunk/src/java/org/apache/james/transport/Loader.java
URL: http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/Loader.java?view=diff&rev=449243&r1=449242&r2=449243
==============================================================================
--- james/server/trunk/src/java/org/apache/james/transport/Loader.java (original)
+++ james/server/trunk/src/java/org/apache/james/transport/Loader.java Sat Sep 23 06:51:34 2006
@@ -60,6 +60,11 @@
      */
     protected MailetContext mailetContext;
 
+    /**
+     * Set the MailetContext
+     * 
+     * @param mailetContext the MailetContext
+     */
     public void setMailetContext(MailetContext mailetContext) {
         this.mailetContext = mailetContext;
     }

Modified: james/server/trunk/src/java/org/apache/james/transport/StateAwareProcessorList.java
URL: http://svn.apache.org/viewvc/james/server/trunk/src/java/org/apache/james/transport/StateAwareProcessorList.java?view=diff&rev=449243&r1=449242&r2=449243
==============================================================================
--- james/server/trunk/src/java/org/apache/james/transport/StateAwareProcessorList.java (original)
+++ james/server/trunk/src/java/org/apache/james/transport/StateAwareProcessorList.java Sat Sep 23 06:51:34 2006
@@ -123,11 +123,9 @@
             }
         }
     }
+    
     /**
-     * Process this mail message by the appropriate processor as designated
-     * in the state of the Mail object.
-     *
-     * @param mail the mail message to be processed
+     * @see org.apache.james.services.MailProcessor#service(org.apache.mailet.Mail)
      */
     public void service(Mail mail) {
         while (true) {



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