(Java) eBay -- Download Data using FileTransferService

Demonstrates how to download a data file using the eBay File Transfer API.

Note: This example requires Chilkat v9.5.0.67 or later.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Use a previously obtained access token.  The token should look something like this:
    // "AgAAAA**AQA ..."
    String accessToken = "EBAY_ACCESS_TOKEN";

    CkHttp http = new CkHttp();

    CkHttpRequest req = new CkHttpRequest();

    req.put_HttpVerb("POST");
    req.put_Path("/FileTransferService");
    req.put_ContentType("application/xml");

    // Build the XML body for the request.
    CkXml xml = new CkXml();
    xml.put_Tag("downloadFileRequest");
    xml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services");
    xml.UpdateChildContent("taskReferenceId","50013004806");
    xml.UpdateChildContent("fileReferenceId","50015579016");

    req.LoadBodyFromString(xml.getXml(),"utf-8");

    // The XML body looks like this:

    // 	<?xml version="1.0" encoding="UTF-8"?>
    // 	<downloadFileRequest xmlns="http://www.ebay.com/marketplace/services">
    // 	<taskReferenceId>50013004806</taskReferenceId>
    // 	<fileReferenceId>50015579016</fileReferenceId>
    // 	</downloadFileRequest>

    req.AddHeader("X-EBAY-SOA-OPERATION-NAME","downloadFile");
    req.AddHeader("X-EBAY-SOA-SECURITY-TOKEN",accessToken);

    CkHttpResponse resp = http.SynchronousRequest("storage.sandbox.ebay.com",443,true,req);
    if (http.get_LastMethodSuccess() != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    int statusCode = resp.get_StatusCode();
    System.out.println("Response status code = " + statusCode);

    CkBinData responseBody = new CkBinData();
    resp.GetBodyBd(responseBody);

    // We can save the response body to a file for examination if we get an unanticipated response.  
    // (It's binary, so it won't open well in a text editor.)
    responseBody.WriteFile("qa_output/response.mime");

    if (statusCode != 200) {
        System.out.println("Failed.");
        return;
        }

    // The response body looks like this:

    // 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
    // 	Content-Type: application/xop+xml; charset=utf-8; type="text/xml"
    // 	Content-Transfer-Encoding: binary
    // 	Content-ID: <0.urn:uuid:2B668636C1E17A4D4114925305818684242>
    // 
    // 	<?xml version='1.0' encoding='UTF-8'?>
    // 	<downloadFileResponse xmlns="http://www.ebay.com/marketplace/services">
    // 	<ack>Success</ack>
    // 	<version>1.1.0</version>
    // 	<timestamp>2017-04-18T15:49:41.868Z</timestamp>
    // 	<fileAttachment>
    // 	    <Size>587</Size>
    // 	    <Data>
    //                 <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:urn:uuid:A37C3C73E994C267F11492530585522"/>
    // 	    </Data>
    // 	</fileAttachment>
    // 	</downloadFileResponse>
    // 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
    // 	Content-Type: application/zip
    // 	Content-Transfer-Encoding: binary
    // 	Content-ID: <urn:uuid:A37C3C73E994C267F11492530585522>
    // 
    // 	<the binary bytes of the zip start here...>
    // 

    // Load the binary response into a MIME object.
    CkMime mime = new CkMime();
    boolean success = mime.LoadMimeBd(responseBody);
    if (success != true) {
        System.out.println(mime.lastErrorText());
        return;
        }

    // Make sure we have 2 sub-parts.  The 1st sub-part is the XML response, the 2nd sub-part
    // is the zip containing the data.

    // Note: The 2nd sub-part can be a "zip" or "gzip".  These are two different file formats.
    // A zip is indicated with a Content-Type header equal to "application/zip",
    // whereas a gzip is indicated with a Content-Type header equal to "application/x-gzip"
    if (mime.get_NumParts() != 2) {
        System.out.println("Expected the MIME to have 2 parts.");
        System.out.println("NumParts = " + mime.get_NumParts());
        System.out.println("Failed.");
        return;
        }

    // Get the XML from the 1st MIME sub-part.
    CkMime part0 = mime.GetPart(0);
    String downloadResponseXml = part0.getBodyDecoded();
    CkXml xmlResp = new CkXml();
    xmlResp.LoadXml(downloadResponseXml);
    System.out.println("Download Response XML:");
    System.out.println(xmlResp.getXml());

    System.out.println("----");

    // Now get the zip from the second part (index=1), unzip, and examine..
    CkMime part1 = mime.GetPart(1);
    CkBinData zipData = new CkBinData();
    // This example requires Chilkat v9.5.0.67 or later.
    // The GetBodyBd method was added in v9.5.0.67.
    part1.GetBodyBd(zipData);

    // Check to see if we have a zip or gzip.
    CkStringBuilder sbContentType = new CkStringBuilder();
    sbContentType.Append(part1.contentType());

    CkXml xmlFromZip = new CkXml();

    if (sbContentType.Contains("gzip",false) == true) {
        // This is a gzip compressed file.
        CkGzip gzip = new CkGzip();

        // in-place uncompress the data.
        // Note: The UncompressBd method was added in Chilkat v9.5.0.67
        success = gzip.UncompressBd(zipData);
        if (success != true) {
            System.out.println(gzip.lastErrorText());
            return;
            }

        xmlFromZip.LoadXml(zipData.getString("utf-8"));

        }
    else {
        // This is a zip archive.

        // Load the body into a Zip object.
        CkZip zip = new CkZip();
        success = zip.OpenBd(zipData);
        if (success != true) {
            System.out.println(zip.lastErrorText());
            return;
            }

        // Save the .zip to a file (so we can examine it for debugging if something is not as expected)
        zipData.WriteFile("qa_output/ebay_data.zip");

        // The zip should contain a single XML file.
        if (zip.get_NumEntries() != 1) {
            System.out.println("Expected the .zip to have 1 entry.");
            System.out.println("NumEntries = " + zip.get_NumEntries());
            System.out.println("Failed.");
            return;
            }

        CkZipEntry entry = zip.GetEntryByIndex(0);

        xmlFromZip.LoadXml(entry.unzipToString(0,"utf-8"));

        }

    System.out.println("XML contained in the zip:");
    System.out.println(xmlFromZip.getXml());
    System.out.println("----");

    System.out.println("Success.");
  }
}