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

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

ملاحظة: هناك حالات خاصة لن تتغيّر فيها etags، مثل تغيير أحد الحقول للقراءة فقط في إدخال calendarList (مثل خصائص التقويم أو قوائم التحكّم بالوصول).

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