(Java) SharePoint -- Download a Text File into a String Variable

See more SharePoint Examples

Demonstrates how to download a text file from SharePoint into a string variable.

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 a CSV file that is utf-8 and contains Japanese characters.

    String url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/ChilkatTest/japanese.csv')/$value";

    http.put_AcceptCharset("utf-8");

    String strCsv = http.quickGetStr(url);
    if (http.get_LastMethodSuccess() != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    // The CSV file is contained in strCsv.
    System.out.println("CSV:");
    System.out.println(strCsv);

    // Note: The HTTP response hopefully indicates the charset of the response,
    // and Chilkat should receive the string correctly.  If the response sent by
    // SharePoint does not indicate a charset, or indicates an incorrect charset,
    // then we can instead download the text file as binary data and interpret the
    // bytes ourselves correctly.  For example:  

    CkBinData bd = new CkBinData();
    boolean success = http.QuickGetBd(url,bd);
    if (success != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    // Interpret the bytes correctly as utf-8
    CkStringBuilder sb = new CkStringBuilder();
    sb.AppendBd(bd,"utf-8",0,0);
    System.out.println("CSV:");
    System.out.println(sb.getAsString());
  }
}