JAMES-2037 Offer direct UID retrieval from MessageManager

mailbox/api/src/main/java/org/apache/james/mailbox/model/SearchQuery.java

@@ -740,18 +740,6 @@ public static Criterion flagIsUnSet(String flag) {
         return new CustomFlagCriterion(flag, BooleanOperator.unset());
     }
 
-    public SearchQuery() {
-        this(new ArrayList<Criterion>());
-    }
-
-    public SearchQuery(Criterion... criteria) {
-        this(ImmutableList.copyOf(criteria));
-    }
-
-    public SearchQuery(List<Criterion> criterias) {
-        this.criterias = criterias;
-    }
-
     /**
      * Creates a filter matching all messages.
      * 
@@ -767,6 +755,18 @@ public static Criterion all() {
 
     private List<Sort> sorts = Collections.singletonList(new Sort(Sort.SortClause.Uid, Sort.Order.NATURAL));
 
+    public SearchQuery(Criterion... criterias) {
+        this(new ArrayList<Criterion>(Arrays.asList(criterias)));
+    }
+
+    public SearchQuery() {
+        this(new ArrayList<Criterion>());
+    }
+
+    private SearchQuery(List<Criterion> criterias) {
+        this.criterias = criterias;
+    }
+
     public void andCriteria(Criterion crit) {
         criterias.add(crit);
     }
@@ -827,12 +827,12 @@ public String toString() {
     }
 
     @Override
-    public int hashCode() {
+    public final int hashCode() {
         return Objects.hashCode(criterias);
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public final boolean equals(Object obj) {
         if (obj instanceof SearchQuery) {
             SearchQuery that = (SearchQuery) obj;
 

mailbox/api/src/test/java/org/apache/james/mailbox/model/SearchQueryTest.java

@@ -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.mailbox.model;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.Test;
+
+import nl.jqno.equalsverifier.EqualsVerifier;
+
+public class SearchQueryTest {
+
+    @Test
+    public void searchQueryShouldRespectBeanContract() {
+        EqualsVerifier.forClass(SearchQuery.class).verify();
+    }
+
+    @Test
+    public void equalsShouldCompareCriteria() {
+        SearchQuery searchQuery1 = new SearchQuery();
+        SearchQuery searchQuery2 = new SearchQuery();
+        searchQuery1.andCriteria(SearchQuery.all());
+        searchQuery2.andCriteria(SearchQuery.all());
+
+        assertThat(searchQuery1).isEqualTo(searchQuery2);
+    }
+
+}

mailbox/caching/src/main/java/org/apache/james/mailbox/caching/CachingMessageMapper.java

@@ -34,6 +34,11 @@ public CachingMessageMapper(MessageMapper underlying, MailboxMetadataCache cache
         this.cache = cache;
     }
 
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException {
+        return underlying.listAllMessageUids(mailbox);
+    }
+
     @Override
     public void endRequest() {
         underlying.endRequest();

mailbox/cassandra/src/main/java/org/apache/james/mailbox/cassandra/mail/CassandraMessageMapper.java

@@ -107,6 +107,15 @@ public CassandraMessageMapper(CassandraUidProvider uidProvider, CassandraModSeqP
         this.deletedMessageDAO = deletedMessageDAO;
     }
 
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException {
+        CassandraId cassandraId = (CassandraId) mailbox.getMailboxId();
+        return messageIdDAO.retrieveMessages(cassandraId, MessageRange.all())
+            .join()
+            .map(metaData -> metaData.getComposedMessageId().getUid())
+            .iterator();
+    }
+
     @Override
     public long countMessagesInMailbox(Mailbox mailbox) throws MailboxException {
         return mailboxCounterDAO.countMessagesInMailbox(mailbox)

mailbox/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessageMapper.java

@@ -48,6 +48,7 @@
 import java.util.List;
 import java.util.Map;
 
+import javax.annotation.Nullable;
 import javax.mail.Flags;
 
 import org.apache.hadoop.conf.Configuration;
@@ -85,8 +86,10 @@
 import org.apache.james.mailbox.store.mail.utils.ApplicableFlagCalculator;
 import org.apache.james.mailbox.store.transaction.NonTransactionalMapper;
 
+import com.google.common.base.Function;
 import com.google.common.base.Optional;
 import com.google.common.collect.Iterables;
+import com.google.common.collect.Iterators;
 
 /**
  * HBase implementation of a {@link MessageMapper}.
@@ -95,6 +98,14 @@
  */
 public class HBaseMessageMapper extends NonTransactionalMapper implements MessageMapper {
 
+    private static final int UNLIMITED = -1;
+    private static final Function<MailboxMessage, MessageUid> TO_UID = new Function<MailboxMessage, MessageUid>() {
+        @Override
+        public MessageUid apply(MailboxMessage mailboxMessage) {
+            return mailboxMessage.getUid();
+        }
+    };
+
     private final Configuration conf;
     private final MailboxSession mailboxSession;
     private final UidProvider uidProvider;
@@ -121,6 +132,11 @@ public MailboxCounters getMailboxCounters(Mailbox mailbox) throws MailboxExcepti
             .build();
     }
 
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(final Mailbox mailbox) throws MailboxException {
+        return Iterators.transform(findInMailbox(mailbox, MessageRange.all(), FetchType.Full, UNLIMITED), TO_UID);
+    }
+
     @Override
     public void endRequest() {
     }

mailbox/jpa/src/main/java/org/apache/james/mailbox/jpa/mail/JPAMessageMapper.java

@@ -55,14 +55,24 @@
 import org.apache.james.mailbox.store.mail.utils.ApplicableFlagCalculator;
 import org.apache.openjpa.persistence.ArgumentException;
 
+import com.google.common.base.Function;
 import com.google.common.base.Optional;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Iterators;
 
 /**
  * JPA implementation of a {@link MessageMapper}. This class is not thread-safe!
  */
 public class JPAMessageMapper extends JPATransactionalMapper implements MessageMapper {
     private static final int UNLIMIT_MAX_SIZE = -1;
+    private static final int UNLIMITED = -1;
+    private static final Function<MailboxMessage, MessageUid> TO_UID = new Function<MailboxMessage, MessageUid>() {
+        @Override
+        public MessageUid apply(MailboxMessage mailboxMessage) {
+            return mailboxMessage.getUid();
+        }
+    };
+
     private final MessageUtils messageMetadataMapper;
 
     public JPAMessageMapper(MailboxSession mailboxSession, UidProvider uidProvider, ModSeqProvider modSeqProvider, EntityManagerFactory entityManagerFactory) {
@@ -78,6 +88,11 @@ public MailboxCounters getMailboxCounters(Mailbox mailbox) throws MailboxExcepti
             .build();
     }
 
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(final Mailbox mailbox) throws MailboxException {
+        return Iterators.transform(findInMailbox(mailbox, MessageRange.all(), FetchType.Full, UNLIMITED), TO_UID);
+    }
+
     /**
      * @see org.apache.james.mailbox.store.mail.MessageMapper#findInMailbox(org.apache.james.mailbox.store.mail.model.Mailbox,
      *      org.apache.james.mailbox.model.MessageRange,

mailbox/jpa/src/test/java/org/apache/james/mailbox/jpa/mail/TransactionalMessageMapper.java

@@ -58,6 +58,11 @@ public MailboxCounters getMailboxCounters(Mailbox mailbox) throws MailboxExcepti
             .build();
     }
 
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException {
+        return messageMapper.listAllMessageUids(mailbox);
+    }
+
     @Override
     public <T> T execute(Transaction<T> transaction) throws MailboxException {
         throw new NotImplementedException();

mailbox/store/src/main/java/org/apache/james/mailbox/store/StoreMessageManager.java

@@ -748,6 +748,9 @@ public Map<MessageUid, MessageMetaData> run() throws MailboxException {
 
     @Override
     public Iterator<MessageUid> search(SearchQuery query, MailboxSession mailboxSession) throws MailboxException {
+        if (query.equals(new SearchQuery(SearchQuery.all()))) {
+            return listAllMessageUids(mailboxSession);
+        }
         return index.search(mailboxSession, getMailboxEntity(), query);
     }
 
@@ -872,4 +875,15 @@ public Flags getApplicableFlags(MailboxSession session) throws MailboxException
         return mapperFactory.getMessageMapper(session)
             .getApplicableFlag(mailbox);
     }
+
+    private Iterator<MessageUid> listAllMessageUids(MailboxSession session) throws MailboxException {
+        final MessageMapper messageMapper = mapperFactory.getMessageMapper(session);
+
+        return messageMapper.execute(new Mapper.Transaction<Iterator<MessageUid>>() {
+            @Override
+            public Iterator<MessageUid> run() throws MailboxException {
+                return messageMapper.listAllMessageUids(mailbox);
+            }
+        });
+    }
 }

mailbox/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractMessageMapper.java

@@ -36,14 +36,25 @@
 import org.apache.james.mailbox.store.mail.model.MailboxMessage;
 import org.apache.james.mailbox.store.transaction.TransactionalMapper;
 
+import com.google.common.base.Function;
 import com.google.common.base.Optional;
+import com.google.common.collect.Iterators;
 
 /**
  * Abstract base class for {@link MessageMapper} implementation
  * which already takes care of most uid / mod-seq handling.
  *
  */
 public abstract class AbstractMessageMapper extends TransactionalMapper implements MessageMapper {
+    private static final Function<MailboxMessage, MessageUid> TO_UID = new Function<MailboxMessage, MessageUid>() {
+        @Override
+        public MessageUid apply(MailboxMessage input) {
+            return input.getUid();
+        }
+    };
+
+    private static final int UNLIMITED = -1;
+
     protected final MailboxSession mailboxSession;
     private final UidProvider uidProvider;
     private final ModSeqProvider modSeqProvider;
@@ -145,5 +156,9 @@ public MessageMetaData copy(Mailbox mailbox, MailboxMessage original) throws Mai
      * Copy the MailboxMessage to the Mailbox, using the given uid and modSeq for the new MailboxMessage
      */
     protected abstract MessageMetaData copy(Mailbox mailbox, MessageUid uid, long modSeq, MailboxMessage original) throws MailboxException;
-
+
+    @Override
+    public Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException {
+        return Iterators.transform(findInMailbox(mailbox, MessageRange.all(), FetchType.Metadata, UNLIMITED), TO_UID);
+    }
 }

mailbox/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java

@@ -172,6 +172,11 @@ Iterator<UpdatedFlags> updateFlags(Mailbox mailbox, FlagsUpdateCalculator flagsU
 
     Flags getApplicableFlag(Mailbox mailbox) throws MailboxException;
 
+    /**
+     * Return a list containing all MessageUid of Messages that belongs to given {@link Mailbox}
+     */
+    Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException;
+
     /**
      * Specify what data needs to get filled in a {@link MailboxMessage} before returning it
      * 

mailbox/store/src/test/java/org/apache/james/mailbox/store/AbstractCombinationManagerTest.java

@@ -377,8 +377,7 @@ public void appendMessageFromMessageManagerAndSetInMailboxFromMessageIdManagerSh
         messageIdManager.setInMailboxes(messageId, ImmutableList.of(mailbox1.getMailboxId(), mailbox2.getMailboxId()), session);
 
         Flags expected = ApplicableFlagBuilder
-            .builder()
-            .add(messageFlag)
+            .from(messageFlag)
             .build();
 
         assertThat(messageManager1.getApplicableFlags(session))
@@ -405,8 +404,8 @@ public void appendMessageFromMessageManagerAndSetFlagsFromMessageIdManagerShould
         messageIdManager.setFlags(deleted, FlagsUpdateMode.ADD, messageId, ImmutableList.of(mailbox1.getMailboxId()), session);
 
         assertThat(messageManager1.getApplicableFlags(session))
-            .isEqualTo(ApplicableFlagBuilder.builder()
-                .add(USER_FLAGS_VALUE, ANOTHER_USER_FLAGS_VALUE)
+            .isEqualTo(ApplicableFlagBuilder
+                .from(USER_FLAGS_VALUE, ANOTHER_USER_FLAGS_VALUE)
                 .build());
     }
 
@@ -422,9 +421,8 @@ public void setFlagsFromMessageManagerAndSetFlagsFromMessageIdManagerShouldUpdat
         Flags applicableFlags = messageManager1.getApplicableFlags(session);
 
         assertThat(applicableFlags)
-            .isEqualTo(ApplicableFlagBuilder.builder()
-                .add(customFlag1)
-                .add(customFlag2)
+            .isEqualTo(ApplicableFlagBuilder
+                .from(customFlag1, customFlag2)
                 .build());
     }
 
@@ -437,15 +435,44 @@ public void setInMailboxFromMessageIdManagerAndSetFlagsFromMessageManagerShouldU
         messageIdManager.setInMailboxes(messageId, ImmutableList.of(mailbox1.getMailboxId(), mailbox2.getMailboxId()), session);
         messageManager2.setFlags(custom2, FlagsUpdateMode.ADD, MessageRange.all(), session);
 
-        Flags expected = ApplicableFlagBuilder.builder()
-            .add(custom1)
-            .add(custom2)
+        Flags expected = ApplicableFlagBuilder
+            .from(custom1, custom2)
             .build();
 
         assertThat(messageManager2.getApplicableFlags(session))
             .isEqualTo(expected);
     }
 
+    @Test
+    public void getUidsShouldInteractWellWithSetInMailboxes() throws Exception {
+        MessageId messageId = messageManager1.appendMessage(new ByteArrayInputStream(MAIL_CONTENT), new Date(), session, false, new Flags())
+            .getMessageId();
+
+        messageIdManager.setInMailboxes(messageId, ImmutableList.of(mailbox1.getMailboxId(), mailbox2.getMailboxId()), session);
+
+        List<MessageResult> listMessages = messageIdManager.getMessages(ImmutableList.of(messageId), FetchGroupImpl.MINIMAL, session);
+        MessageUid uid2 = FluentIterable.from(listMessages)
+            .filter(messageInMailbox2())
+            .get(0)
+            .getUid();
+
+        SearchQuery searchQuery = new SearchQuery(SearchQuery.all());
+        assertThat(messageManager2.search(searchQuery, session))
+            .hasSize(1)
+            .containsOnly(uid2);
+    }
+
+    @Test
+    public void getUidsShouldInteractWellWithDelete() throws Exception {
+        MessageId messageId = messageManager1.appendMessage(new ByteArrayInputStream(MAIL_CONTENT), new Date(), session, false, new Flags())
+            .getMessageId();
+
+        messageIdManager.delete(messageId, ImmutableList.of(mailbox1.getMailboxId()), session);
+
+        SearchQuery searchQuery = new SearchQuery(SearchQuery.all());
+        assertThat(messageManager1.search(searchQuery, session)).isEmpty();
+    }
+
     private Predicate<MessageResult> messageInMailbox2() {
         return new Predicate<MessageResult>() {
             @Override

mailbox/store/src/test/java/org/apache/james/mailbox/store/StoreMailboxMessageResultIteratorTest.java

@@ -76,7 +76,12 @@ private final class TestMessageMapper implements MessageMapper {
         public TestMessageMapper(MessageRange messageRange) {
             this.messageRange = messageRange;
         }
-
+
+        @Override
+        public Iterator<MessageUid> listAllMessageUids(Mailbox mailbox) throws MailboxException {
+            return messageRange.iterator();
+        }
+
         @Override
         public void endRequest() {
             throw new UnsupportedOperationException();