add guestbookId to missing response message

Author: stevenwinship

src/main/java/edu/harvard/iq/dataverse/api/Access.java

@@ -147,7 +147,7 @@ public BundleDownloadInstance datafileBundle(@Context ContainerRequestContext cr
         checkAuthorization(crc, df);
         User requestor = getRequestor(crc);
         if (checkGuestbookRequiredResponse(crc, uriInfo, df, gbrids)) {
-            throw new BadRequestException(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing"));
+            throw new BadRequestException(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", getGuestbookIdFromDatafile(df)));
         }
 
         if (gbrecs != true && df.isReleased()) {
@@ -252,7 +252,7 @@ public Response datafile(@Context ContainerRequestContext crc, @PathParam("fileI
         checkAuthorization(crc, df);
         User requestor = getRequestor(crc);
         if (checkGuestbookRequiredResponse(crc, uriInfo, df, gbrids)) {
-            return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing"));
+            return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", getGuestbookIdFromDatafile(df)));
         }
 
         if (gbrecs != true && df.isReleased()){
@@ -407,6 +407,11 @@ private String normalizeFileId(String fileId) {
         return fId;
     }
 
+    // for bundle arg list
+    private List<String> getGuestbookIdFromDatafile(DataFile df) {
+         return df != null && df.getOwner() != null && df.getOwner().getGuestbook() != null ? List.of(df.getOwner().getGuestbook().getId().toString()) : List.of();
+    }
+
     // Process the guestbook response from JSON and return a signedUrl to the matching GET call
     private Response processDatafileWithGuestbookResponse(ContainerRequestContext crc, HttpHeaders headers, String fileIds, UriInfo uriInfo, boolean gbrecs, String jsonBody) {
 
@@ -435,7 +440,7 @@ private Response processDatafileWithGuestbookResponse(ContainerRequestContext cr
                         MakeDataCountEntry entry = new MakeDataCountEntry(uriInfo, headers, dvRequestService, df);
                         mdcLogService.logEntry(entry);
                     } else {
-                        return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing"));
+                        return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", getGuestbookIdFromDatafile(df)));
                     }
                 } else if (gbrecs != true && df.isReleased()) {
                     // Write Guestbook record if not done previously and file is released
@@ -1031,7 +1036,7 @@ private Response downloadDatafiles(ContainerRequestContext crc, String body, boo
                         MakeDataCountEntry entry = new MakeDataCountEntry(uriInfo, headers, dvRequestService, df);
                         mdcLogService.logEntry(entry);
                     } else {
-                        return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing"));
+                        return error(BAD_REQUEST, BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", getGuestbookIdFromDatafile(df)));
                     }
                 } catch (JsonParseException | CommandException ex) {
                     List<String> args = Arrays.asList(df.getDisplayName(), ex.getLocalizedMessage());

src/main/java/propertyFiles/Bundle.properties

@@ -2953,7 +2953,7 @@ access.api.exception.metadata.not.available.for.nontabular.file=This type of met
 access.api.exception.metadata.restricted.no.permission=You do not have permission to download this file.
 access.api.exception.version.not.found=Could not find requested dataset version.
 access.api.exception.dataset.not.found=Could not find requested dataset.
-access.api.download.failure.guestbookResponseMissing=You may not download this file without the required Guestbook response.
+access.api.download.failure.guestbookResponseMissing=You may not download this file without the required Guestbook response for guestbookID {0}.
 access.api.download.failure.guestbook.commandError=Problem trying download with guestbook response on {0} : {1}
 access.api.download.failure.multipleDatasets=All files being downloaded must be from the same Dataset.
 

src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java

@@ -3978,7 +3978,7 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         downloadResponse.prettyPrint();
         downloadResponse.then().assertThat()
                 .body("status", equalTo(ApiConstants.STATUS_ERROR))
-                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing")))
+                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", List.of(guestbook.getId().toString()))))
                 .statusCode(BAD_REQUEST.getStatusCode());
         // With GuestbookResponse. Guest user doesn't have the required Name and Email. so this will still fail
         downloadResponse = UtilIT.postDownloadFile(fileId4, guestbookResponse);
@@ -4004,7 +4004,7 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         downloadResponse.prettyPrint();
         downloadResponse.then().assertThat()
                 .body("status", equalTo(ApiConstants.STATUS_ERROR))
-                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing")))
+                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", List.of(guestbook.getId().toString()))))
                 .statusCode(BAD_REQUEST.getStatusCode());
 
         // Get Signed Download Url with guestbook response
@@ -4023,7 +4023,7 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         downloadResponse.prettyPrint();
         downloadResponse.then().assertThat()
                 .body("status", equalTo(ApiConstants.STATUS_ERROR))
-                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing")))
+                .body("message", equalTo(BundleUtil.getStringFromBundle("access.api.download.failure.guestbookResponseMissing", List.of(guestbook.getId().toString()))))
                 .statusCode(BAD_REQUEST.getStatusCode());
 
         // Download multiple files with guestbook response and fileIds in json