com.proofpoint.http.client.Request Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-client Show documentation
There is a newer version: 3.23
/*
 * Copyright 2010 Proofpoint, Inc.
 *
 * 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.proofpoint.http.client;

import com.google.common.annotations.Beta;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ListMultimap;

import javax.annotation.Nullable;
import java.net.URI;
import java.util.List;
import java.util.Map.Entry;
import java.util.Objects;

import static com.google.common.base.Objects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

@Beta
public class Request
{
    private final URI uri;
    private final String method;
    private final ListMultimap headers;
    private final BodySource bodySource;
    private final boolean followRedirects;

    public Request(URI uri, String method, ListMultimap headers, @Nullable BodySource bodySource)
    {
        this(uri, method, headers, bodySource, false);
    }
    public Request(URI uri, String method, ListMultimap headers, @Nullable BodySource bodySource, boolean followRedirects)
    {
        checkNotNull(uri, "uri is null");
        checkNotNull(method, "method is null");

        this.uri = validateUri(uri);
        this.method = method;
        this.headers = ImmutableListMultimap.copyOf(headers);
        this.bodySource = bodySource;
        this.followRedirects = followRedirects;
    }

    public static Request.Builder builder()
    {
        return new Builder();
    }

    public URI getUri()
    {
        return uri;
    }

    public String getMethod()
    {
        return method;
    }

    public String getHeader(String name)
    {
        List values = headers.get(name);
        if (values != null && !values.isEmpty()) {
            return values.get(0);
        }
        return null;
    }

    public ListMultimap getHeaders()
    {
        return headers;
    }

    public BodySource getBodySource()
    {
        return bodySource;
    }

    public boolean isFollowRedirects()
    {
        return followRedirects;
    }

    @Override
    public String toString()
    {
        return toStringHelper(this)
                .add("uri", uri)
                .add("method", method)
                .add("headers", headers)
                .add("bodySource", bodySource)
                .add("followRedirects", followRedirects)
                .toString();
    }

    @Override
    public int hashCode()
    {
        return Objects.hash(uri, method, headers, bodySource, followRedirects);
    }

    @Override
    public boolean equals(Object obj)
    {
        if (!(obj instanceof Request)) {
            return false;
        }
        final Request other = (Request) obj;
        return Objects.equals(this.uri, other.uri) &&
                Objects.equals(this.method, other.method) &&
                Objects.equals(this.headers, other.headers) &&
                Objects.equals(this.bodySource, other.bodySource) &&
                Objects.equals(this.followRedirects, other.followRedirects);
    }

    @Beta
    public static class Builder
    {
        public static Builder prepareHead()
        {
            return new Builder().setMethod("HEAD");
        }

        public static Builder prepareGet()
        {
            return new Builder().setMethod("GET");
        }

        public static Builder preparePost()
        {
            return new Builder().setMethod("POST");
        }

        public static Builder preparePut()
        {
            return new Builder().setMethod("PUT");
        }

        public static Builder prepareDelete()
        {
            return new Builder().setMethod("DELETE");
        }

        public static Builder fromRequest(Request request)
        {
            Builder requestBuilder = new Builder();
            requestBuilder.setMethod(request.getMethod());
            requestBuilder.setBodySource(request.getBodySource());
            requestBuilder.setUri(request.getUri());
            requestBuilder.setFollowRedirects(request.isFollowRedirects());

            for (Entry entry : request.getHeaders().entries()) {
                requestBuilder.addHeader(entry.getKey(), entry.getValue());
            }
            return requestBuilder;
        }

        private URI uri;
        private String method;
        private final ListMultimap headers = ArrayListMultimap.create();
        private BodySource bodySource;
        private boolean followRedirects = false;

        public Builder setUri(URI uri)
        {
            this.uri = validateUri(uri);
            return this;
        }

        public Builder setMethod(String method)
        {
            this.method = method;
            return this;
        }

        public Builder setHeader(String name, String value)
        {
            this.headers.removeAll(name);
            this.headers.put(name, value);
            return this;
        }

        public Builder addHeader(String name, String value)
        {
            this.headers.put(name, value);
            return this;
        }

        public Builder setBodySource(BodySource bodySource)
        {
            this.bodySource = bodySource;
            return this;
        }

        /**
         * @deprecated Use @{link #setBodySource(BodySource)}.
         */
        @Deprecated
        @SuppressWarnings("deprecation")
        public Builder setBodyGenerator(StaticBodyGenerator bodyGenerator)
        {
            this.bodySource = bodyGenerator;
            return this;
        }

        public Builder setFollowRedirects(boolean followRedirects)
        {
            this.followRedirects = followRedirects;
            return this;
        }

        public Request build()
        {
            return new Request(uri, method, headers, bodySource, followRedirects);
        }
    }

    private static URI validateUri(URI uri)
    {
        if (uri.getScheme() != null) {
            String scheme = uri.getScheme().toLowerCase();
            checkArgument(!"http".equals(scheme) || !"https".equals(scheme), "uri scheme must be http or https: %s", uri);
        }
        checkArgument(uri.getPort() != 0, "Cannot make requests to HTTP port 0");
        return uri;
    }
}