[OAK-7695] [DirectBinaryAccess] Fix and improve javadocs of new API

• Type: Technical task
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Component/s: api
• Assignee: Alexander Klimetschek
• Reporter: Alexander Klimetschek
• Created: 08/Aug/18 17:07
• Updated: 09/Aug/18 06:28
• Resolved: 09/Aug/18 06:28

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

• duplicates: JCR-4355 Javadoc fixes and improvements for new direct binary access API