com.urbanairship.api.reports.ExperimentOverviewReportRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

The Urban Airship Java client library

There is a newer version: 9.4.2

/*
 * Copyright (c) 2013-2022. Urban Airship and Contributors
 */

package com.urbanairship.api.reports;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.guava.GuavaModule;
import com.urbanairship.api.client.Request;
import com.urbanairship.api.client.RequestUtils;
import com.urbanairship.api.client.ResponseParser;
import com.urbanairship.api.reports.model.ExperimentOverviewReportResponse;
import org.apache.http.HttpHeaders;
import org.apache.http.entity.ContentType;

import java.net.URI;
import java.util.HashMap;
import java.util.Map;

/**
 * The ExperimentOverviewReportRequest class builds a request to the statistics and metadata about an experiment
 * to be executed in the
 * {@link com.urbanairship.api.client.UrbanAirshipClient}
 */
public class ExperimentOverviewReportRequest implements Request {
    private final static String API_EXPERIMENT_OVERVIEW_REPORT = "/api/reports/experiment/overview/";

    private final String path;
    private final static ObjectMapper MAPPER = new ObjectMapper();

    static {
        MAPPER.registerModule(new GuavaModule());
    }

    private ExperimentOverviewReportRequest(String path) {
        this.path = path;
    }

    /**
     * Request individual Experiment Overview Report for a pushId.
     *
     * @param pushId String
     * @return ExperimentVariantReportRequest
     */
    public static ExperimentOverviewReportRequest newRequest(String pushId) {
        return new ExperimentOverviewReportRequest(API_EXPERIMENT_OVERVIEW_REPORT + pushId) ;
    }

    @Override
    public ContentType getContentType() {
        return ContentType.APPLICATION_JSON;
    }

    @Override
    public Map getRequestHeaders() {
        Map headers = new HashMap();
        headers.put(HttpHeaders.CONTENT_TYPE, CONTENT_TYPE_JSON);
        headers.put(HttpHeaders.ACCEPT, UA_VERSION_JSON);
        return headers;
    }

    @Override
    public HttpMethod getHttpMethod() {
        return HttpMethod.GET;
    }

    @Override
    public String getRequestBody() {
        return null;
    }

    @Override
    public URI getUri(URI baseUri) {
        return RequestUtils.resolveURI(baseUri, path);
    }

    @Override
    public ResponseParser getResponseParser() {
        return response -> MAPPER.readValue(response, ExperimentOverviewReportResponse.class);
    }

    @Override
    public boolean bearerTokenAuthRequired() {
        return false;
    }

    @Override
    public boolean canUseBearerTokenAuth() {
        return true;
    }
}