(Xojo Plugin) AWS S3 File Streaming Upload

Demonstrates how to do a streaming upload from a file to the AWS S3 storage service. The AWS authorization presents some difficulties when the REST request body is to be streamed from a file (or from some other source). The issue is that the SHA-256 hash of the file data must be calculated. There are only two possible ways to do this: (1) stream the file into memory in its entirety and calculate the SHA-256 hash prior to uploading, or (2) pre-calculate the SHA-256 in a streaming fashion, and then provide it to the AWS authentication object.

If the application does NOT pre-compute the SHA-256, then Chilkat (internally) is forced to stream into memory, calculate the SHA-256, and then upload from the in-memory copy of the file.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This first part is optional.  AWS authentication requires
// the SHA-256 hash of the request body (i.e. the contents of the file
// to be uploaded).  We can choose to pre-calculate the SHA-256 in a streaming fashion
// and then provide it to the authenticator object.  This way, if the file is
// extremely large, it never needs to completely reside in memory.
Dim crypt As New Chilkat.Crypt2
crypt.EncodingMode = "hex"
crypt.HashAlgorithm = "sha-256"
Dim fileToUploadPath As String
fileToUploadPath = "qa_data/xml/hamlet.xml"
Dim hashStr As String
hashStr = crypt.HashFileENC(fileToUploadPath)

Dim rest As New Chilkat.Rest

// Connect to the Amazon AWS REST server.
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("s3.amazonaws.com",port,bTls,bAutoReconnect)

// ----------------------------------------------------------------------------
// Important: For buckets created in regions outside us-east-1,
// there are three important changes that need to be made.
// See Working with S3 Buckets in Non-us-east-1 Regions for the details.
// ----------------------------------------------------------------------------

// Provide AWS credentials for the REST call.
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
authAws.ServiceName = "s3"
// Provide the pre-computed SHA-256 here:
authAws.PrecomputedSha256 = hashStr

success = rest.SetAuthAws(authAws)

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat100".
rest.Host = "chilkat100.s3.amazonaws.com"

Dim fileStream As New Chilkat.Stream
fileStream.SourceFile = fileToUploadPath

// Upload to the S3 Storage service.
// If the application provided the SHA-256 hash of the file contents (as shown above)
// then file is streamed and never has to completely reside in memory.
// If the application did NOT provide the SHA-256, then Chilkat will (internally) 
// load the entire file into memory, calculate the SHA-256, and then upload.
Dim responseStr As String
responseStr = rest.FullRequestStream("PUT","/hamlet.xml",fileStream)
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// When successful, the S3 Storage service will respond with a 200 response code,
// with an XML body.  
If (rest.ResponseStatusCode = 200) Then
    System.DebugLog(responseStr)
    System.DebugLog("File uploaded.")
Else
    // Examine the request/response to see what happened.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body: " + responseStr)
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
End If