Obtenir des versions spécifiques des ressources

Chaque ressource possède un champ de version qui change chaque fois que la ressource est modifiée (champ etag). Les ETags sont une partie standard du protocole HTTP et sont compatibles avec l'API Calendar dans deux cas :

  • sur les modifications apportées aux ressources pour s'assurer qu'aucune autre écriture n'a été effectuée sur cette ressource entre-temps (modification conditionnelle)
  • lors de la récupération de ressources pour ne récupérer les données de ressources que si la ressource a été modifiée (récupération conditionnelle)

Modification conditionnelle

Si vous souhaitez mettre à jour ou supprimer une ressource uniquement si elle n'a pas changé depuis la dernière fois que vous l'avez récupérée, vous pouvez spécifier un en-tête If-Match contenant la valeur de l'etag de la récupération précédente. Cela est très utile pour éviter de perdre des modifications apportées aux ressources. Les clients peuvent récupérer à nouveau la ressource et réappliquer les modifications.

Si l'entrée (et son ETag) n'ont pas changé depuis la dernière récupération, la modification réussit et la nouvelle version de la ressource avec le nouvel ETag est renvoyée. Sinon, vous recevrez un code de réponse 412 (Échec de la précondition).

L'extrait de code ci-dessous montre comment effectuer des modifications conditionnelles avec la bibliothèque cliente 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

Récupération conditionnelle

Si vous souhaitez récupérer une ressource uniquement si elle a été modifiée depuis la dernière fois que vous l'avez récupérée, vous pouvez spécifier un en-tête If-None-Match contenant la valeur de l'etag de la récupération précédente. Si l'entrée (et donc son ETag) a été modifiée depuis la dernière récupération, la nouvelle version de la ressource avec le nouvel ETag sera renvoyée. Sinon, vous recevrez un code de réponse 304 (Non modifié).

L'extrait de code exemple ci-dessous montre comment effectuer une récupération conditionnelle avec la bibliothèque cliente 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