com.lindar.wellrested.WellRestedRequestBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of well-rested-client Show documentation
A nice and easy java http client wrapper built on top of apache httpclient
There is a newer version: 1.7.3
package com.lindar.wellrested;

import com.google.gson.ExclusionStrategy;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonSerializer;
import com.lindar.wellrested.util.DateDeserializer;
import com.lindar.wellrested.util.StringDateSerializer;
import com.lindar.wellrested.util.WellRestedUtil;
import org.apache.commons.lang3.StringUtils;
import org.apache.http.Header;
import org.apache.http.HttpHost;
import org.apache.http.auth.Credentials;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.entity.ContentType;
import org.apache.http.message.BasicHeader;

import java.net.URI;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;

public class WellRestedRequestBuilder {
    private static final String CONTENT_TYPE_PARAM = "Content-Type";

    private URI                    uri;
    private Credentials            credentials;
    private HttpHost               proxy;
    private JsonSerializer   dateSerializer   = new StringDateSerializer();
    private JsonDeserializer dateDeserializer = new DateDeserializer();
    private String                 dateFormat       = StringUtils.EMPTY;
    private ExclusionStrategy      exclusionStrategy;
    private List           excludedFieldNames;
    private Set            excludedClassNames;
    private List           globalHeaders;
    private GsonCustomiser         gsonCustomiser;
    private boolean                disableCookiesForAuthRequests;

    public WellRestedRequestBuilder uri(URI uri) {
        this.uri = uri;
        return this;
    }

    public WellRestedRequestBuilder url(String url) {
        this.uri = URI.create(url);
        return this;
    }

    public WellRestedRequestBuilder credentials(Credentials credentials) {
        this.credentials = credentials;
        return this;
    }

    public WellRestedRequestBuilder credentials(String username, String password) {
        this.credentials = new UsernamePasswordCredentials(username, password);
        return this;
    }

    public WellRestedRequestBuilder proxy(HttpHost proxy) {
        this.proxy = proxy;
        return this;
    }

    public WellRestedRequestBuilder proxy(String proxyHost, int proxyPort, String scheme) {
        this.proxy = new HttpHost(proxyHost, proxyPort, scheme);
        return this;
    }

    public WellRestedRequestBuilder gsonCustomiser(GsonCustomiser gsonCustomiser) {
        this.gsonCustomiser = gsonCustomiser;
        return this;
    }

    /**
     * Use this method to override the default dateSerializer.
     * The default one is {@link com.lindar.wellrested.util.StringDateSerializer}
     * 

     * NOTE: Well Rested Client provides 2 serializers which can be passed as parameters for this method: 

     * - {@link com.lindar.wellrested.util.StringDateSerializer} 

     * - {@link com.lindar.wellrested.util.LongDateSerializer} 

     * If neither satisfies your requirements, please write your own.
     */
    public WellRestedRequestBuilder dateSerializer(JsonSerializer dateSerializer) {
        this.dateSerializer = dateSerializer;
        return this;
    }

    /**
     * Use this method to override the default dateSerializer.
     * The default one is {@link com.lindar.wellrested.util.DateDeserializer}
     * 

     * If the default one doesn't satisfy your requirements, please write your own.
     */
    public WellRestedRequestBuilder dateDeserializer(JsonDeserializer dateDeserializer) {
        this.dateDeserializer = dateDeserializer;
        return this;
    }

    /**
     * Use this method to provide a date format that will be used when doing both the serialization and deserialization. 

     * If you require different formats for serialization and deserialization, please use the setDateSerializer and setDateDeserializer methods. 

     * By default this class uses {@link com.lindar.wellrested.util.StringDateSerializer} and {@link com.lindar.wellrested.util.DateDeserializer} 

     * PLEASE NOTE: By setting a dateFormat, you override any other serializer and deserializer!
     */
    public WellRestedRequestBuilder dateFormat(String dateFormat) {
        this.dateFormat = dateFormat;
        return this;
    }

    /**
     * Use this method to provide a Gson serialisation exclusion strategy.
     * If you just want to exclude some field names or a class you can use the excludeFields and excludeClasses methods easier.
     * Keep in mind that this exclusion strategy overrides the other ones
     */
    public WellRestedRequestBuilder exclusionStrategy(ExclusionStrategy exclusionStrategy) {
        this.exclusionStrategy = exclusionStrategy;
        return this;
    }

    /**
     * Use this method to exclude some field names from the Gson serialisation process
     */
    public WellRestedRequestBuilder excludeFields(List fieldNames) {
        this.excludedFieldNames = fieldNames;
        return this;
    }

    /**
     * Use this method to exclude some class names from the Gson serialisation process
     */
    public WellRestedRequestBuilder excludeClasses(Set classNames) {
        this.excludedClassNames = classNames;
        return this;
    }

    /**
     * Use this method to add some global headers to the WellRestedRequest object.
     * These headers are going to be added on every request you make. 

     * A good use for this method is setting a global authentication header or a content type header.
     */
    public WellRestedRequestBuilder globalHeaders(List globalHeaders) {
        this.globalHeaders = globalHeaders;
        return this;
    }

    /**
     * Use this method to add some global headers to the WellRestedRequest object.
     * These headers are going to be added on every request you make. 

     * A good use for this method is setting a global authentication header or a content type header.
     */
    public WellRestedRequestBuilder globalHeaders(Map globalHeaders) {
        this.globalHeaders = WellRestedUtil.buildHeaders(globalHeaders);
        return this;
    }

    /**
     * Use this method to add one more global header.
     * These headers are going to be added on every request you make. 

     * A good use for this method is setting a global authentication header or a content type header.
     */
    public WellRestedRequestBuilder addGlobalHeader(String name, String value) {
        if (this.globalHeaders == null) {
            this.globalHeaders = new ArrayList<>();
        }
        this.globalHeaders.add(new BasicHeader(name, value));
        return this;
    }

    public WellRestedRequestBuilder addContentTypeGlobalHeader(String contentType) {
        if (this.globalHeaders == null) {
            this.globalHeaders = new ArrayList<>();
        }
        this.globalHeaders.add(new BasicHeader(CONTENT_TYPE_PARAM, contentType));
        return this;
    }

    public WellRestedRequestBuilder addJsonContentTypeGlobalHeader() {
        if (this.globalHeaders == null) {
            this.globalHeaders = new ArrayList<>();
        }
        this.globalHeaders.add(new BasicHeader(CONTENT_TYPE_PARAM, ContentType.APPLICATION_JSON.toString()));
        return this;
    }

    /**
     * Use this method to clear all the cookies when doing secure requests (with Credentials).
     * This is helpful in preventing SESSION cookie cache and clash
     */
    public WellRestedRequestBuilder disableCookiesForAuthRequests() {
        this.disableCookiesForAuthRequests = true;
        return this;
    }

    /**
     * NOTE: keep in mind that date serializers and deserializers and all exclusion strategies are available only for JSON content
     */
    public WellRestedRequest build() {
        return new WellRestedRequest(this.uri, this.credentials, this.proxy, this.dateSerializer, this.dateDeserializer,
                                     this.dateFormat, this.exclusionStrategy, this.excludedFieldNames, this.excludedClassNames,
                                     this.globalHeaders, this.gsonCustomiser, this.disableCookiesForAuthRequests);
    }
}