(Java) SharePoint -- Download Newer Files

See more SharePoint Examples

Demonstrates how to download all files from a SharePoint folder that are newer than the local files.

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
    // -------------------------------------------------------------------------

    // First we'll download a list of all the files in the /Documents folder.
    // This provides the names and last-modified date/times of the files located
    // on the SharePoint server.
    http.put_Accept("application/json;odata=verbose");
    http.put_AcceptCharset("utf-8");

    CkStringBuilder sbJson = new CkStringBuilder();
    boolean success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",sbJson);
    if (success != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    // Before proceeding, make sure the local directory where we'll be downloading files exists.
    CkFileAccess fac = new CkFileAccess();
    fac.DirEnsureExists("qa_output/sharepoint/Documents");

    // OK.. load the JSON and iterate over each file
    CkJsonObject json = new CkJsonObject();
    json.LoadSb(sbJson);

    int numFiles = json.SizeOfArray("d.results");
    System.out.println("Number of Files in the SharePoint /Documents folder = " + numFiles);

    CkDateTime lastModRemote = new CkDateTime();
    CkDateTime lastModLocal;

    CkStringBuilder localPath = new CkStringBuilder();
    CkStringBuilder fileUrl = new CkStringBuilder();

    int i = 0;
    while (i < numFiles) {
        json.put_I(i);

        String filename = json.stringOf("d.results[i].Name");
        String sLastModified = json.stringOf("d.results[i].TimeLastModified");

        System.out.println((i+1) + ": " + filename + " (" + sLastModified + ")");

        lastModRemote.SetFromTimestamp(sLastModified);

        boolean bDownload = false;
        // Check to see if the local file exists.  If not, then download.
        localPath.SetString("qa_output/sharepoint/Documents/");
        localPath.Append(filename);
        if (fac.FileExists(localPath.getAsString()) != true) {
            System.out.println("This file does not exist locally.");
            bDownload = true;
            }
        else {
            // Get the local file's date time and compare with the remote file date/time.
            lastModLocal = fac.GetLastModified(localPath.getAsString());
            if (fac.get_LastMethodSuccess() == true) {
                // Get the difference in seconds between the local and remote last-modified times.
                // if the return value is negative, then the caller's time is 
                // older than the argument.  (in this case, a negative return value means
                // the local file is older than the remote file.

                // Note: The DiffSeconds method was found to be missing in the Chilkat .NET build
                // (and possibly in other builds). It will be present in the v9.5.0.67 release and later.
                int numSeconds = lastModLocal.DiffSeconds(lastModRemote);
                if (numSeconds < 0) {
                    System.out.println("The local file is older than the remote file.");
                    bDownload = true;
                    }

                }
            else {
                System.out.println("Unable to get the local file's last-modified date/time.");
                System.out.println(fac.lastErrorText());
                }

            }

        if (bDownload == true) {
            fileUrl.SetString("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files('");
            fileUrl.Append(filename);
            fileUrl.Append("')/$value");

            System.out.println("Downloading " + filename);

            success = http.Download(fileUrl.getAsString(),localPath.getAsString());
            if (success != true) {
                System.out.println(http.lastErrorText());
                return;
                }

            // Set the local file's last-modified date/time to that of the server's.
            fac.SetLastModified(localPath.getAsString(),lastModRemote);

            }

        i = i+1;
        }

    System.out.println("All finished.");
  }
}