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 2019/03/04 11:43:43 UTC
[james-project] 09/16: MAILBOX-382 adding redeliver routes in
webadmin doc
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 1ce3612e6e5040f104767e926eb036bc0a252419
Author: Rene Cordier <rc...@linagora.com>
AuthorDate: Fri Mar 1 17:19:09 2019 +0700
MAILBOX-382 adding redeliver routes in webadmin doc
---
src/site/markdown/server/manage-webadmin.md | 52 +++++++++++++++++++++++++++--
1 file changed, 49 insertions(+), 3 deletions(-)
diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index 678a69a..b00a62f 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -2428,6 +2428,9 @@ failing, then the event will be stored in the "Event Dead Letter". This API allo
- [Listing failed events](#Listing_failed_events)
- [Getting event details](#Getting_event_details)
- [Deleting an event](#Deleting_an_event)
+ - [Redeliver all events](#Redeliver_all_events)
+ - [Redeliver group events](#Redeliver_group_events)
+ - [Redeliver a single event](#Redeliver_a_single_event)
- [Rescheduling group execution](#Rescheduling_group_execution)
### Listing groups
@@ -2453,7 +2456,7 @@ Response codes:
This endpoint allows listing failed events for a given group:
```
-curl -XGET http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/events
+curl -XGET http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA
```
Will return a list of event ids:
@@ -2470,7 +2473,7 @@ Response codes:
### Getting event details
```
-curl -XGET http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/events/6e0dd59d-660e-4d9b-b22f-0354479f47b4
+curl -XGET http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/6e0dd59d-660e-4d9b-b22f-0354479f47b4
```
Will return the full JSON associated with this event.
@@ -2483,7 +2486,7 @@ Response codes:
### Deleting an event
```
-curl -XDELETE http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/events/6e0dd59d-660e-4d9b-b22f-0354479f47b4
+curl -XDELETE http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/6e0dd59d-660e-4d9b-b22f-0354479f47b4
```
Will delete this event.
@@ -2493,6 +2496,49 @@ Response codes:
- 204: Success
- 400: Invalid group name or eventId
+### Redeliver all events
+
+```
+curl -XPOST http://ip:port/events/deadLetter
+```
+
+Will create a task that will attempt to redeliver all events stored in "Event Dead Letter".
+If successful, redelivered events will then be removed from "Dead Letter".
+
+Response codes:
+
+ - 201: the taskId of the created task
+ - 400: Invalid action argument
+
+### Redeliver group events
+
+```
+curl -XPOST http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA
+```
+
+Will create a task that will attempt to redeliver all events of a particular group stored in "Event Dead Letter".
+If successful, redelivered events will then be removed from "Dead Letter".
+
+Response codes:
+
+ - 201: the taskId of the created task
+ - 400: Invalid group name or action argument
+
+### Redeliver a single event
+
+```
+curl -XPOST http://ip:port/events/deadLetter/groups/org.apache.james.mailbox.events.EventBusTestFixture$GroupA/6e0dd59d-660e-4d9b-b22f-0354479f47b4
+```
+
+Will create a task that will attempt to redeliver a single event of a particular group stored in "Event Dead Letter".
+If successful, redelivered event will then be removed from "Dead Letter".
+
+Response codes:
+
+ - 201: the taskId of the created task
+ - 400: Invalid group name, event id or action argument
+ - 404: No event with this eventId
+
### Rescheduling group execution
Not implemented yet.
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org