קבלת גרסאות ספציפיות של משאבים

לכל משאב יש שדה גרסה שמשתנה בכל פעם שהמשאב משתנה – השדה etag. תגי Etag הם חלק סטנדרטי ב-HTTP והם נתמכים ב-Calendar API בשני מקרים:

  • בשינויים במשאבים כדי לוודא שלא בוצע בינתיים כתיבה אחרת למשאב הזה (שינוי מותנה)
  • בשליפת משאבים, כדי לשלוף נתוני משאבים רק אם המשאב השתנה (שליפה מותנית)

שינוי מותנה

אם רוצים לעדכן או למחוק משאב רק אם הוא לא השתנה מאז הפעם האחרונה שאחזרתם אותו, אפשר לציין כותרת If-Match שמכילה את הערך של ה-etag מהאחזור הקודם. האפשרות הזו שימושית מאוד למניעת אובדן שינויים במשאבים. ללקוחות יש אפשרות לאחזר מחדש את המשאב ולהחיל מחדש את השינויים.

אם הרשומה (וה-etag שלה) לא השתנו מאז האחזור האחרון, השינוי מצליח ומוחזרת הגרסה החדשה של המשאב עם ה-etag החדש. אחרת, תקבלו קוד תגובה 412 (תנאי מוקדם נכשל).

קטע הקוד לדוגמה שבהמשך מדגים איך לבצע שינויים מותנים באמצעות ספריית הלקוח של Java.

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Modify the local copy of the event.
    event.setSummary("Updated Test Event");

    // Update the event, making sure that we don't overwrite other changes.
    int numAttempts = 0;
    boolean isUpdated = false;
    do {
      Calendar.Events.Update request = client.events().update("primary", event.getId(), event);
      request.setRequestHeaders(new HttpHeaders().setIfMatch(event.getEtag()));
      try {
        event = request.execute();
        isUpdated = true;
      } catch (GoogleJsonResponseException e) {
        if (e.getStatusCode() == 412) {
          // A 412 status code, "Precondition failed", indicates that the etag values didn't
          // match, and the event was updated on the server since we last retrieved it. Use
          // {@link Calendar.Events.Get} to retrieve the latest version.
          Event latestEvent = client.events().get("primary", event.getId()).execute();

          // You may want to have more complex logic here to resolve conflicts. In this sample we're
          // simply overwriting the summary.
          latestEvent.setSummary(event.getSummary());
          event = latestEvent;
        } else {
          throw e;
        }
      }
      numAttempts++;
    } while (!isUpdated && numAttempts <= MAX_UPDATE_ATTEMPTS);

    if (isUpdated) {
      System.out.println("Event updated.");
    } else {
      System.out.println(String.format("Failed to update event after %d attempts.", numAttempts));
    }
  }
ConditionalModificationSample.java

אחזור מותנה

אם רוצים לאחזר משאב רק אם הוא השתנה מאז הפעם האחרונה שבה הוא אוחזר, אפשר לציין כותרת If-None-Match שמכילה את ערך ה-etag מהאחזור הקודם. אם הרשומה (ולכן גם ה-etag שלה) השתנתה מאז האחזור האחרון, תוחזר הגרסה החדשה של המשאב עם ה-etag החדש. אחרת תקבלו קוד תגובה 304 (Not Modified).

קטע הקוד לדוגמה שבהמשך מראה איך לבצע אחזור מותנה באמצעות ספריית הלקוח של Java.

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Fetch the event again if it's been modified.
    Calendar.Events.Get getRequest = client.events().get("primary", event.getId());
    getRequest.setRequestHeaders(new HttpHeaders().setIfNoneMatch(event.getEtag()));
    try {
      event = getRequest.execute();
      System.out.println("The event was modified, retrieved latest version.");
    } catch (GoogleJsonResponseException e) {
      if (e.getStatusCode() == 304) {
        // A 304 status code, "Not modified", indicates that the etags match, and the event has
        // not been modified since we last retrieved it.
        System.out.println("The event was not modified, using local version.");
      } else {
        throw e;
      }
    }
  }
ConditionalRetrievalSample.java