arsvendg/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/arsvendg/Stirling-PDF.git synced 2026-07-14 10:34:06 +02:00
Code Issues Actions 4 Packages Projects Releases 1 Wiki Activity

Fix ClassCastException in extractBookmarks endpoint (#5578) (#5604)

Browse Source 
## Description

Fixes #5578

This PR fixes a `ClassCastException` that occurs when calling
`/api/v1/general/extract-bookmarks`. The method was returning
`List<Map<String, Object>>` directly, but Spring MVC was wrapping it in
a `ResponseEntity`, causing a type mismatch.

## Changes

- Changed return type from `List<Map<String, Object>>` to
`ResponseEntity<List<Map<String, Object>>>`
- Wrapped return values with `ResponseEntity.ok(...)` to match Spring
MVC pattern
- Removed `@ResponseBody` annotation as it is not needed with
`ResponseEntity`

## Verification

This fix follows the same pattern used in other similar endpoints:
- `VerifyPDFController.verifyPDF()` returns
`ResponseEntity<List<PDFVerificationResult>>`
- `ValidateSignatureController.validateSignature()` returns
`ResponseEntity<List<SignatureValidationResult>>`

## Testing

The endpoint should now return a proper JSON response with the list of
bookmarks instead of throwing a 500 error.

---------

Co-authored-by: GitTensor Miner <[email protected]>
Co-authored-by: Anthony Stirling <[email protected]>
This commit is contained in:
PandaMan
2026-02-03 09:48:09 +00:00
committed by GitHub
co-authored by GitTensor Miner Anthony Stirling
parent 79bc62a5d2
commit ffd1abbdb3
2 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/core/src/main/java/stirling/software/SPDF/controller/api/EditTableOfContentsController.java
+4 -4
View File
@@ -46,18 +46,18 @@ public class EditTableOfContentsController {
@Operation( @Operation(
summary = "Extract PDF Bookmarks", summary = "Extract PDF Bookmarks",
description = "Extracts bookmarks/table of contents from a PDF document as JSON.") description = "Extracts bookmarks/table of contents from a PDF document as JSON.")
@ResponseBody public ResponseEntity<List<Map<String, Object>>> extractBookmarks(@RequestParam("file") MultipartFile file)
public List<Map<String, Object>> extractBookmarks(@RequestParam("file") MultipartFile file)
throws Exception { throws Exception {
try (PDDocument document = pdfDocumentFactory.load(file)) { try (PDDocument document = pdfDocumentFactory.load(file)) {
PDDocumentOutline outline = document.getDocumentCatalog().getDocumentOutline(); PDDocumentOutline outline = document.getDocumentCatalog().getDocumentOutline();
if (outline == null) { if (outline == null) {
log.info("No outline/bookmarks found in PDF"); log.info("No outline/bookmarks found in PDF");
return new ArrayList<>(); return ResponseEntity.ok(new ArrayList<>());
} }
return extractBookmarkItems(document, outline); List<Map<String, Object>> bookmarks = extractBookmarkItems(document, outline);
return ResponseEntity.ok(bookmarks);
} }
} }
app/core/src/test/java/stirling/software/SPDF/controller/api/EditTableOfContentsControllerTest.java
+16 -8
View File
@@ -85,10 +85,12 @@ class EditTableOfContentsControllerTest {
when(mockOutlineItem.getNextSibling()).thenReturn(null); when(mockOutlineItem.getNextSibling()).thenReturn(null);
// When // When
List<Map<String, Object>> result = editTableOfContentsController.extractBookmarks(mockFile); ResponseEntity<List<Map<String, Object>>> response = editTableOfContentsController.extractBookmarks(mockFile);
// Then // Then
assertNotNull(result); assertNotNull(response);
assertNotNull(response.getBody());
List<Map<String, Object>> result = response.getBody();
assertEquals(1, result.size()); assertEquals(1, result.size());
Map<String, Object> bookmark = result.get(0); Map<String, Object> bookmark = result.get(0);
@@ -107,10 +109,12 @@ class EditTableOfContentsControllerTest {
when(mockCatalog.getDocumentOutline()).thenReturn(null); when(mockCatalog.getDocumentOutline()).thenReturn(null);
// When // When
List<Map<String, Object>> result = editTableOfContentsController.extractBookmarks(mockFile); ResponseEntity<List<Map<String, Object>>> response = editTableOfContentsController.extractBookmarks(mockFile);
// Then // Then
assertNotNull(result); assertNotNull(response);
assertNotNull(response.getBody());
List<Map<String, Object>> result = response.getBody();
assertTrue(result.isEmpty()); assertTrue(result.isEmpty());
verify(mockDocument).close(); verify(mockDocument).close();
} }
@@ -141,10 +145,12 @@ class EditTableOfContentsControllerTest {
when(childItem.getNextSibling()).thenReturn(null); when(childItem.getNextSibling()).thenReturn(null);
// When // When
List<Map<String, Object>> result = editTableOfContentsController.extractBookmarks(mockFile); ResponseEntity<List<Map<String, Object>>> response = editTableOfContentsController.extractBookmarks(mockFile);
// Then // Then
assertNotNull(result); assertNotNull(response);
assertNotNull(response.getBody());
List<Map<String, Object>> result = response.getBody();
assertEquals(1, result.size()); assertEquals(1, result.size());
Map<String, Object> parentBookmark = result.get(0); Map<String, Object> parentBookmark = result.get(0);
@@ -177,10 +183,12 @@ class EditTableOfContentsControllerTest {
when(mockOutlineItem.getNextSibling()).thenReturn(null); when(mockOutlineItem.getNextSibling()).thenReturn(null);
// When // When
List<Map<String, Object>> result = editTableOfContentsController.extractBookmarks(mockFile); ResponseEntity<List<Map<String, Object>>> response = editTableOfContentsController.extractBookmarks(mockFile);
// Then // Then
assertNotNull(result); assertNotNull(response);
assertNotNull(response.getBody());
List<Map<String, Object>> result = response.getBody();
assertEquals(1, result.size()); assertEquals(1, result.size());
Map<String, Object> bookmark = result.get(0); Map<String, Object> bookmark = result.get(0);