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

हर रिसॉर्स में एक वर्शन फ़ील्ड होता है, जो हर बार रिसॉर्स में बदलाव होने पर बदल जाता है — etag फ़ील्ड. ईटैग, एचटीटीपी का एक स्टैंडर्ड हिस्सा हैं. ये 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 के साथ संसाधन का नया वर्शन दिखाया जाएगा. ऐसा न करने पर, आपको 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