Jede Ressource hat ein Versionsfeld, das jedes Mal geändert wird, wenn die Ressource
Änderungen: das Feld etag. ETags sind ein Standardbestandteil von HTTP und werden
in der Kalender-API in zwei Fällen unterstützt:
- bei Ressourcenänderungen, um sicherzustellen, dass in der Zwischenzeit kein anderer Schreibvorgang in diese Ressource erfolgt ist (bedingte Änderung).
- beim Ressourcenabruf, damit Ressourcendaten nur abgerufen werden, wenn sich die Ressource geändert hat (bedingter Abruf).
Bedingte Änderung
Wenn Sie eine Ressource nur dann aktualisieren oder löschen möchten, wenn sie seitdem nicht geändert wurde
Sie sie zuletzt abgerufen haben, können Sie einen If-Match-Header angeben, der die
-Wert des ETags aus dem vorherigen Abruf. Dies ist sehr nützlich, um zu verhindern,
an Ressourcen verloren gehen. Die Clients haben die Möglichkeit,
und wenden Sie die Änderungen erneut an.
Wenn sich der Eintrag (und sein ETag) seit dem letzten Abruf nicht geändert haben, die Änderung erfolgreich ist und die neue Version der Ressource mit dem neuen ETag zurückgegeben. Andernfalls erhalten Sie den Antwortcode 412 (Vorbedingung fehlgeschlagen).
Das folgende Beispielcode-Snippet zeigt, wie bedingte mit dem Parameter Java-Clientbibliothek
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));
}
}
Bedingter Abruf
Wenn Sie eine Ressource nur dann abrufen möchten, wenn sie seit der letzten Änderung geändert wurde
abgerufen wurde, können Sie einen If-None-Match-Header angeben, der
-Wert des ETags aus dem vorherigen Abruf. Wenn der Eintrag (und damit sein eTag)
seit dem letzten Abruf geändert hat, wird die neue Version der Ressource mit dem
wird ein neues ETag zurückgegeben. Andernfalls erhalten Sie den Fehler 304 (Nicht geändert)
-Antwortcode.
Das folgende Beispielcode-Snippet zeigt, wie bedingte Datenabruf mit der Java-Clientbibliothek
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;
}
}
}