(PureBasic) Glacier Download Archive

Demonstrates how to download an Amazon Glacier archive. Downloading a Glacier archive is a two step process. First an archive retrieval job is initiated. After it completes, the job output is downloaded (i.e. the archive contents are downloaded.)

Note: This example requires Chilkat v9.5.0.78 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStream.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Amazon AWS REST server in the desired region.
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"glacier.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

    ; Provide AWS credentials.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    CkAuthAws::setCkServiceName(authAws, "glacier")
    CkAuthAws::setCkRegion(authAws, "us-west-2")

    success = CkRest::ckSetAuthAws(rest,authAws)

    ; --------------------------------------------------------------------------
    ; Note: The above REST connection and setup of the AWS credentials
    ; can be done once.  After connecting, any number of REST calls can be made.
    ; The "auto reconnect" property passed to rest.Connect indicates that if
    ; the connection is lost, a REST method call will automatically reconnect
    ; if needed.
    ; --------------------------------------------------------------------------

    ; 
    ; For more information, see Glacier Retrieve Job Output Reference Documentation
    ; 
    CkRest::ckAddHeader(rest,"x-amz-glacier-version","2012-06-01")

    ; To download an archive, we'll make several method calls:
    ; 1) Send the HTTPS GET request.
    ; 2) Get the response body.
    ; 3) If the response status code indicates success, stream the response body (i.e the archive data) to a file.
    ; 4) If the response status code indicates an error, get the JSON error response.

    ; Send the GET request.
    success = CkRest::ckSendReqNoBody(rest,"GET","/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID/output")
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; Read the response header.
    responseStatusCode.i = CkRest::ckReadResponseHeader(rest)
    If responseStatusCode < 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(responseStatusCode)

    ; We expect a 200 response status if the archive data is coming.
    ; Otherwise, we'll get a JSON response body with an error message(or no response body).
    If responseStatusCode = 200

        bodyStream.i = CkStream::ckCreate()
        If bodyStream.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        ; The stream's sink will be a file.
        CkStream::setCkSinkFile(bodyStream, "qa_output/archiveData.dat")

        ; Read the response body to the stream.
        success = CkRest::ckReadRespBodyStream(rest,bodyStream,1)
        If success <> 1
            Debug CkRest::ckLastErrorText(rest)
            CkRest::ckDispose(rest)
            CkAuthAws::ckDispose(authAws)
            CkStream::ckDispose(bodyStream)
            ProcedureReturn
        EndIf

        Debug "Successfully received the archive file."

    Else
        jsonError.s = CkRest::ckReadRespBodyString(rest)
        If CkRest::ckLastMethodSuccess(rest) <> 1
            Debug CkRest::ckLastErrorText(rest)
        Else
            Debug jsonError
        EndIf

    EndIf



    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkStream::ckDispose(bodyStream)


    ProcedureReturn
EndProcedure