(Java) SharePoint -- Download File

Demonstrates how to download a file from SharePoint located in the /Documents folder.

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 requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    //  -------------------------------------------------------------------------
    //  The following comments apply to SharePoint Windows classic authentication.
    //  -------------------------------------------------------------------------
    //  For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
    //  The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
    //  The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
    //  Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
    //  for example, "chilkat" instead of "chilkat@mycompany.com"

    CkHttp http = new CkHttp();

    //  If SharePoint Windows classic authentication is used, then set the
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    http.put_Login("SHAREPOINT_USERNAME");
    http.put_Password("SHAREPOINT_PASSWORD");
    http.put_LoginDomain("SHAREPOINT_NTLM_DOMAIN");
    http.put_NtlmAuth(true);

    //  -------------------------------------------------------------------------
    //  The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    //  If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    //  establish the cookie as shown at SharePoint Online Authentication
    //  -------------------------------------------------------------------------

    //  This example downloads the file named "Domain Name created for Exchange.docx"

    //  Note: I was initially confused by the "$value" part of the URL.
    //  When I see something like $value, I immediately think that it's some sort of
    //  variable or placeholder to be replaced with an actual value.  In this case,
    //  the "$value" is literally part of the URL.  It's not replace with anything.

    String url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('Domain Name created for Exchange.docx')/$value";
    String localFilePath = "qa_output/x.docx";

    boolean success = http.Download(url,localFilePath);
    if (success != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    System.out.println("File successfully downloaded from SharePoint.");
  }
}