Dart

Glacier Download Archive

See more Amazon Glacier Examples

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.

Dart

import 'package:chilkat/chilkat.dart';

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

  final rest = CkRest();

  // Connect to the Amazon AWS REST server in the desired region.
  final bTls = true;
  final port = 443;
  final bAutoReconnect = true;
  rest.connect('glacier.us-west-2.amazonaws.com', port, bTls, bAutoReconnect);

  // Provide AWS credentials.
  final authAws = CkAuthAws();
  authAws.accessKey = 'AWS_ACCESS_KEY';
  authAws.secretKey = 'AWS_SECRET_KEY';
  authAws.serviceName = 'glacier';
  authAws.region = 'us-west-2';

  rest.setAuthAws(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
  // 
  rest.addHeader('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.
  try {
    rest.sendReqNoBody('GET', '/AWS_ACCOUNT_ID/vaults/chilkat/jobs/JOB_ID/output');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Read the response header.
  final responseStatusCode = rest.readResponseHeader();
  if (responseStatusCode < 0) {
    print(rest.lastErrorText);
    return;
  }

  print('Response status code = $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) {

    final bodyStream = CkStream();

    // The stream's sink will be a file.
    bodyStream.sinkFile = 'qa_output/archiveData.dat';

    // Read the response body to the stream.
    try {
      rest.readRespBodyStream(bodyStream, true);
    } on ChilkatException catch (e) {
      print(e.lastErrorText);
      return;
    }

    print('Successfully received the archive file.');
  } else {
    try {
      final jsonError = rest.readRespBodyString();
      print(jsonError);
    } on ChilkatException catch (e) {
      print(e.lastErrorText);
    }
  }
}