संसाधनों के खास वर्शन पाना

हर रिसॉर्स में एक वर्शन फ़ील्ड होता है. जब भी रिसॉर्स में कोई बदलाव होता है, तो यह फ़ील्ड बदल जाता है. यह etag फ़ील्ड होता है. ETag, एचटीटीपी का एक स्टैंडर्ड हिस्सा है. इसे Google Calendar API में इन दो स्थितियों में इस्तेमाल किया जा सकता है:

  • संसाधन में बदलाव करने पर, यह पक्का करने के लिए कि इस संसाधन में इस दौरान कोई और बदलाव न किया गया हो (शर्त के साथ बदलाव).
  • संसाधन को वापस पाने पर, यह पक्का करने के लिए कि डेटा सिर्फ़ तब वापस पाया जाए, जब संसाधन में कोई बदलाव हुआ हो (शर्त के साथ वापस पाना).

शर्त के साथ बदलाव

अगर आपको किसी संसाधन को सिर्फ़ तब अपडेट या मिटाना है, जब उसे पिछली बार वापस पाने के बाद से उसमें कोई बदलाव न हुआ हो, तो If-Match हेडर तय किया जा सकता है. इसमें, पिछली बार वापस पाने के दौरान मिले ETag की वैल्यू शामिल होती है. इससे, संसाधनों में किए गए बदलावों के खो जाने से बचा जा सकता है. क्लाइंट, संसाधन को फिर से वापस पा सकते हैं और बदलावों को फिर से लागू कर सकते हैं.

अगर पिछली बार वापस पाने के बाद से, एंट्री (और उसका ETag) नहीं बदला है, तो बदलाव हो जाता है. साथ ही, सर्वर, संसाधन का नया वर्शन और नया ETag दिखाता है. इसके अलावा, सर्वर 412 Precondition Failed रिस्पॉन्स कोड दिखाता है.

यहां दिए गए सैंपल में, 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));
    }
  }

शर्त के साथ वापस पाना

अगर आपको किसी संसाधन को सिर्फ़ तब वापस पाना है, जब उसे पिछली बार वापस पाने के बाद से उसमें कोई बदलाव हुआ हो, तो 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;
      }
    }
  }