com.urbanairship.api.staticlists.StaticListListingRequest 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-2016.  Urban Airship and Contributors
 */

package com.urbanairship.api.staticlists;

import com.google.common.net.HttpHeaders;
import com.urbanairship.api.client.Request;
import com.urbanairship.api.client.RequestUtils;
import com.urbanairship.api.client.ResponseParser;
import com.urbanairship.api.staticlists.model.StaticListListingResponse;
import com.urbanairship.api.staticlists.parse.StaticListsObjectMapper;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.ContentType;

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

/**
 * The StaticListListingRequest class builds static list listing requests to be executed in
 * the {@link com.urbanairship.api.client.UrbanAirshipClient}.
 */
public class StaticListListingRequest implements Request {
    private final static String API_LISTS_PATH = "/api/lists/";
    private final static String TYPE_PARAM = "type";
    private Optional type;

    public enum ListType {all, lifecycle, user}

    private StaticListListingRequest() {
        this.type = Optional.empty();
    }

    /**
     * Create a request to list all static lists.
     *
     * @return StaticListListingRequest
     */
    public static StaticListListingRequest newRequest() {
        return new StaticListListingRequest();
    }

    /**
     * Set the type of lists to be returned.
     *
     * @param type StaticListType representing the list type
     * @return StaticListListingRequest
     */
    public StaticListListingRequest type(ListType type) {
        this.type = Optional.of(type);
        return this;
    }

    @Override
    public ContentType getContentType() {
        return null;
    }

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

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

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

    @Override
    public URI getUri(URI baseUri) throws URISyntaxException {
        URIBuilder builder = new URIBuilder(RequestUtils.resolveURI(baseUri, API_LISTS_PATH));

        if (type.isPresent()) {
            builder.addParameter(TYPE_PARAM, this.type.get().toString());
        }

        return builder.build();
    }

    @Override
    public ResponseParser getResponseParser() {
        return response -> StaticListsObjectMapper.getInstance().readValue(response, StaticListListingResponse.class);
    }

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

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