PowerBuilder

REST Read Binary Response into BinData Object (Amazon S3)

Demonstrates how to make a REST call that returns a binary response body. This example is valid for files that fit in memory. The example shows how to download a JPG from the Amazon S3 service. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_AuthAws
integer li_ResponseStatusCode
string ls_ErrResponse
oleobject loo_BdBody

li_Success = 0

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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to the Amazon AWS REST server.
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("s3.amazonaws.com",li_Port,li_BTls,li_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.
loo_AuthAws = create oleobject
li_rc = loo_AuthAws.ConnectToNewObject("Chilkat.AuthAws")

loo_AuthAws.AccessKey = "AWS_ACCESS_KEY"
loo_AuthAws.SecretKey = "AWS_SECRET_KEY"
loo_AuthAws.ServiceName = "s3"
li_Success = loo_Rest.SetAuthAws(loo_AuthAws)

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

// Send the request to download the JPG.
li_Success = loo_Rest.SendReqNoBody("GET","/starfish.jpg")
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    return
end if

// Read the response header.
li_ResponseStatusCode = loo_Rest.ReadResponseHeader()
if li_ResponseStatusCode < 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    return
end if

Write-Debug "Response status code = " + string(li_ResponseStatusCode)

// We expect a 200 response status if the JPG data is coming.
// Otherwise, we'll get a string response body with an error message(or no response body).
if li_ResponseStatusCode <> 200 then
    ls_ErrResponse = loo_Rest.ReadRespBodyString()
    if loo_Rest.LastMethodSuccess <> 1 then
        Write-Debug loo_Rest.LastErrorText
    else
        Write-Debug ls_ErrResponse
    end if

    destroy loo_Rest
    destroy loo_AuthAws
    return
end if

loo_BdBody = create oleobject
li_rc = loo_BdBody.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Rest.ReadRespBd(loo_BdBody)
if li_Success = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_BdBody
    return
end if

// Save the contents of the response body to a file.
li_Success = loo_BdBody.WriteFile("qa_output/starfish.jpg")
if li_Success = 1 then
    Write-Debug "Success"
else
    Write-Debug "Failed to write file."
end if



destroy loo_Rest
destroy loo_AuthAws
destroy loo_BdBody