com.jsunsoft.http.HttpRequestBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 Benik Arakelyan
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jsunsoft.http;

import org.apache.commons.codec.binary.Base64;
import org.apache.http.Header;
import org.apache.http.NameValuePair;
import org.apache.http.entity.ContentType;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.message.BasicHeader;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.Args;

import java.util.*;

import static org.apache.http.HttpHeaders.AUTHORIZATION;
import static org.apache.http.HttpHeaders.CONTENT_TYPE;

/**
 * Http request builder
 *
 * @see HttpRequest
 */
public class HttpRequestBuilder {
    private final CloseableHttpClient closeableHttpClient;

    private List defaultRequestParameters;
    private Collection defaultHeaders;
    private ResponseBodyReaderConfig.Builder responseBodyReaderConfigBuilder = ResponseBodyReaderConfig.create();

    private HttpRequestBuilder(CloseableHttpClient closeableHttpClient) {
        this.closeableHttpClient = ArgsCheck.notNull(closeableHttpClient, "closeableHttpClient");
    }

    public static HttpRequestBuilder create(CloseableHttpClient closeableHttpClient) {
        return new HttpRequestBuilder(closeableHttpClient);
    }

    /**
     * Header needs to be the same for all requests which go through the built HttpRequest
     *
     * @param name  name of header. Can't be null
     * @param value value of header
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultHeader(String name, String value) {
        ArgsCheck.notNull(name, "name");
        return addDefaultHeader(new BasicHeader(name, value));
    }

    /**
     * Header needs to be the same for all requests which go through the built HttpRequest
     *
     * @param header header instance. Can't be null
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultHeader(Header header) {
        ArgsCheck.notNull(header, "header");

        if (defaultHeaders == null) {
            defaultHeaders = new ArrayList<>();
        }
        defaultHeaders.add(header);
        return this;
    }

    /**
     * Headers need to be the same for all requests which go through the built HttpRequest
     *
     * @param headers varargs of headers
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultHeaders(Header... headers) {
        ArgsCheck.notNull(headers, "headers");

        Arrays.stream(headers).forEach(this::addDefaultHeader);
        return this;
    }

    /**
     * Headers need to be the same for all requests which go through the built HttpRequest
     *
     * @param headers collections of headers
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultHeaders(Collection headers) {
        ArgsCheck.notNull(headers, "headers");

        headers.forEach(this::addDefaultHeader);
        return this;
    }

    /**
     * Sets content type to header
     *
     * @param contentType content type of request header
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addContentType(ContentType contentType) {
        return addDefaultHeader(CONTENT_TYPE, contentType.toString());
    }

    /**
     * Parameter needs to be add  for all requests which go through the built HttpRequest
     *
     * @param name  key
     * @param value value
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultRequestParameter(String name, String value) {
        ArgsCheck.notNull(name, "name");
        return addDefaultRequestParameter(new BasicNameValuePair(name, value));
    }

    /**
     * Parameters need to be add  for all requests which go through the built HttpRequest
     *
     * @param nameValues nameValues
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultRequestParameter(NameValuePair... nameValues) {
        int nameValuesLength = ArgsCheck.notNull(nameValues, "nameValues").length;
        Args.check(nameValuesLength != 0, "Length of parameter can't be ZERO");

        Arrays.stream(nameValues).forEach(this::addDefaultRequestParameter);
        return this;
    }


    /**
     * Parameter needs to be add  for all requests which go through the built HttpRequest
     *
     * @param nameValuePair nameValuePair
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultRequestParameter(NameValuePair nameValuePair) {
        ArgsCheck.notNull(nameValuePair, "nameValuePair");
        if (this.defaultRequestParameters == null) {
            this.defaultRequestParameters = new ArrayList<>();
        }

        this.defaultRequestParameters.add(nameValuePair);
        return this;
    }

    /**
     * Parameters needs to be add  for all requests which go through the built HttpRequest
     *
     * @param defaultParameters defaultParameters
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultRequestParameter(Map defaultParameters) {
        ArgsCheck.notNull(defaultParameters, "defaultParameters");

        defaultParameters.entrySet().stream()
                .map(entry -> new BasicNameValuePair(entry.getKey(), entry.getValue()))
                .forEach(this::addDefaultRequestParameter);

        return this;
    }

    /**
     * Parameters needs to be add  for all requests which go through the built HttpRequest
     *
     * @param defaultRequestParameters defaultRequestParameters
     *
     * @return HttpRequestBuilder instance
     */
    public HttpRequestBuilder addDefaultRequestParameter(Collection defaultRequestParameters) {
        ArgsCheck.notNull(defaultRequestParameters, "defaultRequestParameters");

        if (this.defaultRequestParameters == null) {
            this.defaultRequestParameters = new ArrayList<>();
        }
        defaultRequestParameters.forEach(this::addDefaultRequestParameter);

        return this;
    }

    public HttpRequestBuilder addBodyReader(ResponseBodyReader responseBodyReader) {

        responseBodyReaderConfigBuilder.addResponseBodyReader(responseBodyReader);

        return this;
    }

    public HttpRequestBuilder setDefaultResponseBodyReader(ResponseBodyReader defaultResponseBodyReader) {
        responseBodyReaderConfigBuilder.setDefaultResponseBodyReader(defaultResponseBodyReader);

        return this;
    }

    public HttpRequestBuilder enableDefaultBodyReader() {
        responseBodyReaderConfigBuilder.setUseDefaultBodyReader(true);
        return this;
    }

    public HttpRequestBuilder disableDefaultBodyReader() {
        responseBodyReaderConfigBuilder.setUseDefaultBodyReader(false);
        return this;
    }


    /**
     * Basic Authentication - sending the Authorization header.
     *
     * @param username username
     * @param password password
     *
     * @return ClientBuilder instance
     */
    public HttpRequestBuilder basicAuth(String username, String password) {
        String auth = username + ":" + password;
        byte[] encodedAuth = Base64.encodeBase64(auth.getBytes());
        String authHeader = "Basic " + new String(encodedAuth);
        return addDefaultHeader(AUTHORIZATION, authHeader);
    }

    /**
     * Build the HttpRequest instance
     *
     * @return HttpRequest instance
     */
    public HttpRequest build() {
        if (defaultHeaders == null) {
            defaultHeaders = Collections.emptyList();
        }

        if (defaultRequestParameters == null) {
            defaultRequestParameters = Collections.emptyList();
        }

        return new BasicHttpRequest(closeableHttpClient, defaultHeaders, defaultRequestParameters, responseBodyReaderConfigBuilder.build());
    }
}