يتضمّن كل مورد حقل إصدار يتغيّر في كل مرة يتغيّر فيها المورد، وهو الحقل etag. العلامات الإلكترونية هي جزء قياسي من HTTP ومتوافقة مع واجهة برمجة تطبيقات التقويم في حالتين:
- حول تعديلات الموارد للتأكّد من عدم كتابة أي رسالة أخرى في هذا المورد في هذه الأثناء (تعديل مشروط)
- عند استرجاع الموارد لاسترداد بيانات المورد فقط في حال تغير المورد (استرداد مشروط)
تعديل شرطي
إذا كنت تريد تعديل مورد أو حذفه فقط إذا لم يتم تغييره منذ آخر مرة استرجعته، يمكنك تحديد عنوان If-Match يحتوي على قيمة العلامة 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;
}
}
}