JAMES-2541 Abstract the Id required by the Store API

server/blob/blob-api/src/main/java/org/apache/james/blob/api/BlobPartsId.java

@@ -0,0 +1,30 @@
+/****************************************************************
+ * 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.blob.api;
+
+import java.util.Map;
+
+public interface BlobPartsId {
+    interface Factory<I extends BlobPartsId> {
+        I generate(Map<Store.BlobType, BlobId> map);
+    }
+
+    Map<Store.BlobType, BlobId> asMap();
+}

server/blob/blob-api/src/main/java/org/apache/james/blob/api/Store.java

@@ -20,8 +20,6 @@
 package org.apache.james.blob.api;
 
 import java.io.InputStream;
-import java.util.Collection;
-import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Stream;
@@ -31,7 +29,12 @@
 
 import com.google.common.collect.ImmutableMap;
 
-public interface Store<T> {
+public interface Store<T, I> {
+
+    CompletableFuture<I> save(T t);
+
+    CompletableFuture<T> read(I blobIds);
+
     class BlobType {
         private final String name;
 
@@ -59,38 +62,36 @@ public final int hashCode() {
         }
     }
 
-    interface Encoder<T> {
-        Stream<Pair<BlobType, InputStream>> encode(T t);
-    }
-
-    interface Decoder<T> {
-        void validateInput(Collection<BlobType> input);
+    class Impl<T, I extends BlobPartsId> implements Store<T, I> {
 
-        T decode(Stream<Pair<BlobType, byte[]>> streams);
-    }
-
-    CompletableFuture<Map<BlobType, BlobId>> save(T t);
+        public interface Encoder<T> {
+            Stream<Pair<BlobType, InputStream>> encode(T t);
+        }
 
-    CompletableFuture<T> read(Map<BlobType, BlobId> blobIds);
+        public interface Decoder<T> {
+            T decode(Stream<Pair<BlobType, byte[]>> streams);
+        }
 
-    class Impl<T> implements Store<T> {
+        private final BlobPartsId.Factory<I> idFactory;
         private final Encoder<T> encoder;
         private final Decoder<T> decoder;
         private final BlobStore blobStore;
 
-        public Impl(Encoder<T> encoder, Decoder<T> decoder, BlobStore blobStore) {
+        public Impl(BlobPartsId.Factory<I> idFactory, Encoder<T> encoder, Decoder<T> decoder, BlobStore blobStore) {
+            this.idFactory = idFactory;
             this.encoder = encoder;
             this.decoder = decoder;
             this.blobStore = blobStore;
         }
 
         @Override
-        public CompletableFuture<Map<BlobType, BlobId>> save(T t) {
+        public CompletableFuture<I> save(T t) {
             return FluentFutureStream.of(
                 encoder.encode(t)
                     .map(this::saveEntry))
                 .completableFuture()
-                .thenApply(pairStream -> pairStream.collect(ImmutableMap.toImmutableMap(Pair::getKey, Pair::getValue)));
+                .thenApply(pairStream -> pairStream.collect(ImmutableMap.toImmutableMap(Pair::getKey, Pair::getValue)))
+                .thenApply(idFactory::generate);
         }
 
         private CompletableFuture<Pair<BlobType, BlobId>> saveEntry(Pair<BlobType, InputStream> entry) {
@@ -99,10 +100,9 @@ private CompletableFuture<Pair<BlobType, BlobId>> saveEntry(Pair<BlobType, Input
         }
 
         @Override
-        public CompletableFuture<T> read(Map<BlobType, BlobId> blobIds) {
-            decoder.validateInput(blobIds.keySet());
-
-            CompletableFuture<Stream<Pair<BlobType, byte[]>>> binaries = FluentFutureStream.of(blobIds.entrySet()
+        public CompletableFuture<T> read(I blobIds) {
+            CompletableFuture<Stream<Pair<BlobType, byte[]>>> binaries = FluentFutureStream.of(blobIds.asMap()
+                .entrySet()
                 .stream()
                 .map(entry -> blobStore.readBytes(entry.getValue())
                     .thenApply(bytes -> Pair.of(entry.getKey(), bytes))))

server/blob/mail-store/src/main/java/org/apache/james/blob/mail/MimeMessagePartsId.java

@@ -0,0 +1,102 @@
+/****************************************************************
+ * 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.blob.mail;
+
+import java.util.Map;
+
+import org.apache.james.blob.api.BlobId;
+import org.apache.james.blob.api.BlobPartsId;
+import org.apache.james.blob.api.Store;
+
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableMap;
+
+public class MimeMessagePartsId implements BlobPartsId {
+    @FunctionalInterface
+    public interface RequireHeaderBlobId {
+        RequireBodyBlobId headerBlobId(BlobId headerBlobId);
+    }
+
+    @FunctionalInterface
+    public interface RequireBodyBlobId {
+        Builder bodyBlobId(BlobId bodyBlobId);
+    }
+
+    public static class Builder {
+        private final BlobId headerBlobId;
+        private final BlobId bodyBlobId;
+
+        private Builder(BlobId headerBlobId, BlobId bodyBlobId) {
+            Preconditions.checkNotNull(headerBlobId, "'headerBlobId' should not be null");
+            Preconditions.checkNotNull(bodyBlobId, "'bodyBlobId' should not be null");
+
+            this.headerBlobId = headerBlobId;
+            this.bodyBlobId = bodyBlobId;
+        }
+
+        public MimeMessagePartsId build() {
+            return new MimeMessagePartsId(headerBlobId, bodyBlobId);
+        }
+    }
+
+    public static RequireHeaderBlobId builder() {
+        return headerBlobId -> bodyBlobId -> new Builder(headerBlobId, bodyBlobId);
+    }
+
+    public static class Factory implements BlobPartsId.Factory<MimeMessagePartsId> {
+        @Override
+        public MimeMessagePartsId generate(Map<Store.BlobType, BlobId> map) {
+            Preconditions.checkArgument(map.keySet().contains(HEADER_BLOB_TYPE), "Expecting 'mailHeader' blobId to be specified");
+            Preconditions.checkArgument(map.keySet().contains(BODY_BLOB_TYPE), "Expecting 'mailBody' blobId to be specified");
+            Preconditions.checkArgument(map.size() == 2, "blobId other than 'mailHeader' or 'mailBody' are not supported");
+
+            return builder()
+                .headerBlobId(map.get(HEADER_BLOB_TYPE))
+                .bodyBlobId(map.get(BODY_BLOB_TYPE))
+                .build();
+        }
+    }
+
+    static final Store.BlobType HEADER_BLOB_TYPE = new Store.BlobType("mailHeader");
+    static final Store.BlobType BODY_BLOB_TYPE = new Store.BlobType("mailBody");
+
+    private final BlobId headerBlobId;
+    private final BlobId bodyBlobId;
+
+    private MimeMessagePartsId(BlobId headerBlobId, BlobId bodyBlobId) {
+        this.headerBlobId = headerBlobId;
+        this.bodyBlobId = bodyBlobId;
+    }
+
+    @Override
+    public Map<Store.BlobType, BlobId> asMap() {
+        return ImmutableMap.of(
+            HEADER_BLOB_TYPE, headerBlobId,
+            BODY_BLOB_TYPE, bodyBlobId);
+    }
+
+    public BlobId getHeaderBlobId() {
+        return headerBlobId;
+    }
+
+    public BlobId getBodyBlobId() {
+        return bodyBlobId;
+    }
+}

server/blob/mail-store/src/main/java/org/apache/james/blob/mail/MimeMessageStore.java

@@ -20,14 +20,15 @@
 package org.apache.james.blob.mail;
 
 import static org.apache.commons.io.output.NullOutputStream.NULL_OUTPUT_STREAM;
+import static org.apache.james.blob.mail.MimeMessagePartsId.BODY_BLOB_TYPE;
+import static org.apache.james.blob.mail.MimeMessagePartsId.HEADER_BLOB_TYPE;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.SequenceInputStream;
 import java.nio.ByteBuffer;
-import java.util.Collection;
 import java.util.Map;
 import java.util.Properties;
 import java.util.stream.Stream;
@@ -48,8 +49,6 @@
 import com.google.common.collect.ImmutableMap;
 
 public class MimeMessageStore {
-    public static final Store.BlobType HEADER_BLOB_TYPE = new Store.BlobType("mailHeader");
-    public static final Store.BlobType BODY_BLOB_TYPE = new Store.BlobType("mailBody");
 
     public static class Factory {
         private final BlobStore blobStore;
@@ -59,15 +58,16 @@ public Factory(BlobStore blobStore) {
             this.blobStore = blobStore;
         }
 
-        public Store<MimeMessage> mimeMessageStore() {
+        public Store<MimeMessage, MimeMessagePartsId> mimeMessageStore() {
             return new Store.Impl<>(
+                new MimeMessagePartsId.Factory(),
                 new MailEncoder(),
                 new MailDecoder(),
                 blobStore);
         }
     }
 
-    static class MailEncoder implements Store.Encoder<MimeMessage> {
+    static class MailEncoder implements Store.Impl.Encoder<MimeMessage> {
         @Override
         public Stream<Pair<BlobType, InputStream>> encode(MimeMessage message) {
             try {
@@ -124,14 +124,7 @@ private static void consume(InputStream in) throws IOException {
         }
     }
 
-    static class MailDecoder implements Store.Decoder<MimeMessage> {
-        @Override
-        public void validateInput(Collection<BlobType> input) {
-            Preconditions.checkArgument(input.contains(HEADER_BLOB_TYPE), "Expecting 'mailHeader' blobId to be specified");
-            Preconditions.checkArgument(input.contains(BODY_BLOB_TYPE), "Expecting 'mailBody' blobId to be specified");
-            Preconditions.checkArgument(input.size() == 2, "blobId other than 'mailHeader' or 'mailBody' are not supported");
-        }
-
+    static class MailDecoder implements Store.Impl.Decoder<MimeMessage> {
         @Override
         public MimeMessage decode(Stream<Pair<BlobType, byte[]>> streams) {
             Preconditions.checkNotNull(streams);

server/blob/mail-store/src/test/java/org/apache/james/blob/mail/MimeMessageStoreTest.java

@@ -23,7 +23,6 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import java.nio.charset.StandardCharsets;
-import java.util.Map;
 
 import javax.mail.internet.MimeMessage;
 
@@ -37,12 +36,11 @@
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.testcontainers.shaded.com.google.common.collect.ImmutableMap;
 
 class MimeMessageStoreTest {
     private static final HashBlobId.Factory BLOB_ID_FACTORY = new HashBlobId.Factory();
 
-    private Store<MimeMessage> testee;
+    private Store<MimeMessage, MimeMessagePartsId> testee;
     private BlobStore blobStore;
 
     @BeforeEach
@@ -63,29 +61,6 @@ void readShouldThrowWhenNull() {
             .isInstanceOf(NullPointerException.class);
     }
 
-    @Test
-    void readShouldThrowWhenMissingHeaderBlobs() {
-        assertThatThrownBy(() -> testee.read(ImmutableMap.of(
-            MimeMessageStore.HEADER_BLOB_TYPE, BLOB_ID_FACTORY.randomId())))
-            .isInstanceOf(IllegalArgumentException.class);
-    }
-
-    @Test
-    void readShouldThrowWhenMissingBodyBlobs() {
-        assertThatThrownBy(() -> testee.read(ImmutableMap.of(
-            MimeMessageStore.BODY_BLOB_TYPE, BLOB_ID_FACTORY.randomId())))
-            .isInstanceOf(IllegalArgumentException.class);
-    }
-
-    @Test
-    void readShouldThrowWhenExtraBodyBlobs() {
-        assertThatThrownBy(() -> testee.read(ImmutableMap.of(
-            MimeMessageStore.BODY_BLOB_TYPE, BLOB_ID_FACTORY.randomId(),
-            MimeMessageStore.HEADER_BLOB_TYPE, BLOB_ID_FACTORY.randomId(),
-            new Store.BlobType("Unknown"), BLOB_ID_FACTORY.randomId())))
-            .isInstanceOf(IllegalArgumentException.class);
-    }
-
     @Test
     void mailStoreShouldPreserveContent() throws Exception {
         MimeMessage message = MimeMessageBuilder.mimeMessageBuilder()
@@ -95,7 +70,7 @@ void mailStoreShouldPreserveContent() throws Exception {
             .setText("Important mail content")
             .build();
 
-        Map<Store.BlobType, BlobId> parts = testee.save(message).join();
+        MimeMessagePartsId parts = testee.save(message).join();
 
         MimeMessage retrievedMessage = testee.read(parts).join();
 
@@ -111,7 +86,7 @@ void mailStoreShouldPreserveMailWithoutBody() throws Exception {
             .setSubject("Important Mail")
             .build();
 
-        Map<Store.BlobType, BlobId> parts = testee.save(message).join();
+        MimeMessagePartsId parts = testee.save(message).join();
 
         MimeMessage retrievedMessage = testee.read(parts).join();
 
@@ -130,14 +105,12 @@ void saveShouldSeparateHeadersAndBodyInDifferentBlobs() throws Exception {
             .setText("Important mail content")
             .build();
 
-        Map<Store.BlobType, BlobId> parts = testee.save(message).join();
+        MimeMessagePartsId parts = testee.save(message).join();
 
         SoftAssertions.assertSoftly(
             softly -> {
-                softly.assertThat(parts).containsKeys(MimeMessageStore.HEADER_BLOB_TYPE, MimeMessageStore.BODY_BLOB_TYPE);
-
-                BlobId headerBlobId = parts.get(MimeMessageStore.HEADER_BLOB_TYPE);
-                BlobId bodyBlobId = parts.get(MimeMessageStore.BODY_BLOB_TYPE);
+                BlobId headerBlobId = parts.getHeaderBlobId();
+                BlobId bodyBlobId = parts.getBodyBlobId();
 
                 softly.assertThat(new String(blobStore.readBytes(headerBlobId).join(), StandardCharsets.UTF_8))
                     .isEqualTo("Date: Thu, 6 Sep 2018 13:29:13 +0700 (ICT)\r\n" +