Dataset files API extension for filters

[GPortas]

What this PR does / why we need it:

We need this API extension to support dataset files tab filters in the new frontend, as well as extend the capabilities of the API for other use cases.

In particular, this API extension includes:

• New optional query parameter accessStatus to getVersionFiles endpoint.
• New optional query parameter contentType to getVersionFiles endpoint.
• New optional query parameter categoryName to getVersionFiles endpoint.

Which issue(s) this PR closes:

• [Spike - API] [2/2] Extend the Files API to support filters #9714

Special notes for your reviewer:

The QueryDSL library has been added to Dataverse, which makes it much easier to build queries dynamically. This library integrates perfectly on top of the existing JPA + Jakarta setup. This library can be used from now on for other different use cases within Dataverse.

Other similar libraries have been studied but have been discarded in favor of QueryDSL, due to its simplicity and size.

Suggestions on how to test this:

The getVersionFiles endpoint integration test has been extended to cover all possible filter values, but manual tests can be done with curl:

Example for accessStatus:

curl -H "X-Dataverse-Key: <YOUR_API_KEY>" -X GET "http://localhost:8080/api/v1/datasets/:persistentId/versions/:latest/files?persistentId=<DATASED_PID>&accessStatus=Restricted"

Will retrieve all restricted files in the specified dataset.

accessStatus query parameter supports the possible values:

• Public
• Restricted
• EmbargoedThenRestricted
• EmbargoedThenPublic

Example for contentType:

curl -H "X-Dataverse-Key: <YOUR_API_KEY>" -X GET "http://localhost:8080/api/v1/datasets/:persistentId/versions/:latest/files?persistentId=<DATASED_PID>&contentType=image/png"

Example for categoryName:

curl -H "X-Dataverse-Key: <YOUR_API_KEY>" -X GET "http://localhost:8080/api/v1/datasets/:persistentId/versions/:latest/files?persistentId=<DATASED_PID>&categoryName=Data"

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

Is there a release notes update needed for this change?:

Yes

Additional documentation:

• http://querydsl.com/static/querydsl/latest/reference/html/ch02.html#jpa_integration

[landreev]

This looks good, based on a very quick look. I will take a closer look and add a more formal review.
I like the idea of adding a dedicated service bean (DataverseVersionFilesServiceBean). I'm wondering if we want to also add a dedicated command - ListVersionFilesCommand? - for this, mirroring the existing ListVersionsCommand.

[landreev]

I moved the PR into ready for QA.
I hope it can be merged soon-ish. Once that's done, I will need to resolve further merge conflicts in my #9883, but that was expected.

[kcondon]

@GPortas I've tested this and it is ready to merge but has merged conflicts. Would you take a look? Thanks.

[GPortas]

@kcondon

I'm analyzing the behavior of JSF following your feedback on #9820 (comment) about the search text filtering.

I have some considerations on this part of your comment: "It also supports file extension but couldn't get it to support file type as displayed on the page".

I have tested the files tab search in JSF for a published dataset and was unable to filter by the file type as displayed. Same occurs for the draft version. Maybe I'm missing something, but I don't think it is supported. I have recorded the behavior for a published dataset:

I assume the reason this search criteria (file type as displayed) is not supported may be that a filter already exists for the file type. (?)

[github-actions]

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:9714-files-api-extension-filters

ghcr.io/gdcc/configbaker:9714-files-api-extension-filters

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.