org.hisp.dhis.Dhis2AsyncRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dhis2-java-client Show documentation
DHIS 2 API client for Java.
The newest version!
/*
 * Copyright (c) 2004-2024, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis;

import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import lombok.extern.slf4j.Slf4j;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpPost;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse;
import org.apache.hc.core5.http.ParseException;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.hisp.dhis.response.BaseHttpResponse;
import org.hisp.dhis.response.Dhis2ClientException;
import org.hisp.dhis.response.job.JobInfo;
import org.hisp.dhis.response.job.JobInfoResponse;
import org.hisp.dhis.response.job.JobNotification;
import org.hisp.dhis.util.HttpUtils;

@Slf4j
public class Dhis2AsyncRequest {
  private static final int TIMEOUT_S = 3600;

  private static final int DELAY_S = 2;

  private static final int ATTEMPTS_MAX = TIMEOUT_S / DELAY_S;

  private final Dhis2Config config;

  private final CloseableHttpClient httpClient;

  private final ObjectMapper objectMapper;

  public Dhis2AsyncRequest(
      Dhis2Config config, CloseableHttpClient httpClient, ObjectMapper objectMapper) {
    Objects.requireNonNull(config);
    Objects.requireNonNull(httpClient);
    Objects.requireNonNull(objectMapper);
    this.config = config;
    this.httpClient = httpClient;
    this.objectMapper = objectMapper;
  }

  /**
   * Executes the given HTTP POST request. The request must be a DHIS 2 async request. The method
   * will use the DHIS 2 tasks and task summary API endpoints to poll for the task status, and
   * eventually return a task summary when the task is complete.
   *
   * @param request the {@link HttpPost}.
   * @param klass the class type.
   * @param  the class type.
   * @return a response message.
   * @throws Dhis2ClientException if the POST operation failed.
   */
  public  T post(HttpPost request, Class klass) {
    JobInfoResponse message = postAsyncRequest(request);

    JobInfo jobInfo = message.getResponse();

    log.info(
        "Push response: '{}', '{}', job: '{}'",
        message.getHttpStatus(),
        message.getMessage(),
        jobInfo);

    JobNotification notification = waitForCompletion(jobInfo);

    log.info("Job completed: '{}'", notification);

    T summary = getSummary(jobInfo, klass);

    log.debug("Summary: '{}'", summary);

    return summary;
  }

  // -------------------------------------------------------------------------
  // Supportive methods
  // -------------------------------------------------------------------------

  /**
   * Executes the given POST request.
   *
   * @param request the {@link HttpPost}.
   * @return a {link JobInfoResponseMessage}.
   */
  private JobInfoResponse postAsyncRequest(HttpPost request) {
    try (CloseableHttpResponse response = httpClient.execute(request)) {
      String body = EntityUtils.toString(response.getEntity());

      JobInfoResponse message = objectMapper.readValue(body, JobInfoResponse.class);

      if (!message.getHttpStatus().is2xxSuccessful()) {
        String errorMessage =
            String.format(
                "Request failed, status: %s, code: %d, message: %s",
                message.getHttpStatus(), message.getHttpStatusCode(), message.getMessage());

        throw new Dhis2ClientException(errorMessage, message.getHttpStatusCode());
      }

      return message;
    } catch (IOException | ParseException ex) {
      throw new Dhis2ClientException("HTTP headers could not be parsed", ex);
    }
  }

  /**
   * Waits for the task to complete. Returns the first job notification which indicates that the
   * task is complete.
   *
   * @param jobInfo the {@link JobInfo} identifying the task.
   * @return a {@link JobNotification}.
   */
  private JobNotification waitForCompletion(JobInfo jobInfo) {
    URI statusUrl =
        HttpUtils.build(
            config
                .getResolvedUriBuilder()
                .appendPath("system")
                .appendPath("tasks")
                .appendPath(jobInfo.getJobType().name())
                .appendPath(jobInfo.getId()));

    JobNotification notification = null;
    boolean completed = false;
    int attempts = 0;

    while (!completed && attempts++ < ATTEMPTS_MAX) {
      notification = getLastNotification(statusUrl);
      completed = notification.isCompleted();

      log.info("Complete check URL: '{}', complete: {}", statusUrl, completed);

      if (!completed) {
        sleepForSeconds(2);
      }
    }

    return notification;
  }

  /**
   * Returns a task summary.
   *
   * @param jobInfo the {@link JobInfo} identifying the task.
   * @param klass the class type of the task summary.
   * @return a task summary.
   */
  private  T getSummary(JobInfo jobInfo, Class klass) {
    URI summaryUrl =
        HttpUtils.build(
            config
                .getResolvedUriBuilder()
                .appendPath("system")
                .appendPath("taskSummaries")
                .appendPath(jobInfo.getJobType().name())
                .appendPath(jobInfo.getId()));

    log.info("Task summary URL: '{}'", summaryUrl);

    String summary = getForBody(summaryUrl);

    try {
      return objectMapper.readValue(summary, klass);
    } catch (IOException ex) {
      throw new Dhis2ClientException("Failed to parse task summaries", ex);
    }
  }

  /**
   * Returns the currently last task notification.
   *
   * @param url the URL.
   * @return a {@link JobNotification}.
   */
  private JobNotification getLastNotification(URI url) {
    try {
      String response = getForBody(url);

      JobNotification[] notificationArray =
          objectMapper.readValue(response, JobNotification[].class);

      List notifications = new ArrayList<>(Arrays.asList(notificationArray));

      return !notifications.isEmpty() ? notifications.get(0) : new JobNotification();
    } catch (IOException ex) {
      throw new Dhis2ClientException("Failed to parse job notifications", ex);
    }
  }

  /**
   * Retrieves the response entity from a GET request to the given URL as a string.
   *
   * @param url the URL.
   * @return the response entity string.
   */
  private String getForBody(URI url) {
    HttpGet request = HttpUtils.withAuth(new HttpGet(url), config);

    try (CloseableHttpResponse response = httpClient.execute(request)) {
      return EntityUtils.toString(response.getEntity());
    } catch (IOException | ParseException ex) {
      throw new Dhis2ClientException("HTTP headers could not be parsed", ex);
    }
  }

  /**
   * Makes the current thread sleep for the given timeout in seconds.
   *
   * @param timeout the timeout in seconds.
   */
  private void sleepForSeconds(long timeout) {
    try {
      TimeUnit.SECONDS.sleep(timeout);
    } catch (InterruptedException ex) {
      throw new Dhis2ClientException("Thread interrupted", ex);
    }
  }
}