io.vertx.ext.web.client.impl.cache.CachedHttpResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-web-client Show documentation
The newest version!
/*
 * Copyright 2021 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.ext.web.client.impl.cache;

import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.http.HttpVersion;
import io.vertx.ext.web.client.HttpResponse;
import io.vertx.ext.web.client.impl.HttpResponseImpl;
import io.vertx.ext.web.client.spi.CacheStore;
import java.time.Duration;
import java.time.Instant;
import java.util.Collections;

/**
 * A serializable object to be stored by a {@link CacheStore}.
 *
 * @author Craig Day
 */
public class CachedHttpResponse {

  private final String version;
  private final int statusCode;
  private final String statusMessage;
  private final Buffer body;
  private final MultiMap responseHeaders;
  private final Instant timestamp;
  private final CacheControl cacheControl;

  static CachedHttpResponse wrap(HttpResponse response) {
    return wrap(response, CacheControl.parse(response.headers()));
  }

  static CachedHttpResponse wrap(HttpResponse response, CacheControl cacheControl) {
    return new CachedHttpResponse(
      response.version().name(),
      response.statusCode(),
      response.statusMessage(),
      response.bodyAsBuffer(),
      response.headers(),
      cacheControl
    );
  }

  CachedHttpResponse(String version, int statusCode, String statusMessage, Buffer body,
    MultiMap responseHeaders, CacheControl cacheControl) {
    this.version = version;
    this.statusCode = statusCode;
    this.statusMessage = statusMessage;
    this.body = body;
    this.responseHeaders = responseHeaders;
    this.timestamp = Instant.now(); // TODO: should we look at the Date or Age header instead?
    this.cacheControl = cacheControl;
  }

  public String getVersion() {
    return version;
  }

  public int getStatusCode() {
    return statusCode;
  }

  public String getStatusMessage() {
    return statusMessage;
  }

  public Buffer getBody() {
    return body;
  }

  public MultiMap getResponseHeaders() {
    return responseHeaders;
  }

  public Instant getTimestamp() {
    return timestamp;
  }

  public CacheControl getCacheControl() {
    return cacheControl;
  }

  public boolean isFresh() {
    return age() <= cacheControl.getMaxAge();
  }

  public boolean useStaleWhileRevalidate() {
    return useStale(CacheControlDirective.STALE_WHILE_REVALIDATE);
  }

  public boolean useStaleIfError() {
    return useStale(CacheControlDirective.STALE_IF_ERROR);
  }

  public long age() {
    return Duration.between(timestamp, Instant.now()).getSeconds();
  }

  public HttpResponse rehydrate() {
    return new HttpResponseImpl<>(
      HttpVersion.valueOf(version),
      statusCode,
      statusMessage,
      responseHeaders,
      MultiMap.caseInsensitiveMultiMap(),
      Collections.emptyList(),
      body,
      Collections.emptyList()
    );
  }

  private boolean useStale(CacheControlDirective directive) {
    long secondsStale = Math.max(0L, age() - getCacheControl().getMaxAge());

    long maxSecondsStale = getCacheControl()
      .getTimeDirectives()
      .getOrDefault(directive, 0L);

    return secondsStale <= maxSecondsStale;
  }
}