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

हर संसाधन का एक वर्शन फ़ील्ड होता है, जो हर बार संसाधन बदलने पर बदल जाता है — etag फ़ील्ड. इटैग, एचटीटीपी का स्टैंडर्ड हिस्सा हैं और कैलेंडर एपीआई में दो मामलों में काम करते हैं:

• ताकि यह पक्का किया जा सके कि इस दौरान इस संसाधन में कोई और बदलाव नहीं किया गया है (शर्त के साथ बदलाव)
• संसाधन की रिकवरी पर

कंडिशनल (शर्त के साथ) में बदलाव करना

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

अगर पिछली बार फिर से पाने के बाद से एंट्री (और उसका इटैग) में कोई बदलाव नहीं हुआ है, तो बदलाव हो जाता है और नए ईटैग के साथ संसाधन का नया वर्शन दिखता है. ऐसा न करने पर, आपको 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 हेडर तय किया जा सकता है. इस हेडर में, डेटा वापस पाने के पिछले तरीके से ईटैग की वैल्यू शामिल होती है. अगर एंट्री (और इसलिए इसका इटैग) पिछली बार पाने के बाद से बदल गया है, तो नए ईटैग के साथ रिसॉर्स का नया वर्शन दिया जाएगा. ऐसा न करने पर, आपको एक 304 (बदलाव नहीं किया गया) रिस्पॉन्स कोड मिलेगा.

नीचे दिए गए सैंपल कोड के स्निपेट में, 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