Add tobira series endpoint to remove paths (#6317)

This will allow removing ("unmounting") a series in Tobira. The necessary endpoints in Tobira itself were already existing and also called by this endpoint in Opencast. This commit just makes some form params optional. ### How to test this patch <sub>The following is a bunch of information that is useful to test this, but in the interest of time I'd suggest that this should be tested by @Arnei, since he has done so before and won't need the extra preparation.</sub> If you want to test this and haven't done any Tobira testing before (though that is probably too much work for this small PR for anyone that hasn't tested these Tobira endpoints before): - You'll need at least Tobira 2.11 and configure it to talk to your Opencast with JWT setup (see our docs for reference: https://elan-ev.github.io/tobira/setup/auth/jwt) - The relevant endpoint is `updateSeriesTobiraPath` and can be tested via `{your-opencast}/docs.html?path=/admin-ng/series#updateSeriesTobiraPath-10` - In order to use that endpoint for series unmounting: - you'll need the `seriesId` (Opencast ID) of a mounted series in Tobira - The page must not have any other content that the series - `pathComponents` must be empty - `currentPath` needs to be the path of that series in Tobira (i.e. "/page/my_series") - `targetPath` must be empty   ### Your pull request should… * [ ] have a concise title * [ ] [close an accompanying issue](https://docs.opencast.org/develop/developer/#participate/development-process/#automatically-closing-issues-when-a-pr-is-merged) if one exists * [ ] [be against the correct branch](https://docs.opencast.org/develop/developer/development-process#acceptance-criteria-for-patches-in-different-versions) * [ ] include migration scripts and documentation, if appropriate * [ ] pass automated tests * [ ] have a clean commit history * [ ] [have proper commit messages (title and body) for all commits](https://medium.com/@steveamaza/e028865e5791) * [ ] explain why it needs to be merged into the legacy branch, if it is targeting the legacy branch
opencast · Dec 11, 2024 · 0256c57 · 0256c57
2 parents 1f4e1d9 + cd41200
commit 0256c57
Showing 1 changed file with 55 additions and 1 deletion.
diff --git a/modules/admin-ui/src/main/java/org/opencastproject/adminui/endpoint/SeriesEndpoint.java b/modules/admin-ui/src/main/java/org/opencastproject/adminui/endpoint/SeriesEndpoint.java
@@ -1197,7 +1197,61 @@ public Response updateSeriesTobiraPath(
       tobira.createRealmLineage(paths);
       tobira.addSeriesMountPoint(mountParams);
 
-      if (currentPath != null) {
+      if (currentPath != null && !currentPath.trim().isEmpty()) {
+        var unmountParams = new JSONObject();
+        unmountParams.put("seriesId", seriesId);
+        unmountParams.put("currentPath", currentPath);
+        tobira.removeSeriesMountPoint(unmountParams);
+      }
+
+      return ok();
+    } catch (Exception e) {
+      return Response.status(Status.INTERNAL_SERVER_ERROR)
+              .entity("Internal server error: " + e.getMessage())
+              .build();
+    }
+  }
+
+  @DELETE
+  @Path("{seriesId}/tobira/{currentPath}")
+  @RestQuery(
+          name = "removeSeriesTobiraPath",
+          description = "Removes the path of the given series in a connected Tobira instance",
+          returnDescription = "Status code",
+          pathParameters = {
+                  @RestParameter(
+                          name = "seriesId",
+                          isRequired = true,
+                          description = "The series id",
+                          type = STRING),
+                  @RestParameter(
+                          name = "currentPath",
+                          isRequired = true,
+                          description = "URL encoded path where the series is currently mounted.",
+                          type = STRING) },
+          responses = {
+                  @RestResponse(
+                          responseCode = SC_OK,
+                          description = "The path of the series has successfully been removed in Tobira."),
+                  @RestResponse(
+                          responseCode = SC_NOT_FOUND,
+                          description = "Tobira doesn't know about the given series"),
+                  @RestResponse(
+                          responseCode = SC_SERVICE_UNAVAILABLE,
+                          description = "Tobira is not configured (correctly)") })
+  public Response removeSeriesTobiraPath(
+    @PathParam("seriesId") String seriesId,
+    @PathParam("currentPath") String currentPath
+  ) throws IOException, InterruptedException {
+    var tobira = getTobira();
+    if (!tobira.ready()) {
+      return Response.status(Status.SERVICE_UNAVAILABLE)
+              .entity("Tobira is not configured (correctly)")
+              .build();
+    }
+
+    try {
+      if (currentPath != null && !currentPath.trim().isEmpty()) {
         var unmountParams = new JSONObject();
         unmountParams.put("seriesId", seriesId);
         unmountParams.put("currentPath", currentPath);