kong.unirest.core.HttpRequestSummary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unirest-java-core Show documentation

Simplified, lightweight HTTP client library.

There is a newer version: 4.4.5

/**
 * The MIT License
 *
 * Copyright for portions of unirest-java are held by Kong Inc (c) 2013.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package kong.unirest.core;

import java.util.Collection;

/**
 * A summary of a request about to be performed
 */
public interface HttpRequestSummary {
    /**
     * @return The HTTP method of the request
     */
    HttpMethod getHttpMethod();

    /**
     * @return The current full URL string for the request with query params (http://somewhere/else?colour=red)
     */
    String getUrl();

    /**
     * @return The raw un-parameterized path without query strings (http://somewhere/{param})
     */
    String getRawPath();

    /**
     * @return a string summary of the request suitable for logging
     */
    String asString();


    /**
     * @return an immutable collection of the headers for the request
     */
    Collection getHeaders();
}