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

يحتوي كلّ مورد على حقل إصدار يتغيّر في كلّ مرّة يتغيّر فيها المورد، وهو حقل etag. علامات Etags هي جزء عادي من 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 (لم يتم التعديل).

يوضّح المقتطف من الرمز البرمجي النموذجي أدناه كيفية إجراء عملية استرجاع مشروطة باستخدام مكتبة برامج 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