You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-issues@jackrabbit.apache.org by "Alexander Klimetschek (JIRA)" <ji...@apache.org> on 2018/08/08 17:08:00 UTC

[jira] [Created] (OAK-7695) [DirectBinaryAccess] Fix and improve javadocs of new API

Alexander Klimetschek created OAK-7695:
------------------------------------------

             Summary: [DirectBinaryAccess] Fix and improve javadocs of new API
                 Key: OAK-7695
                 URL: https://issues.apache.org/jira/browse/OAK-7695
             Project: Jackrabbit Oak
          Issue Type: Technical task
          Components: api
            Reporter: Alexander Klimetschek
            Assignee: Alexander Klimetschek


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



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)