org.sourcelab.http.rest.request.Request Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client-wrapper Show documentation

A library to abstract common patterns for building http rest clients.

There is a newer version: 0.2.1

/**
 * Copyright 2019 SourceLab.org https://github.com/SourceLabOrg/http-client-wrapper
 *
 * 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 org.sourcelab.http.rest.request;

import org.sourcelab.http.rest.request.body.RequestBodyContent;

import java.io.IOException;

/**
 * Interface for all Requests to implement.
 * @param  return type of request.
 */
public interface Request {

    /**
     * The name of the API end point to issue a request against.  This is appended to the API Hostname.
     * @return The name of the end point this request uses.
     */
    String getApiEndpoint();

    /**
     * Request Method, IE POST, GET, etc..
     * @return The type of HTTP Request.
     */
    RequestMethod getRequestMethod();

    /**
     * Object to be submitted as the body of the request.
     * The request body will be populated by calling .toString() on the returned object.
     * Return null if no request body should be sent.
     *
     * @return Object representing request body content, or null if none required.
     */
    RequestBodyContent getRequestBody();

    /**
     * Parse the rest service's response into a concrete object.
     * @param responseStr The servers response in string format.
     * @return A concrete object representing the result.
     * @throws IOException on parsing errors.
     */
    T parseResponse(final String responseStr) throws IOException;
}