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 ad...@apache.org on 2016/11/10 07:34:33 UTC

[05/10] james-project git commit: MAILBOX-270: mailbox API defines the quota, data size of at least 1024 and number of annotations at least 10

MAILBOX-270: mailbox API defines the quota, data size of at least 1024 and number of annotations at least 10


Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/32ac285e
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/32ac285e
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/32ac285e

Branch: refs/heads/master
Commit: 32ac285e6436f04b285bef7c09794c0cec3e2910
Parents: a746736
Author: Quynh Nguyen <qn...@linagora.com>
Authored: Mon Sep 12 11:07:54 2016 +0700
Committer: Quynh Nguyen <qn...@linagora.com>
Committed: Wed Nov 9 11:39:49 2016 +0700

----------------------------------------------------------------------
 .../apache/james/mailbox/MailboxManager.java    |  7 ++-
 .../mailbox/exception/AnnotationException.java  | 34 +++++++++++
 .../james/mailbox/model/MailboxAnnotation.java  |  1 -
 .../james/mailbox/model/MailboxConstants.java   |  6 ++
 .../james/mailbox/MailboxManagerTest.java       | 62 +++++++++++++++++---
 5 files changed, 101 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/james-project/blob/32ac285e/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
----------------------------------------------------------------------
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
index 6dc1335..2c5d33f 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
@@ -25,6 +25,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import org.apache.james.mailbox.exception.AnnotationException;
 import org.apache.james.mailbox.exception.BadCredentialsException;
 import org.apache.james.mailbox.exception.MailboxException;
 import org.apache.james.mailbox.exception.MailboxExistsException;
@@ -442,7 +443,11 @@ public interface MailboxManager extends RequestAware, MailboxListenerSupport {
      * @param mailboxAnnotations    the list of annotation should be insert/udpate/delete
      * @throws MailboxException in case of selected mailbox does not exist
      */
-    void updateAnnotations(MailboxPath mailboxPath, MailboxSession session, List<MailboxAnnotation> mailboxAnnotations) throws MailboxException;
+    void updateAnnotations(MailboxPath mailboxPath, MailboxSession session, List<MailboxAnnotation> mailboxAnnotations) throws MailboxException, AnnotationException;
     
     boolean hasChildren(MailboxPath mailboxPath, MailboxSession session) throws MailboxException;
+
+    void setLimitOfAnnotations(int limitOfAnnotations);
+
+    void setLimitAnnotationSize(int limitAnnotationSize);
 }

http://git-wip-us.apache.org/repos/asf/james-project/blob/32ac285e/mailbox/api/src/main/java/org/apache/james/mailbox/exception/AnnotationException.java
----------------------------------------------------------------------
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/AnnotationException.java b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/AnnotationException.java
new file mode 100644
index 0000000..8b10a0b
--- /dev/null
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/AnnotationException.java
@@ -0,0 +1,34 @@
+/****************************************************************
+ * 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.exception;
+
+public class AnnotationException extends MailboxException {
+    public AnnotationException() {
+        super();
+    }
+
+    public AnnotationException(String message) {
+        super(message);
+    }
+
+    public AnnotationException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

http://git-wip-us.apache.org/repos/asf/james-project/blob/32ac285e/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxAnnotation.java
----------------------------------------------------------------------
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxAnnotation.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxAnnotation.java
index 3fbfae0..9150d04 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxAnnotation.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxAnnotation.java
@@ -25,7 +25,6 @@ import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 
 public class MailboxAnnotation {
-
     public static MailboxAnnotation nil(MailboxAnnotationKey key) {
         return new MailboxAnnotation(key, Optional.<String> absent());
     }

http://git-wip-us.apache.org/repos/asf/james-project/blob/32ac285e/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
----------------------------------------------------------------------
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
index dd8660e..e146168 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
@@ -40,4 +40,10 @@ public interface MailboxConstants {
     /** The name of the INBOX */
     String INBOX = "INBOX";
 
+    /** The limitation of annotation data */
+    int DEFAULT_LIMIT_ANNOTATION_SIZE = 1024;
+
+    /** The maximum number of annotations on a mailbox */
+    int DEFAULT_LIMIT_ANNOTATIONS_ON_MAILBOX = 10;
+
 }

http://git-wip-us.apache.org/repos/asf/james-project/blob/32ac285e/mailbox/api/src/test/java/org/apache/james/mailbox/MailboxManagerTest.java
----------------------------------------------------------------------
diff --git a/mailbox/api/src/test/java/org/apache/james/mailbox/MailboxManagerTest.java b/mailbox/api/src/test/java/org/apache/james/mailbox/MailboxManagerTest.java
index b578d28..3b3a313 100644
--- a/mailbox/api/src/test/java/org/apache/james/mailbox/MailboxManagerTest.java
+++ b/mailbox/api/src/test/java/org/apache/james/mailbox/MailboxManagerTest.java
@@ -28,10 +28,16 @@ import java.util.List;
 import javax.mail.Flags;
 
 import org.apache.james.mailbox.MailboxManager.MailboxCapabilities;
+import org.apache.james.mailbox.exception.AnnotationException;
 import org.apache.james.mailbox.exception.BadCredentialsException;
 import org.apache.james.mailbox.exception.MailboxException;
 import org.apache.james.mailbox.mock.MockMailboxManager;
-import org.apache.james.mailbox.model.*;
+import org.apache.james.mailbox.model.MailboxAnnotation;
+import org.apache.james.mailbox.model.MailboxAnnotationKey;
+import org.apache.james.mailbox.model.MailboxConstants;
+import org.apache.james.mailbox.model.MailboxMetaData;
+import org.apache.james.mailbox.model.MailboxPath;
+import org.apache.james.mailbox.model.MailboxQuery;
 import org.junit.After;
 import org.junit.Assume;
 import org.junit.Rule;
@@ -45,7 +51,7 @@ import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 
 /**
- * Test the {@link StoreMailboxManager} methods that 
+ * Test the {@link StoreMailboxManager} methods that
  * are not covered by the protocol-tester suite.
  * 
  * This class needs to be extended by the different mailbox 
@@ -273,8 +279,8 @@ public class MailboxManagerTest<T extends MailboxManager> {
 
     @ContractTest
     public void updateAnnotationsShouldThrowExceptionIfMailboxDoesNotExist() throws MailboxException {
-        expected.expect(MailboxException.class);
         Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(MailboxException.class);
         session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
         MailboxPath inbox = MailboxPath.inbox(session);
 
@@ -305,8 +311,8 @@ public class MailboxManagerTest<T extends MailboxManager> {
 
     @ContractTest
     public void getAllAnnotationsShouldThrowExceptionIfMailboxDoesNotExist() throws MailboxException {
-        expected.expect(MailboxException.class);
         Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(MailboxException.class);
         session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
         MailboxPath inbox = MailboxPath.inbox(session);
 
@@ -328,8 +334,8 @@ public class MailboxManagerTest<T extends MailboxManager> {
 
     @ContractTest
     public void getAnnotationsByKeysShouldThrowExceptionIfMailboxDoesNotExist() throws MailboxException {
-        expected.expect(MailboxException.class);
         Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(MailboxException.class);
         session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
         MailboxPath inbox = MailboxPath.inbox(session);
 
@@ -351,8 +357,8 @@ public class MailboxManagerTest<T extends MailboxManager> {
 
     @ContractTest
     public void getAnnotationsByKeysWithAllDepthShouldThrowExceptionWhenMailboxDoesNotExist() throws BadCredentialsException, MailboxException {
-        expected.expect(MailboxException.class);
         Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(MailboxException.class);
         session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
         MailboxPath inbox = MailboxPath.inbox(session);
 
@@ -372,4 +378,46 @@ public class MailboxManagerTest<T extends MailboxManager> {
             .contains(PRIVATE_ANNOTATION, PRIVATE_CHILD_ANNOTATION, PRIVATE_GRANDCHILD_ANNOTATION);
     }
 
-}
+    @ContractTest
+    public void updateAnnotationsShouldThrowExceptionIfAnnotationDataIsOverLimitation() throws MailboxException {
+        Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(AnnotationException.class);
+        session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
+        MailboxPath inbox = MailboxPath.inbox(session);
+        mailboxManager.createMailbox(inbox, session);
+        mailboxManager.setLimitAnnotationSize(10);
+
+        mailboxManager.updateAnnotations(inbox, session, ImmutableList.of(MailboxAnnotation.newInstance(PRIVATE_KEY, "DataMoreThan10")));
+    }
+
+    @ContractTest
+    public void shouldUpdateAnnotationWhenRequestCreatesNewAndMailboxIsNotOverLimit() throws MailboxException {
+        Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
+        MailboxPath inbox = MailboxPath.inbox(session);
+        mailboxManager.createMailbox(inbox, session);
+        mailboxManager.setLimitOfAnnotations(2);
+
+        ImmutableList.Builder<MailboxAnnotation> builder = ImmutableList.builder();
+        builder.add(MailboxAnnotation.newInstance(new MailboxAnnotationKey("/private/comment1"), "AnyValue"));
+        builder.add(MailboxAnnotation.newInstance(new MailboxAnnotationKey("/private/comment2"), "AnyValue"));
+
+        mailboxManager.updateAnnotations(inbox, session, builder.build());
+    }
+
+    @ContractTest
+    public void updateAnnotationsShouldThrowExceptionIfRequestCreateNewButMailboxIsOverLimit() throws MailboxException {
+        Assume.assumeTrue(mailboxManager.hasCapability(MailboxCapabilities.Annotation));
+        expected.expect(MailboxException.class);
+        session = mailboxManager.createSystemSession(USER_2, LoggerFactory.getLogger("Test"));
+        MailboxPath inbox = MailboxPath.inbox(session);
+        mailboxManager.createMailbox(inbox, session);
+        mailboxManager.setLimitOfAnnotations(2);
+
+        ImmutableList.Builder<MailboxAnnotation> builder = ImmutableList.builder();
+        builder.add(MailboxAnnotation.newInstance(new MailboxAnnotationKey("/private/comment1"), "AnyValue"));
+        builder.add(MailboxAnnotation.newInstance(new MailboxAnnotationKey("/private/comment2"), "AnyValue"));
+        builder.add(MailboxAnnotation.newInstance(new MailboxAnnotationKey("/private/comment3"), "AnyValue"));
+
+        mailboxManager.updateAnnotations(inbox, session, builder.build());
+    }}


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org