com.rollbar.payload.data.Request Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rollbar-payload Show documentation
A set of classes that allow reporting errors to Rollbar.
The newest version!
package com.rollbar.payload.data;

import com.rollbar.utilities.Extensible;

import java.net.InetAddress;
import java.util.*;

/**
 * Represents the HTTP request that triggered the error
 */
public class Request extends Extensible {
    public static final String URL_KEY = "url";
    public static final String METHOD_KEY = "method";
    public static final String HEADERS_KEY = "headers";
    public static final String PARAMS_KEY = "params";
    public static final String GET_KEY = "GET";
    public static final String QUERY_STRING_KEY = "query_string";
    public static final String POST_KEY = "POST";
    public static final String BODY_KEY = "body";
    public static final String USER_IP_KEY = "user_ip";
    private static final Set keys = new HashSet();

    static {
        final String[] keys = new String[]{
                URL_KEY,
                METHOD_KEY,
                HEADERS_KEY,
                PARAMS_KEY,
                GET_KEY,
                QUERY_STRING_KEY,
                POST_KEY,
                BODY_KEY,
                USER_IP_KEY
        };
        Collections.addAll(Request.keys, keys);
    }

    /**
     * Constructor
     * @param members map of custom arguments
     */
    private Request(Map members) {
        super(members);
    }

    /**
     * Constructor
     */
    public Request() {
        this(null, null, null, null, null, null, null, null, null, null);
    }

    /**
     * Constructor
     * @param url the url
     * @param method the HTTP method
     * @param headers the HTTP Headers
     * @param params the routing parameters (typically derived from your routing module)
     * @param get the parsed query string parameters
     * @param queryString the raw query string
     * @param post POST parameters
     * @param body the raw POST body
     * @param userIp the ip address of the affected user
     */
    public Request(String url, String method, Map headers, Map params,
                   Map get, String queryString, Map post, String body,
                   InetAddress userIp) {
        this(url, method, headers, params, get, queryString, post, body, userIp, null);
    }

    /**
     * Constructor
     * @param url the url
     * @param method the HTTP method
     * @param headers the HTTP Headers
     * @param params the routing parameters (typically derived from your routing module)
     * @param get the parsed query string parameters
     * @param queryString the raw query string
     * @param post POST parameters
     * @param body the raw POST body
     * @param userIp the ip address of the affected user
     * @param members the custom arguments
     */
    public Request(String url, String method, Map headers, Map params,
                   Map get, String queryString, Map post, String body,
                   InetAddress userIp, Map members) {
        super(members);
        putKnown(URL_KEY, url);
        putKnown(METHOD_KEY, method);
        putKnown(HEADERS_KEY, headers == null ? null : new LinkedHashMap(headers));
        putKnown(PARAMS_KEY, params == null ? null : new LinkedHashMap(params));
        putKnown(GET_KEY, get == null ? null : new LinkedHashMap(get));
        putKnown(QUERY_STRING_KEY, queryString);
        putKnown(POST_KEY, post == null ? null : new LinkedHashMap(post));
        putKnown(BODY_KEY, body);
        putKnown(USER_IP_KEY, userIp == null ? null : userIp.getHostAddress());
    }

    @Override
    protected Set getKnownMembers() {
        return keys;
    }

    @Override
    public Request copy() {
        return new Request(getMembers());
    }

    /**
     * @return the url
     */
    public String url() {
        return (String) get(URL_KEY);
    }

    /**
     * Set the url on a copy of this Request
     * @param url the url
     * @return a copy of this request with the new url
     */
    public Request url(String url) {
        return new Request(url, method(), headers(), params(), getGet(), queryString(), post(), body(), userIp(), getMembers());
    }

    /**
     * @return the HTTP method
     */
    public String method() {
        return (String) get(METHOD_KEY);
    }

    /**
     * Set the HTTP method on a copy of this Request
     * @param method the HTTP method
     * @return a copy of this request with the new HTTP method
     */
    public Request method(String method) {
        return new Request(url(), method, headers(), params(), getGet(), queryString(), post(), body(), userIp(), getMembers());
    }

    /**
     * @return the HTTP headers
     */
    public Map headers() {
        @SuppressWarnings("unchecked")
        LinkedHashMap headers = (LinkedHashMap) get(HEADERS_KEY);
        return headers;
    }

    /**
     * Set the HTTP headers on a copy of this Request
     * @param headers the HTTP headers
     * @return a copy of this request with the new HTTP headers
     */
    public Request headers(Map headers) {
        return new Request(url(), method(), headers, params(), getGet(), queryString(), post(), body(), userIp(), getMembers());
    }

    /**
     * @return the routing parameters, typically parsed out of the URL by your routing module
     */
    public Map params() {
        @SuppressWarnings("unchecked")
        LinkedHashMap params = (LinkedHashMap) get(PARAMS_KEY);
        return params;
    }

    /**
     * Set the routing parameters on a copy of this Request
     * @param params the routing parameters
     * @return a copy of this request with the new routing parameters
     */
    public Request params(Map params) {
        return new Request(url(), method(), headers(), params, getGet(), queryString(), post(), body(), userIp(), getMembers());
    }

    /**
     * Get the parsed query string parameters
     * @return the parsed query string parameters
     */
    public Map getGet() {
        @SuppressWarnings("unchecked")
        LinkedHashMap get = (LinkedHashMap) get(GET_KEY);
        return get;
    }

    /**
     * Set the parsed query string parameters on a copy of this Request
     * @param get the parsed query string parameters
     * @return a copy of this request with the new parsed query string parameters
     */
    public Request setGet(Map get) {
        return new Request(url(), method(), headers(), params(), get, queryString(), post(), body(), userIp(), getMembers());
    }

    /**
     * @return the raw query string
     */
    public String queryString() {
        return (String) get(QUERY_STRING_KEY);
    }

    /**
     * Set the raw query string on a copy of this Request
     * @param queryString the raw query string
     * @return a copy of this request with the new raw query string
     */
    public Request queryString(String queryString) {
        return new Request(url(), method(), headers(), params(), getGet(), queryString, post(), body(), userIp(), getMembers());
    }

    /**
     * @return the parsed POST parameters
     */
    public Map post() {
        @SuppressWarnings("unchecked")
        LinkedHashMap post = (LinkedHashMap) get(POST_KEY);
        return post;
    }

    /**
     * Set the parsed POST parameters on a copy of this Request
     * @param post the parsed POST parameters
     * @return a copy of this request with the new parsed POST parameters
     */
    public Request post(Map post) {
        return new Request(url(), method(), headers(), params(), getGet(), queryString(), post, body(), userIp(), getMembers());
    }

    /**
     * @return the raw POST body
     */
    public String body() {
        return (String) get(BODY_KEY);
    }

    /**
     * Set the raw POST body on a copy of this Request
     * @param body the raw POST body
     * @return a copy of this request with the new raw POST body
     */
    public Request body(String body) {
        return new Request(url(), method(), headers(), params(), getGet(), queryString(), post(), body, userIp(), getMembers());
    }

    /**
     * @return the affected user's IP address
     */
    public InetAddress userIp() {
        Object ip = get(USER_IP_KEY);
        try {
            return ip == null ? null : InetAddress.getByName((String) get(USER_IP_KEY));
        }
        catch (java.net.UnknownHostException e) {
            return null;
        }
    }

    /**
     * Set the affected user's IP Address on a copy of this Request
     * @param userIp the affected user's IP Address
     * @return a copy of this request with the new affected user's IP Address
     */
    public Request userIp(InetAddress userIp) {
        return new Request(url(), method(), headers(), params(), getGet(), queryString(), post(), body(), userIp, getMembers());
    }
}