jackrabbit-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexander Klimetschek (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (JCR-4355) Javadoc fixes and improvements for new direct binary access API
Date Wed, 22 Aug 2018 08:12:00 GMT

    [ https://issues.apache.org/jira/browse/JCR-4355?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16588519#comment-16588519

Alexander Klimetschek commented on JCR-4355:

Latest patch:
* [^JCR-4355-v3.patch]
* [^JCR-4355-v3-javadoc-html.zip] 

I took [~reschke]'s patch and did these further changes:
* better formatting and formulas in upload algorithm
* removed unclear "support multi-part uploads by reusing a single URI multiple times" paragraph
as mentioned above
* using "if the media type defines a charset" everywhere
* fixed some formatting issues: {{<li>}} and {{<h3>}} inside methods (security

I consider the patch ready for committing.

> Javadoc fixes and improvements for new direct binary access API
> ---------------------------------------------------------------
>                 Key: JCR-4355
>                 URL: https://issues.apache.org/jira/browse/JCR-4355
>             Project: Jackrabbit Content Repository
>          Issue Type: Improvement
>          Components: jackrabbit-api
>            Reporter: Alexander Klimetschek
>            Priority: Major
>             Fix For: 2.18
>         Attachments: JCR-4355-jr.diff, JCR-4355-v2-javadoc-html.zip, JCR-4355-v2.patch,
JCR-4355-v3-javadoc-html.zip, JCR-4355-v3.patch, JCR-4355.diff
> Here are some changes to the javadocs for the new API: [OAK-7569-api-javadoc-improvements.patch|https://issues.apache.org/jira/secure/attachment/12934364/12934364_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

View raw message