facebook4j.internal.http.HttpRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of facebook4j-core Show documentation
A Java library for the Facebook Graph API
The newest version!
/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * 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 facebook4j.internal.http;

import facebook4j.auth.AccessToken;
import facebook4j.auth.Authorization;
import facebook4j.auth.OAuthAuthorization;

import java.util.Arrays;
import java.util.Map;

/**
 * HTTP Request parameter object
 *
 * @author Yusuke Yamamoto - yusuke at mac.com
 * @author Ryuji Yamashita - roundrop at gmail.com
 * 
 * Changed constructor to set access token for Facebook4J
 * Improved join of url and parameter when url contains '?'
 * 
 */
public final class HttpRequest implements java.io.Serializable {

    private final RequestMethod method;

    private final String url;

    private final HttpParameter[] parameters;

    private final Authorization authorization;

    private Map requestHeaders;

    private static final long serialVersionUID = -3463594029098858381L;


    private static final HttpParameter[] NULL_PARAMETERS = new HttpParameter[0];

    /**
     * @param method         Specifies the HTTP method
     * @param url            the request to request
     * @param parameters     parameters
     * @param authorization  Authentication implementation. Currently OAuthAuthentication and NullAuthentication are supported.
     * @param requestHeaders
     */
    public HttpRequest(RequestMethod method, String url, HttpParameter[] parameters
            , Authorization authorization, Map requestHeaders) {
        this.method = method;
        // Modified for Facebook4J start
        parameters = setAccessTokenParameter(parameters, authorization);
        parameters = setAppSecretProofParameter(parameters, authorization);
        // Modified for Facebook4J end
        if (method != RequestMethod.POST && parameters != null && parameters.length != 0) {
            // Modified for Facebook4J start
            if (url.contains("?")) {
                this.url = url + "&" + HttpParameter.encodeParameters(parameters);
            } else {
                this.url = url + "?" + HttpParameter.encodeParameters(parameters);
            }
            // Modified for Facebook4J end
            this.parameters = NULL_PARAMETERS;
        } else {
            this.url = url;
            // Modified for Facebook4J start
            if (parameters == null) {
                this.parameters = NULL_PARAMETERS;
            } else {
                this.parameters = parameters;
            }
            // Modified for Facebook4J end
        }
        this.authorization = authorization;
        this.requestHeaders = requestHeaders;
    }

    // Added method by Facebook4J
    private HttpParameter[] setAccessTokenParameter(HttpParameter[] parameters, Authorization authorization) {
        if (authorization == null) return parameters;
        if (!(authorization instanceof OAuthAuthorization)) return parameters;
        AccessToken accessToken = ((OAuthAuthorization) authorization).getOAuthAccessToken();
        if (accessToken == null) return parameters;
        return HttpParameter.merge(parameters,  new HttpParameter("access_token", accessToken.getToken()));
    }

    private HttpParameter[] setAppSecretProofParameter(HttpParameter[] parameters, Authorization authorization) {
        if (authorization == null) return parameters;
        if (!(authorization instanceof OAuthAuthorization)) return parameters;
        OAuthAuthorization oAuthAuthorization = (OAuthAuthorization) authorization;
        if (!oAuthAuthorization.isAppSecretProofEnabled()) return parameters;
        String appSecretProof = oAuthAuthorization.generateAppSecretProof();
        return HttpParameter.merge(parameters,  new HttpParameter("appsecret_proof", appSecretProof));
    }

    public RequestMethod getMethod() {
        return method;
    }

    public HttpParameter[] getParameters() {
        return parameters;
    }

    public String getURL() {
        return url;
    }

    public Authorization getAuthorization() {
        return authorization;
    }

    public Map getRequestHeaders() {
        return requestHeaders;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        HttpRequest that = (HttpRequest) o;

        if (authorization != null ? !authorization.equals(that.authorization) : that.authorization != null)
            return false;
        if (!Arrays.equals(parameters, that.parameters)) return false;
        if (requestHeaders != null ? !requestHeaders.equals(that.requestHeaders) : that.requestHeaders != null)
            return false;
        if (method != null ? !method.equals(that.method) : that.method != null)
            return false;
        if (url != null ? !url.equals(that.url) : that.url != null)
            return false;

        return true;
    }

    @Override
    public int hashCode() {
        int result = method != null ? method.hashCode() : 0;
        result = 31 * result + (url != null ? url.hashCode() : 0);
        result = 31 * result + (parameters != null ? Arrays.hashCode(parameters) : 0);
        result = 31 * result + (authorization != null ? authorization.hashCode() : 0);
        result = 31 * result + (requestHeaders != null ? requestHeaders.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "HttpRequest{" +
                "requestMethod=" + method +
                ", url='" + url + '\'' +
                ", postParams=" + (parameters == null ? null : Arrays.asList(parameters)) +
                ", authentication=" + authorization +
                ", requestHeaders=" + requestHeaders +
                '}';
    }
}