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 bt...@apache.org on 2018/01/26 01:13:52 UTC
[08/10] james-project git commit: JAMES-2292 Add DELETE
/mailQueues/{mailQueueName}/mails endpoint
JAMES-2292 Add DELETE /mailQueues/{mailQueueName}/mails endpoint
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo
Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/f9df417d
Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/f9df417d
Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/f9df417d
Branch: refs/heads/master
Commit: f9df417d3679e6e5b902d916523f07c0d16dd097
Parents: a5abe35
Author: Antoine Duprat <ad...@linagora.com>
Authored: Wed Jan 24 14:52:04 2018 +0100
Committer: benwa <bt...@linagora.com>
Committed: Fri Jan 26 08:12:21 2018 +0700
----------------------------------------------------------------------
.../webadmin/webadmin-mailqueue/pom.xml | 4 +
.../james/webadmin/routes/MailQueueRoutes.java | 118 +++++++++++-
.../webadmin/routes/MailQueueRoutesTest.java | 183 +++++++++++++++++++
3 files changed, 304 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/james-project/blob/f9df417d/server/protocols/webadmin/webadmin-mailqueue/pom.xml
----------------------------------------------------------------------
diff --git a/server/protocols/webadmin/webadmin-mailqueue/pom.xml b/server/protocols/webadmin/webadmin-mailqueue/pom.xml
index 92402e5..6e4cfd1 100644
--- a/server/protocols/webadmin/webadmin-mailqueue/pom.xml
+++ b/server/protocols/webadmin/webadmin-mailqueue/pom.xml
@@ -56,6 +56,10 @@
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
+ <artifactId>james-server-task</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>${project.groupId}</groupId>
<artifactId>james-server-webadmin-core</artifactId>
</dependency>
<dependency>
http://git-wip-us.apache.org/repos/asf/james-project/blob/f9df417d/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/routes/MailQueueRoutes.java
----------------------------------------------------------------------
diff --git a/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/routes/MailQueueRoutes.java b/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/routes/MailQueueRoutes.java
index 58a5576..933bc38 100644
--- a/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/routes/MailQueueRoutes.java
+++ b/server/protocols/webadmin/webadmin-mailqueue/src/main/java/org/apache/james/webadmin/routes/MailQueueRoutes.java
@@ -25,15 +25,19 @@ import java.util.List;
import java.util.Optional;
import javax.inject.Inject;
+import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
+import org.apache.james.core.MailAddress;
import org.apache.james.queue.api.MailQueue.MailQueueException;
import org.apache.james.queue.api.MailQueueFactory;
import org.apache.james.queue.api.ManageableMailQueue;
+import org.apache.james.queue.api.ManageableMailQueue.Type;
import org.apache.james.util.streams.Iterators;
import org.apache.james.util.streams.Limit;
+import org.apache.james.webadmin.Constants;
import org.apache.james.webadmin.Routes;
import org.apache.james.webadmin.dto.MailQueueDTO;
import org.apache.james.webadmin.dto.MailQueueItemDTO;
@@ -45,6 +49,7 @@ import org.eclipse.jetty.http.HttpStatus;
import com.github.fge.lambdas.Throwing;
import com.github.steveash.guavate.Guavate;
import com.google.common.annotations.VisibleForTesting;
+import com.google.common.primitives.Booleans;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
@@ -54,6 +59,7 @@ import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import spark.HaltException;
import spark.Request;
+import spark.Response;
import spark.Service;
@@ -69,6 +75,10 @@ public class MailQueueRoutes implements Routes {
private static final String DELAYED_QUERY_PARAM = "delayed";
private static final String LIMIT_QUERY_PARAM = "limit";
@VisibleForTesting static final int DEFAULT_LIMIT_VALUE = 100;
+
+ private static final String SENDER_QUERY_PARAM = "sender";
+ private static final String NAME_QUERY_PARAM = "name";
+ private static final String RECIPIENT_QUERY_PARAM = "recipient";
private final MailQueueFactory<ManageableMailQueue> mailQueueFactory;
private final JsonTransformer jsonTransformer;
@@ -85,8 +95,10 @@ public class MailQueueRoutes implements Routes {
defineListQueues(service);
getMailQueue(service);
-
+
listMails(service);
+
+ deleteMails(service);
}
@GET
@@ -239,4 +251,108 @@ public class MailQueueRoutes implements Routes {
return isDelayed.map(delayed -> delayed == item.getNextDelivery().isPresent())
.orElse(true);
}
+
+ @DELETE
+ @Path("/{mailQueueName}/mails")
+ @ApiImplicitParams({
+ @ApiImplicitParam(required = true, dataType = "string", name = "mailQueueName", paramType = "path"),
+ @ApiImplicitParam(
+ required = false,
+ dataType = "MailAddress",
+ name = SENDER_QUERY_PARAM,
+ paramType = "query",
+ example = "?sender=sender@james.org",
+ value = "The sender of the mails to be deleted should be equals to this query parameter."),
+ @ApiImplicitParam(
+ required = false,
+ dataType = "String",
+ name = NAME_QUERY_PARAM,
+ paramType = "query",
+ example = "?name=mailName",
+ value = "The name of the mails to be deleted should be equals to this query parameter."),
+ @ApiImplicitParam(
+ required = false,
+ dataType = "MailAddress",
+ name = RECIPIENT_QUERY_PARAM,
+ paramType = "query",
+ example = "?recipient=recipient@james.org",
+ value = "The recipients of the mails to be deleted should contain this query parameter."),
+ })
+ @ApiOperation(
+ value = "Delete mails from the MailQueue"
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = HttpStatus.NO_CONTENT_204, message = "OK, the request is being processed"),
+ @ApiResponse(code = HttpStatus.NOT_FOUND_404, message = "The MailQueue does not exist."),
+ @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "Invalid request for deleting mails from the mail queue."),
+ @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side.")
+ })
+ public void deleteMails(Service service) {
+ service.delete(BASE_URL + SEPARATOR + MAIL_QUEUE_NAME + MAILS,
+ (request, response) -> deleteMails(request, response));
+ }
+
+ private Object deleteMails(Request request, Response response) {
+ String mailQueueName = request.params(MAIL_QUEUE_NAME);
+ Object bodyResponse = mailQueueFactory.getQueue(mailQueueName)
+ .map(name -> deleteMails(name,
+ sender(request.queryParams(SENDER_QUERY_PARAM)),
+ name(request.queryParams(NAME_QUERY_PARAM)),
+ recipient(request.queryParams(RECIPIENT_QUERY_PARAM))))
+ .orElseThrow(
+ () -> ErrorResponder.builder()
+ .message(String.format("%s can not be found", mailQueueName))
+ .statusCode(HttpStatus.NOT_FOUND_404)
+ .type(ErrorResponder.ErrorType.NOT_FOUND)
+ .haltError());
+ response.status(HttpStatus.NO_CONTENT_204);
+ return bodyResponse;
+ }
+
+ private Optional<MailAddress> sender(String senderAsString) throws HaltException {
+ try {
+ return Optional.ofNullable(senderAsString)
+ .map(Throwing.function((String sender) -> new MailAddress(sender)).sneakyThrow());
+ } catch (Exception e) {
+ throw ErrorResponder.builder()
+ .statusCode(HttpStatus.BAD_REQUEST_400)
+ .type(ErrorType.INVALID_ARGUMENT)
+ .message("'sender' should be a mail address (i.e. sender@james.org)")
+ .cause(e)
+ .haltError();
+ }
+ }
+
+ private Optional<String> name(String nameAsString) {
+ return Optional.ofNullable(nameAsString);
+ }
+
+ private Optional<MailAddress> recipient(String recipientAsString) throws HaltException {
+ try {
+ return Optional.ofNullable(recipientAsString)
+ .map(Throwing.function((String recipient) -> new MailAddress(recipient)).sneakyThrow());
+ } catch (Exception e) {
+ throw ErrorResponder.builder()
+ .statusCode(HttpStatus.BAD_REQUEST_400)
+ .type(ErrorType.INVALID_ARGUMENT)
+ .message("'recipient' should be a mail address (i.e. recipient@james.org)")
+ .cause(e)
+ .haltError();
+ }
+ }
+
+ private Object deleteMails(ManageableMailQueue queue, Optional<MailAddress> maybeSender, Optional<String> maybeName, Optional<MailAddress> maybeRecipient) {
+ if (Booleans.countTrue(maybeSender.isPresent(), maybeName.isPresent(), maybeRecipient.isPresent()) != 1) {
+ throw ErrorResponder.builder()
+ .statusCode(HttpStatus.BAD_REQUEST_400)
+ .type(ErrorType.INVALID_ARGUMENT)
+ .message("You should provide one and only one of the query parameters 'sender', 'name' or 'recipient'.")
+ .haltError();
+ }
+
+ maybeSender.ifPresent(Throwing.consumer((MailAddress sender) -> queue.remove(Type.Sender, sender.asString())).sneakyThrow());
+ maybeName.ifPresent(Throwing.consumer((String name) -> queue.remove(Type.Name, name)).sneakyThrow());
+ maybeRecipient.ifPresent(Throwing.consumer((MailAddress recipient) -> queue.remove(Type.Recipient, recipient.asString())).sneakyThrow());
+ return Constants.EMPTY_BODY;
+ }
}
http://git-wip-us.apache.org/repos/asf/james-project/blob/f9df417d/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/routes/MailQueueRoutesTest.java
----------------------------------------------------------------------
diff --git a/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/routes/MailQueueRoutesTest.java b/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/routes/MailQueueRoutesTest.java
index 291c6b1..f8e69b7 100644
--- a/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/routes/MailQueueRoutesTest.java
+++ b/server/protocols/webadmin/webadmin-mailqueue/src/test/java/org/apache/james/webadmin/routes/MailQueueRoutesTest.java
@@ -36,6 +36,7 @@ import java.util.concurrent.TimeUnit;
import org.apache.james.core.MailAddress;
import org.apache.james.metrics.api.NoopMetricFactory;
import org.apache.james.queue.api.Mails;
+import org.apache.james.queue.api.ManageableMailQueue;
import org.apache.james.queue.api.RawMailQueueItemDecoratorFactory;
import org.apache.james.queue.memory.MemoryMailQueueFactory;
import org.apache.james.queue.memory.MemoryMailQueueFactory.MemoryMailQueue;
@@ -320,4 +321,186 @@ public class MailQueueRoutesTest {
.then()
.statusCode(HttpStatus.BAD_REQUEST_400);
}
+
+ @Test
+ public void deleteMailsShouldReturnNotFoundWhenMailQueueDoesntExist() {
+ when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NOT_FOUND_404);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnBadRequestWhenSenderIsInvalid() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ given()
+ .param("sender", "123")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.BAD_REQUEST_400);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnBadRequestWhenRecipientIsInvalid() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ given()
+ .param("recipient", "123")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.BAD_REQUEST_400);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnNoContentWhenSenderIsValid() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ given()
+ .param("sender", "sender@james.org")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnNoContentWhenNameIsValid() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ given()
+ .param("name", "mailName")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnNoContentWhenRecipientIsValid() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ given()
+ .param("recipient", "recipient@james.org")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnBadRequestWhenNoQueryParameters() {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+
+ when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.BAD_REQUEST_400);
+ }
+
+ @Test
+ public void deleteMailsShouldDeleteMailsWhenSenderIsGiven() throws Exception {
+ MemoryMailQueue queue = mailQueueFactory.createQueue(FIRST_QUEUE);
+ String sender = "sender@james.org";
+ queue.enQueue(Mails.defaultMail()
+ .sender(sender)
+ .build());
+
+ given()
+ .param("sender", sender)
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+
+ assertThat(queue.browse()).isEmpty();
+ }
+
+ @Test
+ public void deleteMailsShouldDeleteMailsWhenNameIsGiven() throws Exception {
+ MemoryMailQueue queue = mailQueueFactory.createQueue(FIRST_QUEUE);
+ String name = "mailName";
+ queue.enQueue(Mails.defaultMail()
+ .name(name)
+ .build());
+
+ given()
+ .param("name", name)
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+
+ assertThat(queue.browse()).isEmpty();
+ }
+
+ @Test
+ public void deleteMailsShouldDeleteMailsWhenRecipientIsGiven() throws Exception {
+ MemoryMailQueue queue = mailQueueFactory.createQueue(FIRST_QUEUE);
+ String recipient = "recipient@james.org";
+ queue.enQueue(Mails.defaultMail()
+ .recipient(recipient)
+ .build());
+
+ given()
+ .param("recipient", recipient)
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+
+ assertThat(queue.browse()).isEmpty();
+ }
+
+ @Test
+ public void deleteMailsShouldReturnBadRequestWhenAllParametersAreGiven() throws Exception {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+ given()
+ .param("sender", "sender@james.org")
+ .param("name", "mailName")
+ .param("recipient", "recipient@james.org")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.BAD_REQUEST_400);
+ }
+
+ @Test
+ public void deleteMailsShouldReturnBadRequestWhenTwoParametersAreGiven() throws Exception {
+ mailQueueFactory.createQueue(FIRST_QUEUE);
+ given()
+ .param("sender", "sender@james.org")
+ .param("name", "mailName")
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.BAD_REQUEST_400);
+ }
+
+ @Test
+ public void deleteMailsShouldDeleteMailsWhenTheyAreMatching() throws Exception {
+ MemoryMailQueue queue = mailQueueFactory.createQueue(FIRST_QUEUE);
+ String recipient = "recipient@james.org";
+ queue.enQueue(Mails.defaultMail()
+ .recipient(recipient)
+ .build());
+ queue.enQueue(Mails.defaultMail().build());
+ queue.enQueue(Mails.defaultMail().build());
+
+ given()
+ .param("recipient", recipient)
+ .when()
+ .delete(FIRST_QUEUE + "/mails")
+ .then()
+ .statusCode(HttpStatus.NO_CONTENT_204);
+
+ MailAddress deletedRecipientMailAddress = new MailAddress(recipient);
+ assertThat(queue.browse())
+ .hasSize(2)
+ .allSatisfy((ManageableMailQueue.MailQueueItemView item) -> {
+ assertThat(item.getMail().getRecipients()).doesNotContain(deletedRecipientMailAddress);
+ });
+ }
}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org