Author: mreutegg
Date: Wed Aug 29 11:32:38 2018
New Revision: 1839567
URL: http://svn.apache.org/viewvc?rev=1839567&view=rev
Log:
OAK-7717: Documentation for direct binary access is unclear
Patch provided by Matt Ryan
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/features/direct-binary-access.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/features/direct-binary-access.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/features/direct-binary-access.md?rev=1839567&r1=1839566&r2=1839567&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-doc/src/site/markdown/features/direct-binary-access.md
(original)
+++
jackrabbit/oak/trunk/oak-doc/src/site/markdown/features/direct-binary-access.md
Wed Aug 29 11:32:38 2018
@@ -19,7 +19,7 @@
`@since Oak 1.10`
-This feature enables a remote client of an Oak-based application to upload or
download binaries directly to/from a supported Oak
[BlobStore](../plugins/blobstore.html), such as [Amazon
S3](https://aws.amazon.com/s3/) or [Microsoft Azure Blob
Storage](https://azure.microsoft.com/en-us/services/storage/blobs/), without
streaming the binaries through the application and Oak itself. Authentication
and acccess control is fully enforced by Oak, as the direct access is resource-
and time-limited.
+This feature enables a remote client of an Oak-based application to upload or
download binaries directly to/from a supported Oak
[BlobStore](../plugins/blobstore.html), without streaming the binaries through
the application and Oak itself. To use the feature, the underlying storage
provider must support this capability and the corresponding Oak BlobStore must
implement feature support. Currently, the feature is implemented in
[S3DataStore](https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/blob/cloud/s3/S3DataStore.html)
(over [Amazon S3](https://aws.amazon.com/s3/)) and
[AzureDataStore](https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/blob/cloud/azure/blobstorage/AzureDataStore.html)
(over [Microsoft Azure Blob
Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)).
Authentication and access control is fully enforced by Oak, as the direct
access is resource- and time-limited.
Using this feature frees an Oak-based web application from the network, memory
and disk I/O involved in transferring binary files, and provides clients of the
application with scalable, redundant and high-bandwidth access directly to the
cloud storage. This eliminates the web application server and its deployment
environment as a potential bottleneck of network capacity. Furthermore, it
allows leveraging CDN or transfer acceleration options of the cloud storage
providers.
