ZCU-PUB/Add bitstream-level access status/embargo date REST endpoint

[MatusBeke]

Problem

The bitstream-level embargo badge on the frontend (dataquest-dev/dspace-angular#1378) needs to know a restricted bitstream's embargo end date. On DSpace 9.x lines (e.g. customer/mendelu) this is exposed via GET /bitstreams/{id}/accessStatus; on customer/zcu-pub (DSpace 7.6.1) that endpoint doesn't exist — only the item-level equivalent does.

Fixes the backend half of dataquest-dev/dspace-customers#823.

Root cause

Never ported: upstream introduced this in 4 commits on the 9.x line (ed02a605, 43e41e0f, 6a229f15, 0a0b5752), none of which landed on the 7.x/zcu-pub line.

Change set

A raw cherry-pick of those 4 commits was not viable — upstream 9.x uses java.time.LocalDate + jakarta.* and a larger type-parameterized refactor (culminating in a Pair<String, LocalDate> → AccessStatus object replacement) that doesn't fit zcu-pub's simpler joda-time/javax.*/anonymous-only model. Re-derived the minimal intent instead, reusing zcu-pub's existing generalized helper methods (calculateAccessStatusForDso, retrieveShortestEmbargo) rather than duplicating them:

• dspace-api: AccessStatusHelper / DefaultAccessStatusHelper / AccessStatusServiceImpl / AccessStatusService — added getAccessStatusFromBitstream / getEmbargoFromBitstream.
• dspace-server-webapp:
  • AccessStatusRest gains an embargoDate field.
  • BitstreamRest gains an ACCESS_STATUS link.
  • New BitstreamAccessStatusLinkRepository (mirrors ItemAccessStatusLinkRepository; @PreAuthorize on METADATA_READ, matching BitstreamFormatLinkRepository's existing convention).
  • ItemAccessStatusLinkRepository also now populates embargoDate (was status-only, even though the service could already compute it) — a small scope addition beyond strictly "bitstream," done for DTO consistency between the item- and bitstream-level endpoints. Easy to drop if you'd rather keep this PR strictly bitstream-scoped — flagging for review.
• REST contract: GET /server/api/core/bitstreams/{id}/accessStatus -> {status, embargoDate} — field names match what the frontend (PR CLARIN-DSpace v9/Port #1350 + #1347 + #1338 (DOI dedup, Shib special groups, tgz preview) to the v9 base #1378) expects.

Out of scope: the 9.x-specific current-user-vs-anonymous status calculation and the Pair→AccessStatus object refactor (commits 2-4) — not applicable to zcu-pub's simpler anonymous-only model, so only their intent (bitstream embargo exposed via REST) was folded in, not their exact diffs.

Test evidence

mvn checkstyle:check -pl dspace-api                 -> BUILD SUCCESS, no violations
mvn checkstyle:check -pl dspace-server-webapp        -> BUILD SUCCESS, no violations
mvn test -pl dspace-api -Dtest=AccessStatusServiceTest,DefaultAccessStatusHelperTest
                                                      -> Tests run: 16, Failures: 0, Errors: 0
mvn test -pl dspace-server-webapp -Dtest=AccessStatusRestTest
                                                      -> Tests run: 4, Failures: 0, Errors: 0
mvn verify -pl dspace-server-webapp -Dtest=BitstreamRestRepositoryIT
                                                      -> Tests run: 56, Failures: 0, Errors: 0, Skipped: 1 (pre-existing @Ignore, unrelated)

The integration test run surfaced two wrong assumptions in the tests themselves (not production code), both fixed:

1. This fork's @LinkRest has no embedOptional — every declared link auto-embeds, so accessStatus legitimately became a 5th default embed on bitstreams; updated BitstreamMatcher.matchFullEmbeds() to expect it.
2. The bitstream-level link is gated on METADATA_READ, and BitstreamMetadataReadPermissionEvaluatorPlugin denies with 401 (not 404) for a nonexistent bitstream — pre-existing platform behavior, differs from the item-level test; fixed the not-found test's expectation with a comment explaining why.

Risk & rollback

Low risk: additive REST surface (new link + new field on an existing DTO), no changes to existing item-level behavior apart from populating a previously-unset field. Revert is a straight git revert of this PR.

Notes / assumptions

• Companion frontend PR: ZCU-PUB/Show a per-bitstream embargo-date badge in the Item View dspace-angular#1378 (already reflects this exact contract).
• Please double-check the ItemAccessStatusLinkRepository embargoDate addition mentioned above — deliberate scope call, want a second opinion.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ee2033af-91ee-4116-b829-dda21e2d5d71

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[MatusBeke]

Companion frontend PR: dataquest-dev/dspace-angular#1378 (the badge that consumes this endpoint). Tracking issue: dataquest-dev/dspace-customers#823.

[MatusBeke]

Sibling PR for the ZCU-DATA branch (same fix, same REST contract): #1380

[Copilot]

Pull request overview

Adds a bitstream-level accessStatus REST endpoint/link (parity with item-level) and extends the AccessStatusRest DTO to include an embargoDate, enabling the frontend to display a bitstream embargo badge with an end date.

Changes:

• Add GET /api/core/bitstreams/{id}/accessStatus via a new BitstreamAccessStatusLinkRepository and a new accessStatus link on BitstreamRest.
• Extend AccessStatusRest with an embargoDate field, and start populating it for both bitstreams (new) and items (scope expansion).
• Add/adjust unit + integration tests to cover the new DTO field and new bitstream link behavior.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
dspace-server-webapp/src/test/java/org/dspace/app/rest/model/AccessStatusRestTest.java	Adds basic DTO tests for the new embargoDate field.
dspace-server-webapp/src/test/java/org/dspace/app/rest/matcher/BitstreamMatcher.java	Updates expected default embeds/links to include accessStatus.
dspace-server-webapp/src/test/java/org/dspace/app/rest/BitstreamRestRepositoryIT.java	Adds IT coverage for bitstream /accessStatus (bad UUID, not-found/unauthorized, happy path).
dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/ItemAccessStatusLinkRepository.java	Populates embargoDate on item access status responses when status is embargo.
dspace-server-webapp/src/main/java/org/dspace/app/rest/repository/BitstreamAccessStatusLinkRepository.java	New link repository exposing bitstream access status (and embargo date when applicable).
dspace-server-webapp/src/main/java/org/dspace/app/rest/model/BitstreamRest.java	Adds ACCESS_STATUS link declaration on bitstreams.
dspace-server-webapp/src/main/java/org/dspace/app/rest/model/AccessStatusRest.java	Adds embargoDate field + getters/setters and constructor initialization.
dspace-api/src/test/java/org/dspace/access/status/DefaultAccessStatusHelperTest.java	Extends helper tests to cover bitstream access status/embargo behavior.
dspace-api/src/test/java/org/dspace/access/status/AccessStatusServiceTest.java	Extends service tests to cover bitstream access status/embargo methods.
dspace-api/src/main/java/org/dspace/access/status/service/AccessStatusService.java	Adds getAccessStatus(Context, Bitstream) and getEmbargoFromBitstream(...) to the public service API.
dspace-api/src/main/java/org/dspace/access/status/DefaultAccessStatusHelper.java	Implements bitstream-level access status + embargo retrieval.
dspace-api/src/main/java/org/dspace/access/status/AccessStatusServiceImpl.java	Wires new bitstream-level methods through to the helper using the configured threshold date.
dspace-api/src/main/java/org/dspace/access/status/AccessStatusHelper.java	Extends helper interface with bitstream-level access status + embargo retrieval methods.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.