Fork me on GitHub

Direct Binary Access upload file process using SSE Encryption

The direct binary upload process is split into 3 phases

The remote client performs the actual binary upload directly to the binary storage provider. The BinaryUpload returned to initiateBinaryUpload(long, int) contains detailed instructions on how to complete the upload successfully. For more information, see the BinaryUpload documentation.

Example A: Here’s how to initiateHttpUpload:

long ONE_GB = 1048576000;
int dataLength = 123456;

/*Pre-set all the properties for SSE before this */

DataRecordUpload uploadContext = initiateHttpUpload(ONE_GB, 1);
String uploadToken = uploadContext.getUploadToken();
byte[] data = new byte[dataLength];
Random randomGen = new Random();

/*StatusCode returned in CloseableHttpResponse should be 200 */
CloseableHttpResponse resultHttpStatusCode = httpPut(uploadContext, new ByteArrayInputStream(data), data.length);

Here’s how to make use of the context returned by the initiateHttpUpload in Example A to upload a file using different SSE Encryption:

CloseableHttpResponse httpPut(@Nullable DataRecordUpload uploadContext, InputStream inputstream, long length) throws IOException  {
    // this weird combination of @Nullable and assertNotNull() is for IDEs not warning in test methods
    URI puturl = uploadContext.getUploadURIs().iterator().next();
    HttpPut putreq = new HttpPut(puturl);

    String keyId = null;
    String encryptionType = props.getProperty(s3Encryption);

    if (encryptionType.equals(SSE_KMS)) {
       keyId = props.getProperty(kmsKeyId);
       putreq.addHeader(new BasicHeader(Headers.SERVER_SIDE_ENCRYPTION,
       if(keyId != null) {
           putreq.addHeader(new BasicHeader(Headers.SERVER_SIDE_ENCRYPTION_AWS_KMS_KEYID,

    putreq.setEntity(new InputStreamEntity(inputstream , length));
    CloseableHttpClient httpclient = HttpClients.createDefault();
    CloseableHttpResponse response  = httpclient.execute(putreq);
    return response;

Here is an example of a test case where initiate, upload and complete binary upload phases are shown.