Java

SharePoint -- Get File Metadata (File Size, Last-Modified Date/Time, etc.)

See more SharePoint Examples

Demonstrates how to get a file's metdata, which includes the file size, last-modified date/time, name, server relative URL, etc. Java

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[])
  {
    boolean success = false;

    //  This requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    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

    //  Indicate that we want a JSON reply
    http.put_Accept("application/json;odata=verbose");
    http.put_AcceptCharset("utf-8");

    String url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')";

    String jsonReply = http.quickGetStr(url);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    //  Examine the file's metadata in JSON format.
    CkJsonObject json = new CkJsonObject();
    json.Load(jsonReply);
    json.put_EmitCompact(false);

    //  Make sure it was a success response, and that we really have metadata.
    //  If it was an error response, then the JSON is error information..
    if (http.get_LastStatus() != 200) {
        System.out.println(json.emit());
        System.out.println("Failed.");
        return;
        }

    System.out.println(json.emit());

    System.out.println("--------");
    System.out.println("Server relative URL: " + json.stringOf("d.ServerRelativeUrl"));

    int fileSize = json.IntOf("d.Length");
    System.out.println("File Size = " + fileSize);

    CkDateTime lastmod = new CkDateTime();
    lastmod.SetFromTimestamp(json.stringOf("d.TimeLastModified"));

    //  Once we have the CkDateTime object, we can get the date/time in all sorts of formats:

    //  Get as a RFC822 GMT string:
    boolean bLocalTime = false;
    System.out.println(lastmod.getAsRfc822(bLocalTime));

    //  Get as an RFC822 string in the local timezone.
    //  (remember, the daylight savings that existed at the given time in the past is applied)
    bLocalTime = true;
    System.out.println(lastmod.getAsRfc822(bLocalTime));

    //  Get as a 32-bit UNIX time (local or GMT..)
    //  The Unix time is number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). 
    int unixTime = lastmod.GetAsUnixTime(bLocalTime);
    System.out.println("Unix time: " + unixTime);

    //  One can also get the as a "DtObj" object for accessing the individual
    //  parts of the date/time, such as month, day, year, hour, minute, etc.
    //  The DtObj can be obtained in the GMT or local timezone:
    CkDtObj dtObj = new CkDtObj();
    lastmod.ToDtObj(bLocalTime,dtObj);

    if (lastmod.get_LastMethodSuccess() == false) {
        System.out.println("This should never really happen!");
        return;
        }

    System.out.println(dtObj.get_Day() + "-" + dtObj.get_Month() + "-" + dtObj.get_Year() + " " + dtObj.get_Hour() + ":" + dtObj.get_Minute() + ":" + dtObj.get_Second());

    //  -------------------------------------------------
    //  The file's metadata look like this:

    //  { 
    //    "d": { 
    //      "__metadata": { 
    //        "id": "Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
    //        "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
    //        "type": "SP.File"
    //      },
    //      "Author": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Author"
    //        }
    //      },
    //      "CheckedOutByUser": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/CheckedOutByUser"
    //        }
    //      },
    //      "ListItemAllFields": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ListItemAllFields"
    //        }
    //      },
    //      "LockedByUser": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/LockedByUser"
    //        }
    //      },
    //      "ModifiedBy": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ModifiedBy"
    //        }
    //      },
    //      "Versions": { 
    //        "__deferred": { 
    //          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Versions"
    //        }
    //      },
    //      "CheckInComment": "",
    //      "CheckOutType": 2,
    //      "ContentTag": "{E2F05E75-B3EF-4826-8284-E572D3628A7D},9,10",
    //      "CustomizedPageStatus": 0,
    //      "ETag": "\"{E2F05E75-B3EF-4826-8284-E572D3628A7D},9\"",
    //      "Exists": true,
    //      "Length": "21082",
    //      "Level": 2,
    //      "MajorVersion": 0,
    //      "MinorVersion": 3,
    //      "Name": "VCAC-document.docx",
    //      "ServerRelativeUrl": "/Documents/VCAC-document.docx",
    //      "TimeCreated": "2016-03-04T12:38:01Z",
    //      "TimeLastModified": "2017-01-16T04:44:31Z",
    //      "Title": "",
    //      "UIVersion": 3,
    //      "UIVersionLabel": "0.3"
    //    }
    //  }
    //
  }
}