Cada recurso tem um campo de versão que muda sempre que o recurso
muda, o campo etag. As ETags são uma parte padrão do HTTP e são
compatíveis com a API do Google Agenda em dois casos:
- em modificações de recursos para garantir que não houve outra gravação nesse recurso nesse meio tempo (modificação condicional).
- na recuperação de recursos para recuperar dados de recursos somente se o recurso tiver mudado (recuperação condicional)
Modificação condicional
Se você quiser atualizar ou excluir um recurso somente se ele não tiver mudado desde a última recuperação, especifique um cabeçalho If-Match que contenha o valor da ETag da recuperação anterior. Isso é muito útil para evitar
perda de modificações em recursos. Os clientes têm a opção de recuperar
o recurso e aplicar as alterações novamente.
Se a entrada (e a ETag dela) não tiver mudado desde a última recuperação, a modificação terá sucesso e a nova versão do recurso com a nova ETag será retornada. Caso contrário, você vai receber um código de resposta 412 (falha na pré-condição).
O snippet de código de exemplo abaixo demonstra como fazer modificações condicionais com a biblioteca de 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));
}
}
Recuperação condicional
Se você quiser recuperar um recurso somente se ele tiver sido alterado desde a última
recuperação, especifique um cabeçalho If-None-Match que contenha o
valor da ETag da recuperação anterior. Se a entrada (e, portanto, a ETag dela)
tiver mudado desde a última recuperação, a nova versão do recurso com a
nova ETag será retornada. Caso contrário, você vai receber um código de resposta 304 (não modificado).
O snippet de código de exemplo abaixo demonstra como realizar a recuperação condicional com a biblioteca de 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;
}
}
}