الحصول على إصدارات محددة من الموارد

يحتوي كل مورد على حقل إصدار يتغيّر في كل مرة يتغيّر فيها المورد، وهو الحقل etag. تشكّل علامات ETag جزءًا أساسيًا من HTTP، وهي متوافقة مع واجهة برمجة التطبيقات الخاصة بالتقويم في حالتين:

  • في تعديلات الموارد للتأكّد من عدم إجراء أي عملية كتابة أخرى على هذا المورد في الوقت الحالي (تعديل شرطي)
  • عند استرداد الموارد، لا يتم استرداد بيانات الموارد إلا إذا تم تغيير المورد (الاسترداد الشرطي)

التعديل الشرطي

إذا أردت تعديل مورد أو حذفه فقط إذا لم يتغيّر منذ آخر مرة استرجعته فيها، يمكنك تحديد عنوان 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));
    }
  }

الاسترجاع الشرطي

إذا كنت تريد استرداد مورد فقط إذا تم تغييره منذ آخر مرة استرددته فيها، يمكنك تحديد عنوان If-None-Match يتضمّن قيمة etag من عملية الاسترداد السابقة. إذا تغيّر الإدخال (وبالتالي علامة 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;
      }
    }
  }