com.moesif.api.http.request.HttpRequest Maven / Gradle / Ivy

Go to download
/*
 * MoesifAPILib
 *
 *
 */
package com.moesif.api.http.request;

import com.moesif.api.http.request.HttpMethod;

import java.util.Map;

public class HttpRequest {
    /**
     * Private store for properties
     */
    private HttpMethod httpMethod;
    private Map headers;
    private String queryUrl;
    private Map parameters;
    private String username;
    private String password;

    /**
     * Headers for the http request
     * @return the HTTP method/verb
     */
    public HttpMethod getHttpMethod() {
        return httpMethod;
    }

    /**
     * Headers for the http request
     * @return the HTTP request headers
     */
    public Map getHeaders() {
        return headers;
    }

    /**
     * Query url for the http request
     * @return the query url
     */
    public String getQueryUrl() {
        return queryUrl;
    }

    /**
     * Parameters for the http request
     * @return the parameters as a map
     */
    public Map getParameters() {
        return parameters;
    }

    /**
     * Username for basic authentication
     * @return the username part for basic auth
     */
    public String getUsername() {
        return username;
    }

    /**
     * Password for basic authentication
     * @return the password part for basic auth
     */
    public String getPassword() {
        return password;
    }

    /**
     * Initializes a simple http request
     *
     * @param _method     The HTTP method to use. Can be GET, HEAD, PUT, POST, DELETE and PATCH
     * @param _queryUrl   The http url to create the HTTP Request. Expect a fully qualified absolute Url
     * @param _headers    The key-value map of all http headers to be sent
     * @param _parameters The form data values in a key-value map
     */
    public HttpRequest(HttpMethod _method, String _queryUrl,
                       Map _headers, Map _parameters) {
        this.httpMethod = _method;
        this.queryUrl = _queryUrl;
        this.headers = _headers;
        this.parameters = _parameters;
    }

    /**
     * Initializes a simple http request
     *
     * @param _method     The HTTP method to use. Can be GET, HEAD, PUT, POST, DELETE and PATCH
     * @param _queryUrl   The http url to create the HTTP Request. Expect a fully qualified absolute Url
     * @param _headers    The key-value map of all http headers to be sent
     * @param _parameters The form data values in a key-value map
     * @param _username   Username for basic authentication
     * @param _password   Password for basic authentication
     */
    public HttpRequest(HttpMethod _method, String _queryUrl,
                       Map _headers, Map _parameters,
                       String _username, String _password) {
        this(_method, _queryUrl, _headers, _parameters);
        this.username = _username;
        this.password = _password;
    }
}