Author: norman
Date: Sun Jan 16 18:43:40 2011
New Revision: 1059631
URL: http://svn.apache.org/viewvc?rev=1059631&view=rev
Log:
Add support for COMPRESS extension. See IMAP-247
Added:
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/CompressCommandParser.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CompressRequest.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/CompressProcessor.java
Modified:
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/ImapConstants.java
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/display/HumanReadableText.java
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/ImapParserFactory.java
james/imap/trunk/message/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/DefaultProcessorChain.java
Modified:
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/ImapConstants.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/ImapConstants.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/ImapConstants.java
(original)
+++
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/ImapConstants.java
Sun Jan 16 18:43:40 2011
@@ -252,4 +252,6 @@ public interface ImapConstants {
public static final long MAX_NZ_NUMBER = 4294967295L;
public static final long MIN_NZ_NUMBER = 1L;
+ public static final String COMPRESS_COMMAND_NAME = "COMPRESS";
+
}
Modified:
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/display/HumanReadableText.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/display/HumanReadableText.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/display/HumanReadableText.java
(original)
+++
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/display/HumanReadableText.java
Sun Jan 16 18:43:40 2011
@@ -199,6 +199,14 @@ public class HumanReadableText {
public static final HumanReadableText IDLING = new HumanReadableText(
"org.apache.james.imap.IDLING", "Idling");
+ public static final HumanReadableText DEFLATE_ACTIVE = new
HumanReadableText(
+ "org.apache.james.imap.DEFLATE", "DEFLATE active");
+
+ public static final HumanReadableText COMPRESS_ALREADY_ACTIVE = new
HumanReadableText(
+ "org.apache.james.imap.DEFLATE", "already active");
+
+
+
public static final HumanReadableText UNSELECT = new HumanReadableText(
"org.apache.james.imap.UNSELECT", "No Mailbox selected.");
private final String defaultValue;
Modified:
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
(original)
+++
james/imap/trunk/api/src/main/java/org/apache/james/imap/api/process/ImapSession.java
Sun Jan 16 18:43:40 2011
@@ -31,6 +31,7 @@ import org.apache.james.imap.api.ImapSes
*/
public interface ImapSession {
+
/**
* Gets the context sensitive log for this session.
* Understanding the context of a log message is an important
@@ -122,6 +123,8 @@ public interface ImapSession {
*/
public boolean supportStartTLS();
+ public boolean isCompressionSupported();
+ public boolean startCompression();
}
Added:
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/CompressCommandParser.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/CompressCommandParser.java?rev=1059631&view=auto
==============================================================================
---
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/CompressCommandParser.java
(added)
+++
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/CompressCommandParser.java
Sun Jan 16 18:43:40 2011
@@ -0,0 +1,46 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+package org.apache.james.imap.decode.parser;
+
+import org.apache.james.imap.api.ImapCommand;
+import org.apache.james.imap.api.ImapConstants;
+import org.apache.james.imap.api.ImapMessage;
+import org.apache.james.imap.api.process.ImapSession;
+import org.apache.james.imap.decode.DecodingException;
+import org.apache.james.imap.decode.ImapRequestLineReader;
+import org.apache.james.imap.decode.base.AbstractImapCommandParser;
+import org.apache.james.imap.message.request.CompressRequest;
+
+public class CompressCommandParser extends AbstractImapCommandParser{
+
+ public CompressCommandParser() {
+
super(ImapCommand.anyStateCommand(ImapConstants.COMPRESS_COMMAND_NAME));
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.decode.base.AbstractImapCommandParser#decode(org.apache.james.imap.api.ImapCommand,
org.apache.james.imap.decode.ImapRequestLineReader, java.lang.String,
org.apache.james.imap.api.process.ImapSession)
+ */
+ protected ImapMessage decode(ImapCommand command, ImapRequestLineReader
request, String tag, ImapSession session) throws DecodingException {
+ String algorithm = atom(request);
+ endLine(request);
+ return new CompressRequest(tag, command, algorithm);
+ }
+
+}
Modified:
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/ImapParserFactory.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/ImapParserFactory.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/ImapParserFactory.java
(original)
+++
james/imap/trunk/message/src/main/java/org/apache/james/imap/decode/parser/ImapParserFactory.java
Sun Jan 16 18:43:40 2011
@@ -121,7 +121,12 @@ public class ImapParserFactory implement
// RFC3691
_imapCommands.put(ImapConstants.UNSELECT_COMMAND_NAME,
UnselectCommandParser.class);
+
+ // RFC4978
+ _imapCommands.put(ImapConstants.COMPRESS_COMMAND_NAME,
CompressCommandParser.class);
+
}
+
/**
* @see
org.apache.james.imap.decode.parser.ImapCommandParserFactory#getParser(java.lang.String)
Modified:
james/imap/trunk/message/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/message/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
(original)
+++
james/imap/trunk/message/src/main/java/org/apache/james/imap/main/ImapSessionImpl.java
Sun Jan 16 18:43:40 2011
@@ -164,4 +164,14 @@ public class ImapSessionImpl implements
public boolean supportStartTLS() {
return false;
}
+
+
+ public boolean IsCompressionSupported() {
+ return false;
+ }
+
+
+ public boolean startCompression() {
+ return false;
+ }
}
Added:
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CompressRequest.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CompressRequest.java?rev=1059631&view=auto
==============================================================================
---
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CompressRequest.java
(added)
+++
james/imap/trunk/message/src/main/java/org/apache/james/imap/message/request/CompressRequest.java
Sun Jan 16 18:43:40 2011
@@ -0,0 +1,35 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+package org.apache.james.imap.message.request;
+
+import org.apache.james.imap.api.ImapCommand;
+
+public class CompressRequest extends AbstractImapRequest{
+
+ private String algorithm;
+
+ public CompressRequest(String tag, ImapCommand command, String algorithm) {
+ super(tag, command);
+ this.algorithm = algorithm;
+ }
+
+ public String getAlgorithm() {
+ return algorithm;
+ }
+}
Modified:
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
(original)
+++
james/imap/trunk/message/src/test/java/org/apache/james/imap/encode/FakeImapSession.java
Sun Jan 16 18:43:40 2011
@@ -102,4 +102,12 @@ public class FakeImapSession implements
return false;
}
+ public boolean IsCompressionSupported() {
+ return false;
+ }
+
+ public boolean startCompression() {
+ return false;
+ }
+
}
Added:
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/CompressProcessor.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/CompressProcessor.java?rev=1059631&view=auto
==============================================================================
---
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/CompressProcessor.java
(added)
+++
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/CompressProcessor.java
Sun Jan 16 18:43:40 2011
@@ -0,0 +1,93 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+package org.apache.james.imap.processor;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.james.imap.api.ImapConstants;
+import org.apache.james.imap.api.ImapMessage;
+import org.apache.james.imap.api.display.HumanReadableText;
+import org.apache.james.imap.api.message.response.StatusResponseFactory;
+import org.apache.james.imap.api.process.ImapProcessor;
+import org.apache.james.imap.api.process.ImapSession;
+import org.apache.james.imap.message.request.CompressRequest;
+import org.apache.james.imap.processor.base.AbstractChainedProcessor;
+
+public class CompressProcessor extends AbstractChainedProcessor implements
CapabilityImplementingProcessor{
+ private final static String ALGO = "DEFLATE";
+ private final static List<String> CAPA =
Arrays.asList(ImapConstants.COMPRESS_COMMAND_NAME + "=" + ALGO);
+ private StatusResponseFactory factory;
+ private final static String COMPRESSED = "COMPRESSED";
+
+ public CompressProcessor(ImapProcessor next, final StatusResponseFactory
factory) {
+ super(next);
+ this.factory = factory;
+ }
+
+
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.processor.base.AbstractChainedProcessor#isAcceptable(org.apache.james.imap.api.ImapMessage)
+ */
+ protected boolean isAcceptable(ImapMessage message) {
+ return message instanceof CompressRequest;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.processor.base.AbstractChainedProcessor#doProcess(org.apache.james.imap.api.ImapMessage,
org.apache.james.imap.api.process.ImapProcessor.Responder,
org.apache.james.imap.api.process.ImapSession)
+ */
+ protected void doProcess(ImapMessage acceptableMessage, Responder
responder, ImapSession session) {
+ CompressRequest request = (CompressRequest) acceptableMessage;
+ if (session.isCompressionSupported()) {
+ boolean compressed = (Boolean) session.getAttribute(COMPRESSED);
+ if (compressed) {
+ responder.respond(factory.taggedNo(request.getTag(),
request.getCommand(), HumanReadableText.COMPRESS_ALREADY_ACTIVE));
+ } else {
+ if (request.getAlgorithm().equalsIgnoreCase(ALGO) == false) {
+ responder.respond(factory.taggedBad(request.getTag(),
request.getCommand(), HumanReadableText.ILLEGAL_ARGUMENTS));
+ } else {
+ if (session.startCompression()) {
+ session.setAttribute(COMPRESSED, true);
+ responder.respond(factory.taggedOk(request.getTag(),
request.getCommand(), HumanReadableText.DEFLATE_ACTIVE));
+ } else {
+
+ }
+ }
+ }
+ } else {
+ responder.respond(factory.taggedBad(request.getTag(),
request.getCommand(), HumanReadableText.INVALID_COMMAND));
+ }
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.processor.CapabilityImplementingProcessor#getImplementedCapabilities(org.apache.james.imap.api.process.ImapSession)
+ */
+ @SuppressWarnings("unchecked")
+ public List<String> getImplementedCapabilities(ImapSession session) {
+ if (session.isCompressionSupported()) {
+ return CAPA;
+ }
+ return Collections.EMPTY_LIST;
+ }
+
+}
Modified:
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/DefaultProcessorChain.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/DefaultProcessorChain.java?rev=1059631&r1=1059630&r2=1059631&view=diff
==============================================================================
---
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/DefaultProcessorChain.java
(original)
+++
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/DefaultProcessorChain.java
Sun Jan 16 18:43:40 2011
@@ -106,6 +106,7 @@ public class DefaultProcessorChain {
final UnselectProcessor unselectProcessor = new
UnselectProcessor(startTLSProcessor, mailboxManager, statusResponseFactory);
+ final CompressProcessor compressProcessor = new
CompressProcessor(unselectProcessor, statusResponseFactory);
capabilityProcessor.addProcessor(startTLSProcessor);
capabilityProcessor.addProcessor(idleProcessor);
capabilityProcessor.addProcessor(namespaceProcessor);
@@ -115,7 +116,10 @@ public class DefaultProcessorChain {
// announce the UNSELECT extension. See RFC3691
capabilityProcessor.addProcessor(unselectProcessor);
- return unselectProcessor;
+ // announce the COMPRESS extension. Sew RFC4978
+ capabilityProcessor.addProcessor(compressProcessor);
+
+ return compressProcessor;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
