[JCR-4355] Javadoc fixes and improvements for new direct binary access API

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.18, 2.17.6
• Component/s: jackrabbit-api
• Assignee: Unassigned
• Reporter: Alexander Klimetschek
• Created: 09/Aug/18 06:26
• Updated: 04/Oct/18 07:19
• Resolved: 22/Aug/18 08:41

Description

Here are some changes to the javadocs for the new API: OAK-7569-api-javadoc-improvements.patch

• more concise descriptions
• correcting some inaccuracies (clients cannot choose whether to do single or multipart upload, multipart might be strictly required depending on the size)
• most importantly the upload algorithm (standard partSize calculation was wrong)
• focus on API users, separated notes to implementors
• for BinaryDownloadOptions added note from which jcr properties a client would normally take these values from
• added security considerations

Issue Links

• is duplicated by: OAK-7695 [DirectBinaryAccess] Fix and improve javadocs of new API