GDCC/8605-add-archival-status-support #8696
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -87,6 +87,7 @@ | |
| import edu.harvard.iq.dataverse.util.json.JSONLDUtil; | ||
| import edu.harvard.iq.dataverse.util.json.JsonLDTerm; | ||
| import edu.harvard.iq.dataverse.util.json.JsonParseException; | ||
| import edu.harvard.iq.dataverse.util.json.JsonUtil; | ||
| import edu.harvard.iq.dataverse.search.IndexServiceBean; | ||
| import static edu.harvard.iq.dataverse.util.json.JsonPrinter.*; | ||
| import static edu.harvard.iq.dataverse.util.json.NullSafeJsonBuilder.jsonObjectBuilder; | ||
|
|
@@ -216,6 +217,9 @@ public class Datasets extends AbstractApiBean { | |
| @Inject | ||
| DataverseRoleServiceBean dataverseRoleService; | ||
|
|
||
| @EJB | ||
| DatasetVersionServiceBean datasetversionService; | ||
|
|
||
| /** | ||
| * Used to consolidate the way we parse and handle dataset versions. | ||
| * @param <T> | ||
|
|
@@ -3282,4 +3286,107 @@ public Response getCurationStates() throws WrappedResponse { | |
| csvSB.append("\n"); | ||
| return ok(csvSB.toString(), MediaType.valueOf(FileUtil.MIME_TYPE_CSV), "datasets.status.csv"); | ||
| } | ||
|
|
||
| //APIs to manage archival status | ||
|
|
||
| @GET | ||
| @Produces(MediaType.APPLICATION_JSON) | ||
| @Path("/submitDatasetVersionToArchive/{id}/{version}/status") | ||
|
There was a problem hiding this comment. submitDatasetVersionToArchive is a weird name. submitDataVersionToArchive (Data instead of Dataset) is under /api/admin and documented under installation/config.html There was a problem hiding this comment. Yes. So far it ~mirrors the /api/admin/submitDatasetVersionToArchive call (name changed to say 'Dataset' in #8610 which hasn't merged yet), which seemed reasonable when it was a single call. With the status calls, I initially had them in /api/admin as well, but eventually decided they should move to /api/datasets (see the comment about superuser being required on those). With that, they could be renamed - e.g. to /api/datasets/<id>/<version>/archivalStatus . There was a problem hiding this comment. I like the new name ending with |
||
| public Response getDatasetVersionToArchiveStatus(@PathParam("id") String dsid, | ||
| @PathParam("version") String versionNumber) { | ||
|
|
||
| try { | ||
| AuthenticatedUser au = findAuthenticatedUserOrDie(); | ||
| if (!au.isSuperuser()) { | ||
| return error(Response.Status.FORBIDDEN, "Superusers only."); | ||
| } | ||
| Dataset ds = findDatasetOrDie(dsid); | ||
|
|
||
| DatasetVersion dv = datasetversionService.findByFriendlyVersionNumber(ds.getId(), versionNumber); | ||
|
There was a problem hiding this comment. Any reason not to use getDatasetVersionOrDie here (and in the other two calls to findByFriendlyVersionNumber in this PR)? There was a problem hiding this comment. Not sure I saw it but looking now, getDatasetVersionOrDie doesn't support the friendlyVersionNumber syntax which is a ~requirement here (that's the convention used in the Bag naming and metadata that the archiver gets). I can go ahead and add parsing for that which would have the presumably useful side effect of letting other datasetversion api calls support the friendly version number as well. There was a problem hiding this comment. It should. I'm seeing There was a problem hiding this comment. Yep - you're right. I missed the string parsing in handleVersion(). I'll update the PR to use it. There was a problem hiding this comment. Hmm - calls to this are counted with MakeDataCounts. I guess since these are API calls they should count? (although they are clearly system-level interactions and not end-user interaction with the data). In any case, I went ahead for now. There was a problem hiding this comment. I dunno. I'd leave this out of Make Data Count. Like you said, these are systems setting and retrieving archival status messages. The spirit of Make Data Count is views/investigations and downloads/requests. People and machines looking at data. |
||
| if (dv.getArchivalCopyLocation() == null) { | ||
| return error(Status.NO_CONTENT, "This dataset version has not been archived"); | ||
| } else { | ||
| JsonObject status = JsonUtil.getJsonObject(dv.getArchivalCopyLocation()); | ||
| return ok(status); | ||
| } | ||
| } catch (WrappedResponse wr) { | ||
| return wr.getResponse(); | ||
| } | ||
| } | ||
|
|
||
| @PUT | ||
| @Consumes(MediaType.APPLICATION_JSON) | ||
| @Path("/submitDatasetVersionToArchive/{id}/{version}/status") | ||
| public Response setDatasetVersionToArchiveStatus(@PathParam("id") String dsid, | ||
| @PathParam("version") String versionNumber, JsonObject update) { | ||
|
|
||
| logger.info(JsonUtil.prettyPrint(update)); | ||
pdurbin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| try { | ||
| AuthenticatedUser au = findAuthenticatedUserOrDie(); | ||
|
|
||
| if (!au.isSuperuser()) { | ||
| return error(Response.Status.FORBIDDEN, "Superusers only."); | ||
| } | ||
| } catch (WrappedResponse wr) { | ||
| return wr.getResponse(); | ||
| } | ||
| if (update.containsKey(DatasetVersion.STATUS) | ||
| && update.containsKey(DatasetVersion.MESSAGE)) { | ||
| String status = update.getString(DatasetVersion.STATUS); | ||
| if (status.equals(DatasetVersion.PENDING) | ||
| || status.equals(DatasetVersion.FAILURE) | ||
| || status.equals(DatasetVersion.SUCCESS)) { | ||
pdurbin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| try { | ||
| Dataset ds; | ||
|
|
||
| ds = findDatasetOrDie(dsid); | ||
|
|
||
| DatasetVersion dv = datasetversionService.findByFriendlyVersionNumber(ds.getId(), versionNumber); | ||
| if(dv==null) { | ||
| return error(Status.NOT_FOUND, "Dataset version not found"); | ||
| } | ||
|
|
||
| dv.setArchivalCopyLocation(JsonUtil.prettyPrint(update)); | ||
| dv = datasetversionService.merge(dv); | ||
| logger.info("location now: " + dv.getArchivalCopyLocation()); | ||
| logger.info("status now: " + dv.getArchivalCopyLocationStatus()); | ||
| logger.info("message now: " + dv.getArchivalCopyLocationMessage()); | ||
|
|
||
| return ok("Status updated"); | ||
|
|
||
| } catch (WrappedResponse wr) { | ||
| return wr.getResponse(); | ||
| } | ||
| } | ||
| } | ||
| return error(Status.BAD_REQUEST, "Unacceptable status format"); | ||
| } | ||
|
|
||
| @DELETE | ||
| @Produces(MediaType.APPLICATION_JSON) | ||
| @Path("/submitDatasetVersionToArchive/{id}/{version}/status") | ||
| public Response deleteDatasetVersionToArchiveStatus(@PathParam("id") String dsid, | ||
| @PathParam("version") String versionNumber) { | ||
|
|
||
| try { | ||
| AuthenticatedUser au = findAuthenticatedUserOrDie(); | ||
| if (!au.isSuperuser()) { | ||
| return error(Response.Status.FORBIDDEN, "Superusers only."); | ||
| } | ||
| Dataset ds = findDatasetOrDie(dsid); | ||
|
|
||
| DatasetVersion dv = datasetversionService.findByFriendlyVersionNumber(ds.getId(), versionNumber); | ||
| if (dv == null) { | ||
| return error(Status.NOT_FOUND, "Dataset version not found"); | ||
| } | ||
| dv.setArchivalCopyLocation(null); | ||
| dv = datasetversionService.merge(dv); | ||
|
|
||
| return ok("Status deleted"); | ||
|
|
||
| } catch (WrappedResponse wr) { | ||
| return wr.getResponse(); | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How come
:persistentIdisn't in the URL? Are database IDs supported as well as PIDs? They should be, like all other native API endpoints.