[CONF] Apache Sling > Chunked File Upload Support

[confluence]

Chunked File Upload Support Page edited by Shashank Gupta Changes (13) ... {code:title= Upload the first/intermediate chunk request} Request: POST /content/dam/dam-folder/asset.pdf.chunk.<chunk_number>.res HTTP/1.1 PATCH /content/dam/dam-folder/catalog.pdf.chunk.<chunk_number>.res HTTP/1.1 Host: localhost:4502 Content-Type: ... HTTP/1.1 201 CREATED Content-Length: 0 Location: /content/dam/dam-folder/catalog.pdf.chunk Connection: close Server: localhost:4502 {code} The location header provides path to retrieve chunk upload attributes. h4. Upload of last chunk ... {code:title= Upload last chunk request} Request: POST /content/dam/dam-folder/asset.pdf.chunk.<chunk_number>.res/last HTTP/1.1 PATCH /content/dam/dam-folder/catalog.pdf.chunk.<chunk_number>.res/last HTTP/1.1 Host: localhost:4502 Date: <date> ... 210000000 --AaB03x content-disposition: form-data; name="file"; fileName="asset.pdf" fileName="catalog.pdf" Content-Type: application/pdf Content-Transfer-Encoding: binary ... HTTP/1.1 201/CREATED Content-Length: 0 Location: /content/dam/dam-folder/catalog.pdf Content-MD5: <md5 checksum of the merged file> Connection: close {code} The location header provides location of fully uploaded asset. h4. Query to retrieve last successful chunk upload Returns the number of last chunk upload and bytes uploaded successfully on sling. {code:title= Get last successful chunk upload request} Request GET /content/dam/dam-folder/asset.pdf.chunk.json /content/dam/dam-folder/catalog.pdf.chunk.json HTTP/1.1 Host: localhost:4502 Date: <date> ... {code:title= Abort chunked upload Request} Request DELETE /content/dam/dam-folder/asset.pdf.chunk.res /content/dam/dam-folder/catalog.pdf.chunk.res HTTP/1.1 Host: localhost:4502 Date: <date> ... Connection: close {code} h4. Query sling's capability to support chunked upload Client can use option method to query Sling's capability to support chunked upload. In response, the Allow header contains PATCH method, indicating that Sling supports chunked upload on the url. {code:title= Options chunked upload request} Request OPTIONS /content/dam/dam-folder/catalog.pdf.chunk.res HTTP/1.1 Host: localhost:4502 Date: <date> {code} {code:title= Options chunked upload response} Response HTTP/1.1 200 OK Connection: Keep-Alive Allow: OPTIONS, GET, PATCH {code} Full Content 1 Chunked File Upload 2 Use Cases: 3 Approach 4 Protocol Specification 4.1 Upload of first and intermediate chunks 4.2 Upload of last chunk 4.3 Query to retrieve last successful chunk upload 4.4 Abort chunked upload 4.5 Query sling's capability to support chunked upload Chunked File Upload Status: DRAFT Created: 20. January 2013 Author: shgupta JIRA: SLING-2707 References: - http://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html Updated: - Use Cases: 1. Large file upload - With high speed internet connections, advent of cloud and HD going mainstream, Sling support large files (> 2GB) upload. 2. Fault tolerant uploads - Sling provides capability to resume upload from failure point. It doesn't require client to restart the complete upload process. Approach Sling provides an endpoint which accepts file chunks in accordance with a specified protocol. Sling client slices the file in chunks, and upload the chunks in serial manner to server. Each chunk is numbered serially and the last chunk has additional identifier to distinguish from the rest chunks. Sling endpoint upon receiving the last chunk, stitches all chunks into a single file. The file inputstream is passed to inner layers for further processing. In case of upload failures, sling provides support to query the last chunk uploaded till failure point. Client resumes chunk upload from last failure point. Protocol Specification Upload of first and intermediate chunks Upload the first/intermediate chunk request Request: PATCH /content/dam/dam-folder/catalog.pdf.chunk.<chunk_number>.res HTTP/1.1 Host: localhost:4502 Content-Type: Date: <date> Content-Length: 5242880 First/Intermediate chunk upload response Response: HTTP/1.1 201 CREATED Content-Length: 0 Location: /content/dam/dam-folder/catalog.pdf.chunk Connection: close Server: localhost:4502 The location header provides path to retrieve chunk upload attributes. Upload of last chunk Client appends "/last" to upload url to signify that it would be last that needs to be uploaded. The last chunk upload request can optionally be multipart request if client requires to send additional parameters to sling. Upload last chunk request Request: PATCH /content/dam/dam-folder/catalog.pdf.chunk.<chunk_number>.res/last HTTP/1.1 Host: localhost:4502 Date: <date> Content-type: multipart/form-data, boundary=AaB03x --AaB03x content-disposition: form-data; name="fileSize" 210000000 --AaB03x content-disposition: form-data; name="file"; fileName="catalog.pdf" Content-Type: application/pdf Content-Transfer-Encoding: binary $binarydata --AaB03x-- Upload last chunk response Response: HTTP/1.1 201/CREATED Content-Length: 0 Location: /content/dam/dam-folder/catalog.pdf Content-MD5: <md5 checksum of the merged file> Connection: close The location header provides location of fully uploaded asset. Query to retrieve last successful chunk upload Returns the number of last chunk upload and bytes uploaded successfully on sling. Get last successful chunk upload request Request GET /content/dam/dam-folder/catalog.pdf.chunk.json HTTP/1.1 Host: localhost:4502 Date: <date> Content-Length: 0 Get last successful upload chunk response Response: HTTP/1.1 200/OK Connection: close { "chunkNumber": 8 "bytesuploaded": 19872 } If no broken/discontinued upload sling returns 404 not found response. Get erroneous last successful upload chunk response Response: HTTP/1.1 404/Not Found Abort chunked upload Abort chunked upload Request Request DELETE /content/dam/dam-folder/catalog.pdf.chunk.res HTTP/1.1 Host: localhost:4502 Date: <date> Abort chunked upload response Response HTTP/1.1 200/OK Connection: close Query sling's capability to support chunked upload Client can use option method to query Sling's capability to support chunked upload. In response, the Allow header contains PATCH method, indicating that Sling supports chunked upload on the url. Options chunked upload request Request OPTIONS /content/dam/dam-folder/catalog.pdf.chunk.res HTTP/1.1 Host: localhost:4502 Date: <date> Options chunked upload response Response HTTP/1.1 200 OK Connection: Keep-Alive Allow: OPTIONS, GET, PATCH Change Notification Preferences View Online | View Changes | Add Comment