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 ro...@apache.org on 2019/09/19 07:08:14 UTC
[james-project] 04/07: JAMES-2813 Add
DeletedMessagesVaultRestoreTaskDTO.AdditionalInformation serialization
This is an automated email from the ASF dual-hosted git repository.
rouazana pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 6948b81c766871d3b5ce7f1695b4c6430a9e03dd
Author: Gautier DI FOLCO <gd...@linagora.com>
AuthorDate: Tue Sep 3 18:17:50 2019 +0200
JAMES-2813 Add DeletedMessagesVaultRestoreTaskDTO.AdditionalInformation serialization
---
.../routes/DeletedMessagesVaultRestoreTask.java | 6 ++
...esVaultRestoreTaskAdditionalInformationDTO.java | 82 ++++++++++++++++++++++
...dMessagesVaultRestoreTaskSerializationTest.java | 34 ++++++---
3 files changed, 113 insertions(+), 9 deletions(-)
diff --git a/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTask.java b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTask.java
index ffe95d9..8803c67 100644
--- a/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTask.java
+++ b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTask.java
@@ -50,6 +50,12 @@ class DeletedMessagesVaultRestoreTask implements Task {
this.errorRestoreCount = new AtomicLong();
}
+ AdditionalInformation(User user, AtomicLong successfulRestoreCount, AtomicLong errorRestoreCount) {
+ this.user = user;
+ this.successfulRestoreCount = successfulRestoreCount;
+ this.errorRestoreCount = errorRestoreCount;
+ }
+
public long getSuccessfulRestoreCount() {
return successfulRestoreCount.get();
}
diff --git a/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskAdditionalInformationDTO.java b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskAdditionalInformationDTO.java
new file mode 100644
index 0000000..d7a7c41
--- /dev/null
+++ b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/main/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskAdditionalInformationDTO.java
@@ -0,0 +1,82 @@
+/**
+ * *************************************************************
+ * 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.webadmin.vault.routes;
+
+import java.util.concurrent.atomic.AtomicLong;
+
+import org.apache.james.core.User;
+import org.apache.james.json.DTOModule;
+import org.apache.james.server.task.json.dto.AdditionalInformationDTO;
+import org.apache.james.server.task.json.dto.AdditionalInformationDTOModule;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class DeletedMessagesVaultRestoreTaskAdditionalInformationDTO implements AdditionalInformationDTO {
+
+ private static DeletedMessagesVaultRestoreTaskAdditionalInformationDTO fromDomainObject(DeletedMessagesVaultRestoreTask.AdditionalInformation additionalInformation, String type) {
+ return new DeletedMessagesVaultRestoreTaskAdditionalInformationDTO(
+ additionalInformation.getUser(),
+ additionalInformation.getSuccessfulRestoreCount(),
+ additionalInformation.getErrorRestoreCount()
+ );
+ }
+
+ public static final AdditionalInformationDTOModule<DeletedMessagesVaultRestoreTask.AdditionalInformation, DeletedMessagesVaultRestoreTaskAdditionalInformationDTO> MODULE =
+ DTOModule
+ .forDomainObject(DeletedMessagesVaultRestoreTask.AdditionalInformation.class)
+ .convertToDTO(DeletedMessagesVaultRestoreTaskAdditionalInformationDTO.class)
+ .toDomainObjectConverter(DeletedMessagesVaultRestoreTaskAdditionalInformationDTO::toDomainObject)
+ .toDTOConverter(DeletedMessagesVaultRestoreTaskAdditionalInformationDTO::fromDomainObject)
+ .typeName(DeletedMessagesVaultRestoreTask.TYPE.asString())
+ .withFactory(AdditionalInformationDTOModule::new);
+
+ private final String user;
+ private final Long successfulRestoreCount;
+ private final Long errorRestoreCount;
+
+ public DeletedMessagesVaultRestoreTaskAdditionalInformationDTO(@JsonProperty("user") String user,
+ @JsonProperty("successfulRestoreCount") Long successfulRestoreCount,
+ @JsonProperty("errorRestoreCount") Long errorRestoreCount) {
+ this.user = user;
+ this.successfulRestoreCount = successfulRestoreCount;
+ this.errorRestoreCount = errorRestoreCount;
+ }
+
+ public String getUser() {
+ return user;
+ }
+
+ public Long getSuccessfulRestoreCount() {
+ return successfulRestoreCount;
+ }
+
+ public Long getErrorRestoreCount() {
+ return errorRestoreCount;
+ }
+
+ DeletedMessagesVaultRestoreTask.AdditionalInformation toDomainObject() {
+ return new DeletedMessagesVaultRestoreTask.AdditionalInformation(
+ User.fromUsername(user),
+ new AtomicLong(successfulRestoreCount),
+ new AtomicLong(errorRestoreCount)
+ );
+ }
+}
diff --git a/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/test/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskSerializationTest.java b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/test/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskSerializationTest.java
index d2bb22e..adfcd75 100644
--- a/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/test/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskSerializationTest.java
+++ b/server/protocols/webadmin/webadmin-mailbox-deleted-message-vault/src/test/java/org/apache/james/webadmin/vault/routes/DeletedMessagesVaultRestoreTaskSerializationTest.java
@@ -23,9 +23,11 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import java.io.IOException;
+import java.util.concurrent.atomic.AtomicLong;
import org.apache.james.core.User;
import org.apache.james.mailbox.model.TestId;
+import org.apache.james.server.task.json.JsonTaskAdditionalInformationsSerializer;
import org.apache.james.server.task.json.JsonTaskSerializer;
import org.apache.james.task.Task;
import org.apache.james.vault.dto.query.QueryTranslator;
@@ -44,14 +46,18 @@ class DeletedMessagesVaultRestoreTaskSerializationTest {
private JsonTaskSerializer taskSerializer;
- private static final String username = "james";
- private static final User userToRestore = User.fromUsername(username);
- private static final Query query = Query.of(CriterionFactory.hasAttachment(true));
+ private static final String USERNAME = "james";
+ private static final User USER_TO_RESTORE = User.fromUsername(USERNAME);
+ private static final Query QUERY = Query.of(CriterionFactory.hasAttachment(true));
+ private static final DeletedMessagesVaultRestoreTask.AdditionalInformation DETAILS = new DeletedMessagesVaultRestoreTask.AdditionalInformation(USER_TO_RESTORE, new AtomicLong(42), new AtomicLong(10));
- private static final String serializedDeleteMessagesVaultRestoreTask = "{\"type\":\"deletedMessages/restore\"," +
+ private static final String SERIALIZED_DELETE_MESSAGES_VAULT_RESTORE_TASK = "{\"type\":\"deletedMessages/restore\"," +
"\"userToRestore\":\"james\"," +
"\"query\":{\"combinator\":\"and\",\"criteria\":[{\"fieldName\":\"hasAttachment\",\"operator\":\"equals\",\"value\":\"true\"}]}" +
"}";
+ private static final String SERIALIZED_ADDITIONAL_INFORMATION_TASK = "{\"user\":\"james\",\"successfulRestoreCount\":42,\"errorRestoreCount\":10}";
+
+ private static final JsonTaskAdditionalInformationsSerializer JSON_TASK_ADDITIONAL_INFORMATIONS_SERIALIZER = new JsonTaskAdditionalInformationsSerializer(DeletedMessagesVaultRestoreTaskAdditionalInformationDTO.MODULE);
@BeforeEach
void setUp() {
@@ -62,22 +68,32 @@ class DeletedMessagesVaultRestoreTaskSerializationTest {
@Test
void deleteMessagesVaultRestoreTaskShouldBeSerializable() throws JsonProcessingException {
- DeletedMessagesVaultRestoreTask task = new DeletedMessagesVaultRestoreTask(exportService, userToRestore, query);
+ DeletedMessagesVaultRestoreTask task = new DeletedMessagesVaultRestoreTask(exportService, USER_TO_RESTORE, QUERY);
assertThatJson(taskSerializer.serialize(task))
- .isEqualTo(serializedDeleteMessagesVaultRestoreTask);
+ .isEqualTo(SERIALIZED_DELETE_MESSAGES_VAULT_RESTORE_TASK);
}
@Test
void deleteMessagesVaultRestoreTaskShouldBeDeserializable() throws IOException {
- DeletedMessagesVaultRestoreTask task = new DeletedMessagesVaultRestoreTask(exportService, userToRestore, query);
+ DeletedMessagesVaultRestoreTask task = new DeletedMessagesVaultRestoreTask(exportService, USER_TO_RESTORE, QUERY);
- Task deserializedTask = taskSerializer.deserialize(serializedDeleteMessagesVaultRestoreTask);
+ Task deserializedTask = taskSerializer.deserialize(SERIALIZED_DELETE_MESSAGES_VAULT_RESTORE_TASK);
assertThat(deserializedTask)
.isEqualToComparingOnlyGivenFields(task, "userToRestore");
DeletedMessagesVaultRestoreTask deserializedRestoreTask = (DeletedMessagesVaultRestoreTask) deserializedTask;
- assertThat(queryTranslator.toDTO(deserializedRestoreTask.query)).isEqualTo(queryTranslator.toDTO(query));
+ assertThat(queryTranslator.toDTO(deserializedRestoreTask.query)).isEqualTo(queryTranslator.toDTO(QUERY));
+ }
+
+ @Test
+ void additionalInformationShouldBeSerializable() throws JsonProcessingException {
+ assertThatJson(JSON_TASK_ADDITIONAL_INFORMATIONS_SERIALIZER.serialize(DETAILS)).isEqualTo(SERIALIZED_ADDITIONAL_INFORMATION_TASK);
}
+ @Test
+ void additonalInformationShouldBeDeserializable() throws IOException {
+ assertThat(JSON_TASK_ADDITIONAL_INFORMATIONS_SERIALIZER.deserialize("deletedMessages/restore", SERIALIZED_ADDITIONAL_INFORMATION_TASK))
+ .isEqualToComparingFieldByField(DETAILS);
+ }
}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org