DS-3817: Support the DSpace Cover page functionality in the bitstream endpoint #1939
Conversation
… content endpoint
tomdesair
added
the
interface: REST API v7+
| private Pair<InputStream, Long> getBitstreamInputStreamAndSize(Context context, Bitstream bit) throws SQLException, IOException, AuthorizeException { | ||
|
|
||
| if (citationDocumentService.isCitationEnabledForBitstream(bit, context)) { | ||
| return generateBitstreamWithCitation(context, bit); |
There was a problem hiding this comment.
This PR was discussed in today's DSpace 7 meeting. As discussed there (with @abollini and others), we need to have a way to still download the original bitstream, even when the Cover Page feature is enabled. For example, an Administrative user needs to be able to see the original bitstream from the Admin UI, but they may want to also optionally see how the file will look with the Cover Page applied.
We haven't yet decided on the best way to implement this...if the cover page should be a separate endpoint, or maybe there's some sort of parameter that Administrative users can use to still get the original bitstream? Other thoughts welcome.
Meeting notes at: https://wiki.duraspace.org/display/DSPACE/2018-02-01+DSpace+7+Working+Group+Meeting+notes
There was a problem hiding this comment.
This was ported from DSpace 6: https://github.com/DSpace/DSpace/blob/dspace-6.2/dspace-xmlui/src/main/java/org/dspace/app/xmlui/cocoon/BitstreamReader.java#L369
The CitationDocumentService will not add a cover page for admins: https://github.com/DSpace/DSpace/blob/dspace-6.2/dspace-api/src/main/java/org/dspace/disseminate/CitationDocumentServiceImpl.java#L240
So while I agree with the above use case, I think it is an optional nice to have. This PR complies with the DSpace 6 behaviour. So I think it can be merged.
There was a problem hiding this comment.
I see...looks like it was a misunderstanding around what the isCitationEnabledForBitstream() method does. It never returns true for Admin users.
So, I agree with @tomdesair that the original response here need to be rethought. We should review this as-is. This PR is in line with DSpace 6 behavior.
https://jira.duraspace.org/browse/DS-3817
Added the DSpace 6 coverpage implementation to DSpace 7. Also added a JUnit test.
When verifying the functionality, make sure the configuration property
citation-page.enable_globallyis enabled.