Bestimmte Versionen von Ressourcen abrufen

Jede Ressource hat ein Versionsfeld, das sich bei jeder Änderung der Ressource ändert: das Feld etag. ETags sind ein Standardbestandteil von HTTP und werden in der Calendar API in zwei Fällen unterstützt:

  • bei Ressourcenänderungen, um sicherzustellen, dass in der Zwischenzeit keine anderen Schreibvorgänge für diese Ressource erfolgt sind (bedingte Änderung)
  • beim Abrufen von Ressourcen, um Ressourcendaten nur abzurufen, wenn sich die Ressource geändert hat (bedingtes Abrufen)

Bedingte Änderung

Wenn Sie eine Ressource nur aktualisieren oder löschen möchten, wenn sie sich seit dem letzten Abrufen nicht geändert hat, können Sie einen If-Match-Header angeben, der den Wert des E‑Tags aus dem vorherigen Abruf enthält. Das ist sehr nützlich, um zu verhindern, dass Änderungen an Ressourcen verloren gehen. Die Clients haben die Möglichkeit, die Ressource noch einmal abzurufen und die Änderungen noch einmal anzuwenden.

Wenn sich der Eintrag (und sein ETag) seit dem letzten Abruf nicht geändert hat, ist die Änderung erfolgreich und die neue Version der Ressource mit dem neuen ETag wird zurückgegeben. Andernfalls erhalten Sie den Antwortcode 412 (Precondition failed).

Das folgende Beispielcode-Snippet zeigt, wie Sie mit der Java-Clientbibliothek bedingte Änderungen vornehmen.

  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

Bedingter Abruf

Wenn Sie eine Ressource nur abrufen möchten, wenn sie sich seit dem letzten Abruf geändert hat, können Sie einen If-None-Match-Header angeben, der den Wert des ETag aus dem vorherigen Abruf enthält. Wenn sich der Eintrag (und damit sein ETag) seit dem letzten Abruf geändert hat, wird die neue Version der Ressource mit dem neuen ETag zurückgegeben. Andernfalls erhalten Sie den Antwortcode „304 (Not Modified)“.

Das folgende Beispielcode-Snippet zeigt, wie Sie mit der Java-Clientbibliothek einen bedingten Abruf durchführen.

  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