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 2010/06/27 15:42:01 UTC
svn commit: r958388 - in /james/imap/trunk:
api/src/main/java/org/apache/james/imap/api/message/request/
api/src/main/java/org/apache/james/imap/api/process/
message/src/main/java/org/apache/james/imap/encode/base/
message/src/main/java/org/apache/jame...
Author: norman
Date: Sun Jun 27 13:42:00 2010
New Revision: 958388
URL: http://svn.apache.org/viewvc?rev=958388&view=rev
Log:
Add javadocs
Modified:
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/message/request/ImapRequest.java
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapProcessorFactory.java
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/EndImapEncoder.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/ImapResponseComposerImpl.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/main/DefaultImapEncoderFactory.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractImapRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractMailboxSelectionRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AppendRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AuthenticateRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/BaseImap4Rev1MessageFactory.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CopyRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CreateRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/DeleteRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/ExpungeRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LoginRequest.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LogoutRequest.java
Modified: james/imap/trunk/api/src/main/java/org/apache/james/imap/api/message/request/ImapRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/message/request/ImapRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/api/src/main/java/org/apache/james/imap/api/message/request/ImapRequest.java (original)
+++ james/imap/trunk/api/src/main/java/org/apache/james/imap/api/message/request/ImapRequest.java Sun Jun 27 13:42:00 2010
@@ -21,6 +21,10 @@ package org.apache.james.imap.api.messag
import org.apache.james.imap.api.ImapCommand;
+/**
+ * The actual Imap request
+ *
+ */
public interface ImapRequest {
/**
Modified: james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapProcessorFactory.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapProcessorFactory.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapProcessorFactory.java (original)
+++ james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapProcessorFactory.java Sun Jun 27 13:42:00 2010
@@ -24,5 +24,10 @@ package org.apache.james.imap.api.proces
*/
public interface ImapProcessorFactory {
+ /**
+ * Build a new instance of a {@link ImapProcessor}
+ *
+ * @return processor
+ */
public ImapProcessor buildImapProcessor();
}
Modified: james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java (original)
+++ james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java Sun Jun 27 13:42:00 2010
@@ -22,24 +22,74 @@ package org.apache.james.imap.api.proces
import java.util.Collection;
+/**
+ * Interface which represent a selected Mailbox during the selected state
+ *
+ */
public interface SelectedMailbox {
+ /**
+ * Deselect the Mailbox
+ */
public abstract void deselect();
+ /**
+ * Return the msg index of the given uid
+ *
+ * @param uid
+ * @return index
+ */
public int msn(long uid);
- public abstract long uid(int i);
+ /**
+ * Return the uid of the message for the given index
+ * @param index
+ * @return uid
+ */
+ public abstract long uid(int index);
+ /**
+ * Add a recent uid
+ *
+ * @param uid
+ * @return true if it was successfully
+ */
public boolean addRecent(long uid);
+ /**
+ * Remove a recent uid
+ * @param uid
+ * @return true if it was successfully
+ */
public boolean removeRecent(long uid);
+ /**
+ * Return a Collection of all recent uids
+ *
+ * @return recentUids
+ */
public Collection<Long> getRecent();
+ /**
+ * Return the count of all recent uids
+ *
+ * @return recentCount
+ */
public int recentCount();
+ /**
+ * Return the name of the selected Mailbox
+ *
+ * @return mailboxName
+ */
public String getName();
+ /**
+ * Is the given uid recent ?
+ *
+ * @param uid
+ * @return true if the given uid is recent
+ */
public boolean isRecent(long uid);
/**
@@ -50,14 +100,35 @@ public interface SelectedMailbox {
*/
public boolean isDeletedByOtherSession();
+ /**
+ * Is the size of the mailbox changed ?
+ *
+ * @return true if the mailbox size was changed
+ */
public boolean isSizeChanged();
+ /**
+ * Was the recent uid removed ?
+ *
+ * @return true if the recent uid for this mailbox was removed
+ */
public boolean isRecentUidRemoved();
+ /**
+ *
+ */
public void resetRecentUidRemoved();
+ /**
+ * Reset all events
+ */
public void resetEvents();
+ /**
+ * Return a Collection which holds all uids which were expunged
+ *
+ * @return expungedUids
+ */
public Collection<Long> expungedUids();
/**
@@ -68,5 +139,10 @@ public interface SelectedMailbox {
*/
public int remove(Long uid);
+ /**
+ * Return a Collection which holds all uids reflecting the Messages which flags were updated
+ *
+ * @return flagsUids
+ */
public Collection<Long> flagUpdateUids();
}
\ No newline at end of file
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java Sun Jun 27 13:42:00 2010
@@ -26,6 +26,13 @@ import org.apache.james.imap.api.process
import org.apache.james.imap.encode.ImapEncoder;
import org.apache.james.imap.encode.ImapResponseComposer;
+/**
+ * Abstract base class for chained {@link ImapEncoder} implementations. Implementations of this
+ * will check if the {@link ImapMessage} should get encoded by this Implementation or should get
+ * passed to the next {@link ImapEncoder} in the chain
+ *
+ *
+ */
abstract public class AbstractChainedImapEncoder implements ImapEncoder {
private final ImapEncoder next;
@@ -35,6 +42,10 @@ abstract public class AbstractChainedIma
this.next = next;
}
+ /**
+ * Encode the {@link ImapMessage} if {@link #isAcceptable(ImapMessage)} return true, if not pass it to the
+ * next encoder in the chain
+ */
public void encode(ImapMessage message, ImapResponseComposer composer, ImapSession session)
throws IOException {
final boolean isAcceptable = isAcceptable(message);
@@ -45,6 +56,14 @@ abstract public class AbstractChainedIma
}
}
+ /**
+ * Call next Encoder in the chain
+ *
+ * @param message
+ * @param composer
+ * @param session
+ * @throws IOException
+ */
protected void chainEncode(ImapMessage message,
ImapResponseComposer composer, ImapSession session) throws IOException {
next.encode(message, composer, session);
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/EndImapEncoder.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/EndImapEncoder.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/EndImapEncoder.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/EndImapEncoder.java Sun Jun 27 13:42:00 2010
@@ -27,8 +27,18 @@ import org.apache.james.imap.api.process
import org.apache.james.imap.encode.ImapEncoder;
import org.apache.james.imap.encode.ImapResponseComposer;
+/**
+ * {@link ImapEncoder} which should get added to the end of the encoder chain. It will handle the response
+ * to the client about the unknown {@link ImapMessage}
+ *
+ *
+ */
public class EndImapEncoder implements ImapEncoder {
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapEncoder#encode(org.apache.james.imap.api.ImapMessage, org.apache.james.imap.encode.ImapResponseComposer, org.apache.james.imap.api.process.ImapSession)
+ */
public void encode(ImapMessage message, ImapResponseComposer composer, ImapSession session)
throws IOException {
final Log logger = session.getLog();
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/ImapResponseComposerImpl.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/ImapResponseComposerImpl.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/ImapResponseComposerImpl.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/base/ImapResponseComposerImpl.java Sun Jun 27 13:42:00 2010
@@ -338,6 +338,10 @@ public class ImapResponseComposerImpl im
end();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#listResponse(java.lang.String, java.util.List, java.lang.String, java.lang.String)
+ */
public void listResponse(String typeName, List<String> attributes,
String hierarchyDelimiter, String name) throws IOException {
untagged();
@@ -362,20 +366,36 @@ public class ImapResponseComposerImpl im
end();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#quote(java.lang.String)
+ */
public void quote(String message) throws IOException {
writer.quote(message);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#closeParen()
+ */
public ImapResponseComposer closeParen() throws IOException {
writer.closeParen();
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#openParen()
+ */
public ImapResponseComposer openParen() throws IOException {
writer.openParen();
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#searchResponse(long[])
+ */
public void searchResponse(long[] ids) throws IOException {
untagged();
message(ImapConstants.SEARCH_RESPONSE_NAME);
@@ -393,6 +413,10 @@ public class ImapResponseComposerImpl im
}
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#flags(javax.mail.Flags)
+ */
public void flags(Flags flags) throws IOException {
message(FLAGS);
openParen();
@@ -417,11 +441,19 @@ public class ImapResponseComposerImpl im
closeParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#closeFetchResponse()
+ */
public void closeFetchResponse() throws IOException {
closeParen();
end();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#openFetchResponse(long)
+ */
public void openFetchResponse(long msn) throws IOException {
untagged();
message(msn);
@@ -429,10 +461,18 @@ public class ImapResponseComposerImpl im
openParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#literal(org.apache.james.imap.message.response.Literal)
+ */
public void literal(Literal literal) throws IOException {
writer.literal(literal);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#address(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
+ */
public void address(String name, String domainList, String mailbox,
String host) throws IOException {
skipNextSpace();
@@ -444,10 +484,18 @@ public class ImapResponseComposerImpl im
closeParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#endAddresses()
+ */
public void endAddresses() throws IOException {
closeParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#endEnvelope(java.lang.String, java.lang.String)
+ */
public void endEnvelope(String inReplyTo, String messageId)
throws IOException {
nillableQuote(inReplyTo);
@@ -455,14 +503,26 @@ public class ImapResponseComposerImpl im
closeParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#nil()
+ */
public void nil() throws IOException {
message(NIL);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#startAddresses()
+ */
public void startAddresses() throws IOException {
openParen();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#startEnvelope(java.lang.String, java.lang.String, boolean)
+ */
public void startEnvelope(String date, String subject,
boolean prefixWithName) throws IOException {
if (prefixWithName) {
@@ -473,6 +533,10 @@ public class ImapResponseComposerImpl im
nillableQuote(subject);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#nillableQuote(java.lang.String)
+ */
public ImapResponseComposer nillableQuote(String message)
throws IOException {
if (message == null) {
@@ -483,6 +547,10 @@ public class ImapResponseComposerImpl im
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#skipNextSpace()
+ */
public void skipNextSpace() throws IOException {
writer.skipNextSpace();
}
@@ -495,6 +563,10 @@ public class ImapResponseComposerImpl im
writer.openSquareBracket();
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#nillableComposition(java.lang.String, java.util.List)
+ */
public ImapResponseComposer nillableComposition(String masterQuote,
List<String> quotes) throws IOException {
if (masterQuote == null) {
@@ -508,6 +580,10 @@ public class ImapResponseComposerImpl im
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#nillableQuotes(java.util.List)
+ */
public ImapResponseComposer nillableQuotes(List<String> quotes)
throws IOException {
if (quotes == null || quotes.size() == 0) {
@@ -522,6 +598,10 @@ public class ImapResponseComposerImpl im
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#upperCaseAscii(java.lang.String)
+ */
public ImapResponseComposer upperCaseAscii(String message)
throws IOException {
if (message == null) {
@@ -532,6 +612,10 @@ public class ImapResponseComposerImpl im
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#quoteUpperCaseAscii(java.lang.String)
+ */
public ImapResponseComposer quoteUpperCaseAscii(String message)
throws IOException {
if (message == null) {
@@ -542,6 +626,10 @@ public class ImapResponseComposerImpl im
return this;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapResponseComposer#capabilities(java.util.List)
+ */
public ImapResponseComposer capabilities(List<String> capabilities) throws IOException {
untagged();
message(CAPABILITY_COMMAND_NAME);
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/main/DefaultImapEncoderFactory.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/main/DefaultImapEncoderFactory.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/main/DefaultImapEncoderFactory.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/encode/main/DefaultImapEncoderFactory.java Sun Jun 27 13:42:00 2010
@@ -95,6 +95,10 @@ public class DefaultImapEncoderFactory i
this.neverAddBodyStructureExtensions = neverAddBodyStructureExtensions;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.encode.ImapEncoderFactory#buildImapEncoder()
+ */
public ImapEncoder buildImapEncoder() {
return createDefaultEncoder(localizer, neverAddBodyStructureExtensions);
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractImapRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractImapRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractImapRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractImapRequest.java Sun Jun 27 13:42:00 2010
@@ -22,6 +22,10 @@ import org.apache.james.imap.api.ImapCom
import org.apache.james.imap.api.ImapMessage;
import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * Abstract base class for {@link ImapRequest} implementations
+ *
+ */
abstract public class AbstractImapRequest implements ImapMessage, ImapRequest {
private final String tag;
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractMailboxSelectionRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractMailboxSelectionRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractMailboxSelectionRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AbstractMailboxSelectionRequest.java Sun Jun 27 13:42:00 2010
@@ -20,7 +20,12 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which selects a Mailbox
+ *
+ */
public abstract class AbstractMailboxSelectionRequest extends
AbstractImapRequest {
private final String mailboxName;
@@ -31,6 +36,11 @@ public abstract class AbstractMailboxSel
this.mailboxName = mailboxName;
}
+ /**
+ * Return the mailbox to select
+ *
+ * @return mailboxName
+ */
public final String getMailboxName() {
return mailboxName;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AppendRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AppendRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AppendRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AppendRequest.java Sun Jun 27 13:42:00 2010
@@ -24,8 +24,14 @@ import java.util.Date;
import javax.mail.Flags;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which request the append of a message to a mailbox
+ *
+ *
+ */
public class AppendRequest extends AbstractImapRequest {
private final String mailboxName;
@@ -44,18 +50,38 @@ public class AppendRequest extends Abstr
this.message = message;
}
+ /**
+ * Return the Date used for the append
+ *
+ * @return date
+ */
public Date getDatetime() {
return datetime;
}
+ /**
+ * Return Flags for the Message
+ *
+ * @return flags
+ */
public Flags getFlags() {
return flags;
}
+ /**
+ * Return the name of the mailbox we want to append to
+ *
+ * @return mailboxName
+ */
public String getMailboxName() {
return mailboxName;
}
+ /**
+ * Return the message to append as {@link InputStream}
+ *
+ * @return message
+ */
public InputStream getMessage() {
return message;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AuthenticateRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AuthenticateRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AuthenticateRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/AuthenticateRequest.java Sun Jun 27 13:42:00 2010
@@ -20,6 +20,7 @@ package org.apache.james.imap.message.re
import org.apache.james.imap.api.ImapCommand;
+
public class AuthenticateRequest extends AbstractImapRequest {
private final String authType;
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/BaseImap4Rev1MessageFactory.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/BaseImap4Rev1MessageFactory.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/BaseImap4Rev1MessageFactory.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/BaseImap4Rev1MessageFactory.java Sun Jun 27 13:42:00 2010
@@ -47,6 +47,10 @@ public class BaseImap4Rev1MessageFactory
this.statusResponseFactory = statusResponseFactory;
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createAppendMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, javax.mail.Flags, java.util.Date, java.io.InputStream, java.lang.String)
+ */
public ImapMessage createAppendMessage(ImapCommand command,
String mailboxName, Flags flags, Date datetime,
InputStream message, String tag) {
@@ -54,91 +58,167 @@ public class BaseImap4Rev1MessageFactory
message, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createAuthenticateMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createAuthenticateMessage(ImapCommand command,
String authType, String tag) {
return new AuthenticateRequest(command, authType, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createCapabilityMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createCapabilityMessage(ImapCommand command, String tag) {
return new CapabilityRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createNoopMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createNoopMessage(ImapCommand command, String tag) {
return new NoopRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createCloseMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createCloseMessage(ImapCommand command, String tag) {
return new CloseRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createCopyMessage(org.apache.james.imap.api.ImapCommand, org.apache.james.imap.api.message.IdRange[], java.lang.String, boolean, java.lang.String)
+ */
public ImapMessage createCopyMessage(ImapCommand command, IdRange[] idSet,
String mailboxName, boolean useUids, String tag) {
return new CopyRequest(command, idSet, mailboxName, useUids, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createCreateMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createCreateMessage(ImapCommand command,
String mailboxName, String tag) {
return new CreateRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createDeleteMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createDeleteMessage(ImapCommand command,
String mailboxName, String tag) {
return new DeleteRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createExamineMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createExamineMessage(ImapCommand command,
String mailboxName, String tag) {
return new ExamineRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createExpungeMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createExpungeMessage(ImapCommand command, String tag) {
return new ExpungeRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createFetchMessage(org.apache.james.imap.api.ImapCommand, boolean, org.apache.james.imap.api.message.IdRange[], org.apache.james.imap.api.message.FetchData, java.lang.String)
+ */
public ImapMessage createFetchMessage(ImapCommand command, boolean useUids,
IdRange[] idSet, FetchData fetch, String tag) {
return new FetchRequest(command, useUids, idSet, fetch, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createListMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String, java.lang.String)
+ */
public ImapMessage createListMessage(ImapCommand command,
String referenceName, String mailboxPattern, String tag) {
return new ListRequest(command, referenceName, mailboxPattern, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createLoginMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String, java.lang.String)
+ */
public ImapMessage createLoginMessage(ImapCommand command, String userid,
String password, String tag) {
return new LoginRequest(command, userid, password, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createLogoutMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createLogoutMessage(ImapCommand command, String tag) {
return new LogoutRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createLsubMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String, java.lang.String)
+ */
public ImapMessage createLsubMessage(ImapCommand command,
String referenceName, String mailboxPattern, String tag) {
return new LsubRequest(command, referenceName, mailboxPattern, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createRenameMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String, java.lang.String)
+ */
public ImapMessage createRenameMessage(ImapCommand command,
String existingName, String newName, String tag) {
return new RenameRequest(command, existingName, newName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createSearchMessage(org.apache.james.imap.api.ImapCommand, org.apache.james.imap.api.message.request.SearchKey, boolean, java.lang.String)
+ */
public ImapMessage createSearchMessage(ImapCommand command, SearchKey key,
boolean useUids, String tag) {
return new SearchRequest(command, key, useUids, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createSelectMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createSelectMessage(ImapCommand command,
String mailboxName, String tag) {
return new SelectRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createStatusMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, org.apache.james.imap.api.message.StatusDataItems, java.lang.String)
+ */
public ImapMessage createStatusMessage(ImapCommand command,
String mailboxName, StatusDataItems statusDataItems, String tag) {
return new StatusRequest(command, mailboxName, statusDataItems, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createStoreMessage(org.apache.james.imap.api.ImapCommand, org.apache.james.imap.api.message.IdRange[], boolean, java.lang.Boolean, javax.mail.Flags, boolean, java.lang.String)
+ */
public ImapMessage createStoreMessage(ImapCommand command, IdRange[] idSet,
boolean silent, Boolean sign, Flags flags, boolean useUids,
String tag) {
@@ -146,29 +226,54 @@ public class BaseImap4Rev1MessageFactory
sign);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createSubscribeMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createSubscribeMessage(ImapCommand command,
String mailboxName, String tag) {
return new SubscribeRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createUnsubscribeMessage(org.apache.james.imap.api.ImapCommand, java.lang.String, java.lang.String)
+ */
public ImapMessage createUnsubscribeMessage(ImapCommand command,
String mailboxName, String tag) {
return new UnsubscribeRequest(command, mailboxName, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createCheckMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createCheckMessage(ImapCommand command, String tag) {
return new CheckRequest(command, tag);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#taggedBad(java.lang.String, org.apache.james.imap.api.ImapCommand, org.apache.james.imap.api.display.HumanReadableText)
+ */
public StatusResponse taggedBad(String tag, ImapCommand command,
HumanReadableText displayTextKey) {
return statusResponseFactory.taggedBad(tag, command, displayTextKey);
}
+
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#bye(org.apache.james.imap.api.display.HumanReadableText)
+ */
public StatusResponse bye(HumanReadableText displayTextKey) {
return statusResponseFactory.bye(displayTextKey);
}
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.api.ImapMessageFactory#createNamespaceMessage(org.apache.james.imap.api.ImapCommand, java.lang.String)
+ */
public ImapMessage createNamespaceMessage(ImapCommand command, String tag) {
return new NamespaceRequest(command, tag);
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CopyRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CopyRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CopyRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CopyRequest.java Sun Jun 27 13:42:00 2010
@@ -20,7 +20,13 @@ package org.apache.james.imap.message.re
import org.apache.james.imap.api.ImapCommand;
import org.apache.james.imap.api.message.IdRange;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which request the copy of messages
+ *
+ *
+ */
public class CopyRequest extends AbstractImapRequest {
private final IdRange[] idSet;
@@ -37,10 +43,20 @@ public class CopyRequest extends Abstrac
this.useUids = useUids;
}
+ /**
+ * Return an Array of {@link IdRange} to copy
+ *
+ * @return range
+ */
public final IdRange[] getIdSet() {
return idSet;
}
+ /**
+ * Return the name of the mailbox
+ *
+ * @return mailbox
+ */
public final String getMailboxName() {
return mailboxName;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CreateRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CreateRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CreateRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CreateRequest.java Sun Jun 27 13:42:00 2010
@@ -19,7 +19,13 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which request the creation of a mailbox
+ *
+ *
+ */
public class CreateRequest extends AbstractImapRequest {
private final String mailboxName;
@@ -29,6 +35,11 @@ public class CreateRequest extends Abstr
this.mailboxName = mailboxName;
}
+ /**
+ * Return the name of the mailbox to create
+ *
+ * @return mailboxName
+ */
public final String getMailboxName() {
return mailboxName;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/DeleteRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/DeleteRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/DeleteRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/DeleteRequest.java Sun Jun 27 13:42:00 2010
@@ -19,7 +19,13 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which request the deletion of a mailbox
+ *
+ *
+ */
public class DeleteRequest extends AbstractImapRequest {
private final String mailboxName;
@@ -29,6 +35,11 @@ public class DeleteRequest extends Abstr
this.mailboxName = mailboxName;
}
+ /**
+ * Return the name of the mailbox to delete
+ *
+ * @return mailboxName
+ */
public final String getMailboxName() {
return mailboxName;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/ExpungeRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/ExpungeRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/ExpungeRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/ExpungeRequest.java Sun Jun 27 13:42:00 2010
@@ -19,7 +19,12 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which requests expunge of deleted messages
+ *
+ */
public class ExpungeRequest extends AbstractImapRequest {
public ExpungeRequest(final ImapCommand command, final String tag) {
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LoginRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LoginRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LoginRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LoginRequest.java Sun Jun 27 13:42:00 2010
@@ -19,7 +19,13 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which requests the login of a user
+ *
+ *
+ */
public class LoginRequest extends AbstractImapRequest {
private final String userid;
@@ -32,10 +38,20 @@ public class LoginRequest extends Abstra
this.password = password;
}
+ /**
+ * Return the password
+ *
+ * @return pass
+ */
public final String getPassword() {
return password;
}
+ /**
+ * Return the username
+ *
+ * @return user
+ */
public final String getUserid() {
return userid;
}
Modified: james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LogoutRequest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LogoutRequest.java?rev=958388&r1=958387&r2=958388&view=diff
==============================================================================
--- james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LogoutRequest.java (original)
+++ james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/LogoutRequest.java Sun Jun 27 13:42:00 2010
@@ -19,7 +19,12 @@
package org.apache.james.imap.message.request;
import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.message.request.ImapRequest;
+/**
+ * {@link ImapRequest} which requests the logout
+ *
+ */
public class LogoutRequest extends AbstractImapRequest {
public LogoutRequest(final ImapCommand command, final String tag) {
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org