Author: norman
Date: Wed Aug 26 20:45:30 2009
New Revision: 808181

URL: http://svn.apache.org/viewvc?rev=808181&view=rev
Log:
Just fix some javadocs
Move empty method to abstract class

Modified:
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSendMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSessionHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/CreateFolderHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteFolderHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/ExposeMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchFoldersHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchMessagesHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/ForwardMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/MoveMessageHandler.java
    labs/hupa/src/main/java/org/apache/hupa/server/handler/NoopHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/RenameFolderHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/ReplyMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/handler/SendMessageHandler.java
    
labs/hupa/src/main/java/org/apache/hupa/server/servlet/DownloadAttachmentServlet.java
    
labs/hupa/src/main/java/org/apache/hupa/server/servlet/UploadAttachmentServlet.java

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSendMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSendMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSendMessageHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSendMessageHandler.java
 Wed Aug 26 20:45:30 2009
@@ -84,8 +84,27 @@
        }
 
 
+       /**
+        * Create basic Message which contains all headers. No body is filled
+        * 
+        * @param session the Session
+        * @param action the action
+        * @return message
+        * @throws AddressException
+        * @throws MessagingException
+        * @throws ActionException
+        */
        protected abstract Message createMessage(Session session, A action) 
throws AddressException, MessagingException,ActionException;
        
+       /**
+        * Fill the body of the given message with data which the given action 
contain
+        * 
+        * @param message the message
+        * @param action the action
+        * @return filledMessage
+        * @throws MessagingException
+        * @throws ActionException
+        */
        protected Message fillBody(Message message, A action) throws 
MessagingException, ActionException {
 
                org.apache.hupa.shared.data.Message m = action.getMessage();
@@ -115,6 +134,14 @@
                return message;
        }
        
+       /**
+        * Construct the multipart for the given attachments and return it
+        * 
+        * @param multipart 
+        * @param attachments
+        * @return multipart
+        * @throws MessagingException
+        */
        protected Multipart handleAttachments(Multipart multipart, 
ArrayList<MessageAttachment> attachments) throws MessagingException {
                if (attachments != null) {
                        // lopp over the attachments
@@ -240,6 +267,13 @@
                return new EmptyResult();
        }
 
+       /**
+        * Get a Address array for the given ArrayList 
+        * 
+        * @param recipients
+        * @return addressArray
+        * @throws AddressException
+        */
        protected Address[] getRecipients(ArrayList<String> recipients) throws 
AddressException {
                if (recipients == null) {
                        return new InternetAddress[]{};
@@ -251,11 +285,5 @@
                return array;
 
        }
-       public void rollback(A arg0, EmptyResult arg1, ExecutionContext arg2)
-                       throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-       
 
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSessionHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSessionHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSessionHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/AbstractSessionHandler.java
 Wed Aug 26 20:45:30 2009
@@ -64,6 +64,13 @@
                }
        }
        
+       /**
+        * Not implemented. Should get overridden if needed
+        */
+       public void rollback(A action, R result,
+                       ExecutionContext context) throws ActionException {
+               // Not implemented
+       }
        
        /*
         * (non-Javadoc)

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/CreateFolderHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/CreateFolderHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/CreateFolderHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/CreateFolderHandler.java 
Wed Aug 26 20:45:30 2009
@@ -81,16 +81,4 @@
                return CreateFolder.class;
        }
 
-       /*
-        * (non-Javadoc)
-        * @see 
net.customware.gwt.dispatch.server.ActionHandler#rollback(net.customware.gwt.dispatch.shared.Action,
 net.customware.gwt.dispatch.shared.Result, 
net.customware.gwt.dispatch.server.ExecutionContext)
-        */
-       public void rollback(CreateFolder arg0, EmptyResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-
-
-
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteFolderHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteFolderHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteFolderHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteFolderHandler.java 
Wed Aug 26 20:45:30 2009
@@ -85,10 +85,4 @@
                return DeleteFolder.class;
        }
 
-       public void rollback(DeleteFolder arg0, EmptyResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteMessageHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/DeleteMessageHandler.java
 Wed Aug 26 20:45:30 2009
@@ -109,13 +109,4 @@
                return DeleteMessage.class;
        }
 
-       /*
-        * (non-Javadoc)
-        * @see 
net.customware.gwt.dispatch.server.ActionHandler#rollback(net.customware.gwt.dispatch.shared.Action,
 net.customware.gwt.dispatch.shared.Result, 
net.customware.gwt.dispatch.server.ExecutionContext)
-        */
-       public void rollback(DeleteMessage arg0, DeleteMessageResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // no rollback implemented
-       }
-       
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ExposeMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/ExposeMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ExposeMessageHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ExposeMessageHandler.java
 Wed Aug 26 20:45:30 2009
@@ -53,20 +53,23 @@
        public ExposeMessageHandler(IMAPStoreCache cache, Log 
logger,Provider<HttpSession> sProvider) {
                super(cache,logger,sProvider);
        }
+       
+       /*
+        * (non-Javadoc)
+        * @see 
org.apache.hupa.server.handler.AbstractSessionHandler#executeInternal(org.apache.hupa.shared.rpc.Session,
 net.customware.gwt.dispatch.server.ExecutionContext)
+        */
        public ExposeMessageResult executeInternal(ExposeMessage action, 
ExecutionContext arg1)
                        throws ActionException {
                        return new 
ExposeMessageResult(exposeMessage(getUser(action.getSessionId()), 
action.getFolder(), action.getMessage()));
        }
 
+       /*
+        * (non-Javadoc)
+        * @see net.customware.gwt.dispatch.server.ActionHandler#getActionType()
+        */
        public Class<ExposeMessage> getActionType() {
                return ExposeMessage.class;
        }
-
-       public void rollback(ExposeMessage arg0, ExposeMessageResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
        
        protected IMAPMessage exposeMessage(User user, IMAPFolder folder, 
IMAPMessage msg) throws ActionException {
                IMAPStore store = null;

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchFoldersHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchFoldersHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchFoldersHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchFoldersHandler.java 
Wed Aug 26 20:45:30 2009
@@ -82,14 +82,6 @@
                }
        }
 
-       /*
-        * (non-Javadoc)
-        * @see 
net.customware.gwt.dispatch.server.ActionHandler#rollback(net.customware.gwt.dispatch.shared.Action,
 net.customware.gwt.dispatch.shared.Result, 
net.customware.gwt.dispatch.server.ExecutionContext)
-        */
-       public void rollback(FetchFolders arg0, FetchFoldersResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // not implemented
-       }
 
        /*
         * (non-Javadoc)

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchMessagesHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchMessagesHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchMessagesHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/FetchMessagesHandler.java
 Wed Aug 26 20:45:30 2009
@@ -235,14 +235,4 @@
        public Class<FetchMessages> getActionType() {
                return FetchMessages.class;
        }
-
-       /*
-        * (non-Javadoc)
-        * @see 
net.customware.gwt.dispatch.server.ActionHandler#rollback(net.customware.gwt.dispatch.shared.Action,
 net.customware.gwt.dispatch.shared.Result, 
net.customware.gwt.dispatch.server.ExecutionContext)
-        */
-       public void rollback(FetchMessages arg0, FetchMessagesResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // not implemented
-               
-       }
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ForwardMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/ForwardMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ForwardMessageHandler.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ForwardMessageHandler.java
 Wed Aug 26 20:45:30 2009
@@ -47,6 +47,11 @@
 import com.sun.mail.imap.IMAPFolder;
 import com.sun.mail.imap.IMAPStore;
 
+/**
+ * Handler which handles the forwarding of a message
+ * @author norman
+ *
+ */
 public class ForwardMessageHandler extends 
AbstractSendMessageHandler<ForwardMessage>{
 
        @Inject

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/MoveMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/MoveMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/MoveMessageHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/MoveMessageHandler.java 
Wed Aug 26 20:45:30 2009
@@ -39,6 +39,10 @@
 import com.sun.mail.imap.IMAPFolder;
 import com.sun.mail.imap.IMAPStore;
 
+/**
+ * Handler which handle moving of messages
+ *
+ */
 public class MoveMessageHandler extends AbstractSessionHandler<MoveMessage, 
MoveMessageResult>{
 
        @Inject
@@ -47,7 +51,10 @@
                super(cache, logger, sessionProvider);
        }
 
-       @Override
+       /*
+        * (non-Javadoc)
+        * @see 
org.apache.hupa.server.handler.AbstractSessionHandler#executeInternal(org.apache.hupa.shared.rpc.Session,
 net.customware.gwt.dispatch.server.ExecutionContext)
+        */
        protected MoveMessageResult executeInternal(MoveMessage action,
                        ExecutionContext context) throws ActionException {
                User user = getUser(action.getSessionId());
@@ -70,14 +77,12 @@
                }
        }
 
+       /*
+        * (non-Javadoc)
+        * @see net.customware.gwt.dispatch.server.ActionHandler#getActionType()
+        */
        public Class<MoveMessage> getActionType() {
                return MoveMessage.class;
        }
 
-       public void rollback(MoveMessage arg0, MoveMessageResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/NoopHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/NoopHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- labs/hupa/src/main/java/org/apache/hupa/server/handler/NoopHandler.java 
(original)
+++ labs/hupa/src/main/java/org/apache/hupa/server/handler/NoopHandler.java Wed 
Aug 26 20:45:30 2009
@@ -70,14 +70,4 @@
                return Noop.class;
        }
 
-       /*
-        * (non-Javadoc)
-        * @see 
net.customware.gwt.dispatch.server.ActionHandler#rollback(net.customware.gwt.dispatch.shared.Action,
 net.customware.gwt.dispatch.shared.Result, 
net.customware.gwt.dispatch.server.ExecutionContext)
-        */
-       public void rollback(Noop arg0, NoopResult arg1, ExecutionContext arg2)
-                       throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/RenameFolderHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/RenameFolderHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/RenameFolderHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/RenameFolderHandler.java 
Wed Aug 26 20:45:30 2009
@@ -36,6 +36,10 @@
 import com.google.inject.Provider;
 import com.sun.mail.imap.IMAPStore;
 
+/**
+ * Handler which handle renaming of folders
+ *
+ */
 public class RenameFolderHandler extends AbstractSessionHandler<RenameFolder, 
EmptyResult>{
 
        @Inject
@@ -44,7 +48,10 @@
                super(cache, logger, sessionProvider);
        }
 
-       @Override
+       /*
+        * (non-Javadoc)
+        * @see 
org.apache.hupa.server.handler.AbstractSessionHandler#executeInternal(org.apache.hupa.shared.rpc.Session,
 net.customware.gwt.dispatch.server.ExecutionContext)
+        */
        protected EmptyResult executeInternal(RenameFolder action,
                        ExecutionContext context) throws ActionException {
                User user = getUser(action.getSessionId());
@@ -70,14 +77,12 @@
 
        }
 
+       /*
+        * (non-Javadoc)
+        * @see net.customware.gwt.dispatch.server.ActionHandler#getActionType()
+        */
        public Class<RenameFolder> getActionType() {
                return RenameFolder.class;
        }
 
-       public void rollback(RenameFolder arg0, EmptyResult arg1,
-                       ExecutionContext arg2) throws ActionException {
-               // TODO Auto-generated method stub
-               
-       }
-
 }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ReplyMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/ReplyMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ReplyMessageHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/ReplyMessageHandler.java 
Wed Aug 26 20:45:30 2009
@@ -41,6 +41,11 @@
 import com.sun.mail.imap.IMAPFolder;
 import com.sun.mail.imap.IMAPStore;
 
+/**
+ * Handler which handle replies to a message
+ * 
+ *
+ */
 public class ReplyMessageHandler extends 
AbstractSendMessageHandler<ReplyMessage>{
 
        @Inject
@@ -50,7 +55,10 @@
                super(logger, registry, store, provider, address, port, auth);
        }
 
-       @Override
+       /*
+        * (non-Javadoc)
+        * @see 
org.apache.hupa.server.handler.AbstractSendMessageHandler#createMessage(javax.mail.Session,
 org.apache.hupa.shared.rpc.SendMessage)
+        */
        protected Message createMessage(Session session, ReplyMessage action)
                        throws AddressException, MessagingException, 
ActionException {
                IMAPStore store = cache.get(getUser(action.getSessionId()));

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/handler/SendMessageHandler.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/handler/SendMessageHandler.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/handler/SendMessageHandler.java 
(original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/handler/SendMessageHandler.java 
Wed Aug 26 20:45:30 2009
@@ -37,6 +37,11 @@
 import com.google.inject.Provider;
 import com.google.inject.name.Named;
 
+/**
+ * Handler which handle sending of new messages
+ * 
+ *
+ */
 public class SendMessageHandler extends 
AbstractSendMessageHandler<SendMessage> {
 
        @Inject
@@ -45,7 +50,10 @@
                super(logger, registry, store, provider, address, port, auth);
        }
 
-       @Override
+       /*
+        * (non-Javadoc)
+        * @see 
org.apache.hupa.server.handler.AbstractSendMessageHandler#createMessage(javax.mail.Session,
 org.apache.hupa.shared.rpc.SendMessage)
+        */
        protected Message createMessage(Session session, SendMessage action)
                        throws AddressException, MessagingException {
                MimeMessage message = new MimeMessage(session);
@@ -58,6 +66,10 @@
                return message;
        }
 
+       /*
+        * (non-Javadoc)
+        * @see net.customware.gwt.dispatch.server.ActionHandler#getActionType()
+        */
        public Class<SendMessage> getActionType() {
                return SendMessage.class;
        }

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/DownloadAttachmentServlet.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/servlet/DownloadAttachmentServlet.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/DownloadAttachmentServlet.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/DownloadAttachmentServlet.java
 Wed Aug 26 20:45:30 2009
@@ -42,8 +42,12 @@
 
 import com.google.inject.Inject;
 import com.sun.mail.imap.IMAPFolder;
-import com.sun.mail.imap.IMAPStore;
 
+/**
+ * Handle download of attachments
+ * 
+ *
+ */
 public class DownloadAttachmentServlet extends HttpServlet {
 
        /**
@@ -59,11 +63,16 @@
                this.logger = logger;
        }
 
+       @Override
        protected void doPost(HttpServletRequest request,
                        HttpServletResponse response) throws ServletException, 
IOException {
                doGet(request, response);
        }
 
+       /**
+        * Handle to write back the requested attachment
+        */
+       @Override
        protected void doGet(HttpServletRequest request,
                        HttpServletResponse response) throws ServletException, 
IOException {
                String message_uuid = request.getParameter("message_uuid");
@@ -169,6 +178,13 @@
                return null;
        }
 
+       /**
+        * Check if the given Part is an attachment
+        * 
+        * @param part
+        * @return isAttachment
+        * @throws MessagingException
+        */
        private boolean isAttachment(Part part) throws MessagingException {
                String disposition = part.getDisposition();
                if 
(part.getContentType().toLowerCase().startsWith("application/")

Modified: 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/UploadAttachmentServlet.java
URL: 
http://svn.apache.org/viewvc/labs/hupa/src/main/java/org/apache/hupa/server/servlet/UploadAttachmentServlet.java?rev=808181&r1=808180&r2=808181&view=diff
==============================================================================
--- 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/UploadAttachmentServlet.java
 (original)
+++ 
labs/hupa/src/main/java/org/apache/hupa/server/servlet/UploadAttachmentServlet.java
 Wed Aug 26 20:45:30 2009
@@ -33,8 +33,18 @@
 
 import gwtupload.server.UploadServlet;
 
+/**
+ * Servlet which handle uploads. The uploaded files will get added to a 
temporary registry to get looked-up
+ * later.
+ * 
+ *
+ */
 public class UploadAttachmentServlet extends UploadServlet{
 
+       /**
+        * 
+        */
+       private static final long serialVersionUID = 4936687307133529124L;
        private FileItemRegistry registry;
        
        @Inject



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

Reply via email to