Adds API for direct binary access #59
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776421 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776533 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776535 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776576 13f79535-47bb-0310-9956-ffa450edef68
…ated custom tags - @test git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776907 13f79535-47bb-0310-9956-ffa450edef68
…ated custom tags - @executeClass git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776911 13f79535-47bb-0310-9956-ffa450edef68
…ated custom tags - @Keywords git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776912 13f79535-47bb-0310-9956-ffa450edef68
…ated custom tags - @sources git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776914 13f79535-47bb-0310-9956-ffa450edef68
…ated custom tags - @tck.config git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1776918 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1777156 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1777759 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1777949 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1777951 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1778270 13f79535-47bb-0310-9956-ffa450edef68
…de() git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1779166 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1779460 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1779614 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1779632 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780208 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780220 13f79535-47bb-0310-9956-ffa450edef68
…and minin type based inheritance. Currently it appears that only primaryType based inheritance is working git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780335 13f79535-47bb-0310-9956-ffa450edef68
…and minin type based inheritance. Currently it appears that only primaryType based inheritance is working git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780336 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780384 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1780406 13f79535-47bb-0310-9956-ffa450edef68
…ts initializing git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1782145 13f79535-47bb-0310-9956-ffa450edef68
…ts initializing git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1782173 13f79535-47bb-0310-9956-ffa450edef68
- Using SHA-256 instead of SHA-1 to create blob record ids git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1785225 13f79535-47bb-0310-9956-ffa450edef68
Candidate Release Notes git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1785264 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1785460 13f79535-47bb-0310-9956-ffa450edef68
git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/trunk@1785462 13f79535-47bb-0310-9956-ffa450edef68
added 10 commits
July 13, 2018 15:04
- contentType=>mimeType - contentTypeEncoding=>encoding - Adds javadoc for BinaryDownloadOptions and BinaryDownloadOptionsBuilder - Makes BinaryDownloadOptions and BinaryDownloadOptionsBuilder final classes.
reschke
reviewed
Jul 23, 2018
| * then the client cannot proceed and will have to request a new set of URIs | ||
| * with the right fileSize as maxSize | ||
| * <li>If fileSize is smaller than minPartSize, then take the first provided | ||
| * upload URI to upload the entire binary, with partSize = fileSize</li> |
There was a problem hiding this comment.
shouldn't this be maxPartSize?
reschke
reviewed
Jul 23, 2018
| * next URI from uploadURIs (strictly in order), proceed with a standard | ||
| * HTTP PUT for each, and for the last part use whatever segment size is | ||
| * left | ||
| * <li>If a segment fails during upload, retry (up to a certain time out) |
There was a problem hiding this comment.
HTTP PUT if a HTTP(s) URI, otherwise to-be-determined...
reschke
reviewed
Jul 23, 2018
| * @return A {@link BinaryUpload} that can be used by the client to complete | ||
| * the upload via a call to {@link #completeBinaryUpload(String)}, | ||
| * or {@code null} if the implementation does not support the direct | ||
| * upload feature. |
There was a problem hiding this comment.
This should throw an exception instead of returning null.
(should we also define a repository descriptor maybe?)
reschke
reviewed
Jul 23, 2018
| * <p> | ||
| * The implementation will attempt to apply the specified {@code | ||
| * downloadOptions} to the subsequent download. For example, if the caller | ||
| * knows that the URL refers to a specific type of content, the caller can |
reschke
reviewed
Jul 23, 2018
| * if the caller wishes to accept the service provider's default | ||
| * behavior. | ||
| * @return A URI for downloading the binary directly, or {@code null} if the | ||
| * binary cannot be downloaded directly or if the underlying |
There was a problem hiding this comment.
Should throw instead of returning null.
reschke
reviewed
Jul 23, 2018
|
|
||
| /** | ||
| * Returns the MIME type that should be assumed for the binary that is to be | ||
| * downloaded. This value should be a valid {@code jcr:mimeType}. This |
There was a problem hiding this comment.
"MIME" -> "Internet Media Type"
FWIW, maybe we should also not copy JCR's splitting of type and charset, and just provide the complete value for the Content-Type header field.
reschke
reviewed
Jul 23, 2018
|
|
||
| /** | ||
| * Returns the encoding that should be assumed for the binary that is to be | ||
| * downloaded. This value should be a valid {@code jcr:encoding}. This |
There was a problem hiding this comment.
"encoding" -> "character encoding"
reschke
reviewed
Jul 23, 2018
| * instance of this class. | ||
| * | ||
| * @return A String representation of the encoding, or {@code null} if no | ||
| * encoding has been specified. |
There was a problem hiding this comment.
The encoding is a name, so I think that "String representation" is confusing here.
reschke
reviewed
Jul 23, 2018
| * BinaryDownloadOptionsBuilder#withDispositionTypeInline()} or {@link | ||
| * BinaryDownloadOptionsBuilder#withDispositionTypeAttachment()} when | ||
| * building an instance of this class. The default value of this setting is | ||
| * "attachment". |
reschke
reviewed
Jul 23, 2018
| * Note that if the MIME type is text-based, the caller may also wish to | ||
| * set the encoding which is done separately. See {@link | ||
| * #withEncoding(String)}. | ||
| * <p> |
There was a problem hiding this comment.
"Note that if the internet media type defines a charset parameter, ...."
reschke
reviewed
Jul 23, 2018
| * Calling this method has the effect of instructing the service | ||
| * provider to set {@code encoding} as the encoding of the content type | ||
| * in the {@code Content-Type} header of the response to a request | ||
| * issued with a URI obtained by calling {@link |
There was a problem hiding this comment.
"header" -> "header field"
reschke
reviewed
Jul 23, 2018
| * call to {@link #build()}. | ||
| * <p> | ||
| * If no filename is provided, no {@code Content-Disposition} header | ||
| * will be specified to the service provider. |
There was a problem hiding this comment.
I think we'll need to define the case of no filename but non-default disposition type.
- terminology (mime type -> internet media type, encoding -> character encoding) - add links to RFC 6266 - make disposition type "inline" default - break the connection between disposition type and filename
Default value is "inline" as was documented before. This change makes sure that a value is always set, that inline is the default, and that the getter is declared as always returning a value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This supports an optional feature to do direct binary upload and download as described in https://wiki.apache.org/jackrabbit/Direct%20Binary%20Access. This change includes new interfaces and exceptions that comprise the API for this feature.