Update James Protocols POP3 with string based UIDL support. Added Base64

encoding for POP3 UIDL of UUID.

Author: Rustam Aliyev

modules/core/src/main/java/com/elasticinbox/core/utils/Base64UUIDUtils.java

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2011-2012 Optimax Software Ltd.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ *  * Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *  * Neither the name of Optimax Software, ElasticInbox, nor the names
+ *    of its contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.elasticinbox.core.utils;
+
+import java.util.UUID;
+
+import me.prettyprint.cassandra.utils.TimeUUIDUtils;
+
+import com.google.common.io.BaseEncoding;
+
+/**
+ * URL safe Base64 encoding/decoding of UUID
+ * <p>
+ * Produces a 22 character string which is a URL safe Base64 encoded UUID.
+ * </p>
+ * 
+ * @author Rustam Aliyev
+ */
+public class Base64UUIDUtils
+{
+	public static String encode(UUID uuid)
+	{
+		return BaseEncoding.base64Url().omitPadding()
+				.encode(TimeUUIDUtils.asByteArray(uuid));
+	}
+
+	public static UUID decode(String encoded64)
+	{
+		byte[] ba = BaseEncoding.base64Url().decode(encoded64);
+		return TimeUUIDUtils.toUUID(ba);
+	}
+}

modules/core/src/test/java/com/elasticinbox/core/utils/Base64UUIDUtilsTest.java

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2011-2012 Optimax Software Ltd.
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ *  * Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *  * Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *  * Neither the name of Optimax Software, ElasticInbox, nor the names
+ *    of its contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.elasticinbox.core.utils;
+
+import static org.junit.Assert.*;
+import static org.hamcrest.Matchers.*;
+
+import java.util.UUID;
+
+import org.junit.Test;
+
+public class Base64UUIDUtilsTest
+{
+	@Test
+	public void testBase64UUIDEncode() 
+	{
+		UUID uuid1 = UUID.randomUUID();
+		String uuidStr = Base64UUIDUtils.encode(uuid1);
+		UUID uuid2 = Base64UUIDUtils.decode(uuidStr);
+
+		assertThat(uuidStr, not(endsWith("==")));
+		assertThat(22, equalTo(uuidStr.length()));
+		assertThat(uuid2, equalTo(uuid1));
+	}
+}

modules/pop3/pom.xml

@@ -152,5 +152,4 @@
 		<scope>provided</scope>
 	</dependency>
   </dependencies>
-
 </project>

modules/pop3/src/main/java/com/elasticinbox/pop3/server/handler/ElasticInboxMailboxHandler.java

@@ -15,6 +15,7 @@
 import com.elasticinbox.core.model.Mailbox;
 import com.elasticinbox.core.model.Message;
 import com.elasticinbox.core.model.ReservedLabels;
+import com.elasticinbox.core.utils.Base64UUIDUtils;
 
 public class ElasticInboxMailboxHandler implements org.apache.james.protocols.pop3.mailbox.Mailbox 
 {
@@ -37,18 +38,18 @@ public ElasticInboxMailboxHandler(final MessageDAO dao, final String username)
 	}
 
 	@Override
-	public InputStream getMessageBody(long uid) throws IOException {
+	public InputStream getMessageBody(String uid) throws IOException {
 		return null;
 	}
 
 	@Override
-	public InputStream getMessageHeaders(long uid) throws IOException {
+	public InputStream getMessageHeaders(String uid) throws IOException {
 		// TODO Auto-generated method stub
 		return null;
 	}
 
 	@Override
-	public InputStream getMessage(long uid) throws IOException {
+	public InputStream getMessage(String uid) throws IOException {
 		// TODO Auto-generated method stub
 		return null;
 	}
@@ -63,15 +64,15 @@ public List<MessageMetaData> getMessages() throws IOException
 		// convert to James Protocols list
 		for (Map.Entry<UUID, Message> entry : messages.entrySet()) {
 			MessageMetaData md = new MessageMetaData(
-					entry.getKey().timestamp(), entry.getValue().getSize());
+					Base64UUIDUtils.encode(entry.getKey()), entry.getValue().getSize());
 			list.add(md);
 		}
 
 		return list;
 	}
 
 	@Override
-	public void remove(long... uids) throws IOException {
+	public void remove(String... uids) throws IOException {
 		logger.debug("POP3: Remove messages");
 	}
 

pom.xml

@@ -73,7 +73,7 @@
 	<bundle.javax-inject.version>1_1</bundle.javax-inject.version>
 	<bundle.guice.version>3.0</bundle.guice.version>
 	<bundle.gson.version>2.2.2</bundle.gson.version>
-	<bundle.guava.version>13.0.1</bundle.guava.version>
+	<bundle.guava.version>14.0-rc2</bundle.guava.version>
 	<bundle.aopalliance.version>1.0_5</bundle.aopalliance.version>
 	<bundle.net.oauth.version>20100527_1</bundle.net.oauth.version>
 	<bundle.jersey.version>1.16</bundle.jersey.version>
@@ -85,7 +85,7 @@
 	<bundle.commons-lang.version>2.6</bundle.commons-lang.version>
 	<bundle.servlet-api.version>2.5.20110712</bundle.servlet-api.version>
 	<bundle.netty.version>3.5.11.Final</bundle.netty.version>
-	<bundle.james-protocols.version>1.6.2</bundle.james-protocols.version>
+	<bundle.james-protocols.version>1.6.3-SNAPSHOT</bundle.james-protocols.version>
 	<bundle.snakeyaml.version>1.11</bundle.snakeyaml.version>
 
 	<!-- Profiling Configs -->
@@ -221,5 +221,15 @@
 			<id>sonatype</id>
 			<url>https://oss.sonatype.org/content/repositories/releases/</url>
 		</repository>
+		<repository>
+			<id>apache-snapshot</id>
+			<releases>
+				<enabled>false</enabled>
+			</releases>
+			<snapshots>
+				<enabled>true</enabled>
+			</snapshots>
+			<url>http://repository.apache.org/snapshots/</url>
+		</repository>
 	</repositories>
 </project>