Recupero versioni specifiche delle risorse

Ogni risorsa ha un campo versione che cambia ogni volta che la risorsa viene modificata: il campo etag. Gli ETag sono una parte standard di HTTP e sono supportati nell'API Google Calendar per due casi:

  • Nelle modifiche delle risorse, per assicurarsi che nel frattempo non siano state eseguite altre scritture su questa risorsa (modifica condizionale).
  • Nel recupero delle risorse, per recuperare i dati solo se la risorsa è stata modificata (recupero condizionale).

Modifica condizionale

Se vuoi aggiornare o eliminare una risorsa solo se non è stata modificata dall'ultima volta che l'hai recuperata, puoi specificare un'intestazione If-Match che contiene il valore dell'ETag del recupero precedente. In questo modo si evitano modifiche perse alle risorse. I client possono recuperare di nuovo la risorsa e riapplicare le modifiche.

Se la voce (e il relativo ETag) non è stata modificata dall'ultimo recupero, la modifica viene eseguita correttamente e il server restituisce la nuova versione della risorsa con il nuovo ETag. In caso contrario, il server restituisce un codice di risposta 412 Precondition Failed.

Il seguente esempio mostra come eseguire modifiche condizionali con la libreria client 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));
    }
  }

Recupero condizionale

Se vuoi recuperare una risorsa solo se è stata modificata dall'ultima volta che l'hai recuperata, puoi specificare un'intestazione If-None-Match che contiene il valore dell'ETag del recupero precedente. Se la voce (e quindi il relativo ETag) è stata modificata dall'ultimo recupero, il server restituisce la nuova versione della risorsa con il nuovo ETag. In caso contrario, il server restituisce un codice di risposta 304 Not Modified.

Il seguente esempio mostra come eseguire il recupero condizionale con la libreria client 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;
      }
    }
  }