org.sourcelab.github.client.http.Client Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of github-rest-api Show documentation

A for Github's rest API

The newest version!


package org.sourcelab.github.client.http;

import org.sourcelab.github.client.request.Request;

import java.io.Closeable;

/**
 * Abstraction around underlying Http Client library.  Allows for replacing the
 * underlying library in the future if needed.
 */
public interface Client extends Closeable {
    /**
     * Execute the supplied request and return the server's response.
     * @param request The request to execute.
     * @return The API response.
     */
    HttpResult executeRequest(final Request request);

    /**
     * Close the Client implementation and release any resources it
     * may have open.
     */
    void close();
}