edu.byu.hbll.box.client.AbstractHttpBoxClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of box-client Show documentation
There is a newer version: 2.7.0
package edu.byu.hbll.box.client;

import edu.byu.hbll.box.BoxDocument;
import edu.byu.hbll.box.BoxQuery;
import edu.byu.hbll.box.QueryResult;
import edu.byu.hbll.box.internal.core.DocumentIterable;
import edu.byu.hbll.box.internal.util.BoxUriBuilder;
import edu.byu.hbll.json.ObjectMapperFactory;
import edu.byu.hbll.json.UncheckedObjectMapper;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.net.URI;
import java.util.List;
import java.util.Objects;

/**
 * A client for communicating with Box through it's web api.
 *
 * @author Charles Draper
 */
public abstract class AbstractHttpBoxClient implements BoxClient {

  private static final UncheckedObjectMapper mapper = ObjectMapperFactory.newUnchecked();

  private URI uri;

  /**
   * Creates a new client.
   *
   * @param uri the base uri of the box source (eg, http://localhost:8080/app/box)
   */
  public AbstractHttpBoxClient(URI uri) {
    this.uri = Objects.requireNonNull(uri);
  }

  @Override
  public QueryResult collect(BoxQuery query) {
    return retrieve(query);
  }

  @Override
  public Iterable find(BoxQuery query) {
    return new DocumentIterable(query, q -> retrieve(q));
  }

  /**
   * Returns the base uri for the box.
   *
   * @return the uri
   */
  public URI getUri() {
    return uri;
  }

  /**
   * Queries the upstream box client for documents.
   *
   * @param query the query to run
   * @return the result of the query
   */
  private QueryResult retrieve(BoxQuery query) {
    URI uri = BoxUriBuilder.buildQuery(this.uri, query);

    try (InputStream input = send(uri)) {
      QueryResponse response = mapper.readValue(input, QueryResponse.class);
      QueryResult result = new QueryResult(response.documents);
      result.setNextCursor(response.nextCursor);
      return result;
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

  /**
   * Sends the request to the Box server and returns the response as an input stream. This can be
   * overridden by subclasses that require different HTTP clients. The input stream will be closed
   * here.
   *
   * @param uri the full uri to send to box for the query
   * @return the response body as an {@link InputStream}
   */
  protected abstract InputStream send(URI uri);

  public static class QueryResponse {
    private List documents;

    private long nextCursor;

    public List getDocuments() {
      return documents;
    }

    public void setDocuments(List documents) {
      this.documents = documents;
    }

    public long getNextCursor() {
      return nextCursor;
    }

    public void setNextCursor(long nextCursor) {
      this.nextCursor = nextCursor;
    }
  }
}