jackrabbit-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Julian Reschke (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (JCR-4355) Javadoc fixes and improvements for new direct binary access API
Date Thu, 09 Aug 2018 13:05:00 GMT

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

Julian Reschke commented on JCR-4355:

Early feedback:

- please avoid re-adding text that suggests that "charset" is for "text" types - it's really
for media types that define a "charset" parameter (not all text types do, however some application
types do)
- BinaryDownload now duplicates some information from BinaryDownloadOptions, but does not
mention the disposition type at all - I believe it would be better to leave the description
of the options to BinaryDownloadOptions and just link to that

> 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
>         Attachments: JCR-4355.diff
> 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

View raw message