com.urswolfer.gerrit.client.rest

Interface RestClient

All Known Implementing Classes:

GerritRestClient

public interface RestClient

This interface provides basic HTTP access to the REST interface of a Gerrit instance. All HTTP operations support authentication and other stuff required for REST (or basic HTTP) calls.

Author:

Urs Wolfer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RestClient.HttpVerb

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonElement	deleteRequest(String path) Shortcut for #requestJson for doing DELETE operation.
com.google.gson.Gson	getGson() Returns Gson with optimal configuration for Gerrit REST API.
com.google.gson.JsonElement	getRequest(String path) Shortcut for #requestJson for doing GET operation.
com.google.gson.JsonElement	postRequest(String path) Shortcut for #requestJson for doing POST operation.
com.google.gson.JsonElement	postRequest(String path, String requestBody) Shortcut for #requestJson for doing POST operation with a request body.
com.google.gson.JsonElement	putRequest(String path) Shortcut for #requestJson for doing PUT operation.
com.google.gson.JsonElement	putRequest(String path, String requestBody) Shortcut for #requestJson for doing PUT operation with a request body.
org.apache.http.HttpResponse	request(String path, String requestBody, RestClient.HttpVerb verb, org.apache.http.Header... headers) Executes a HTTP request and returns plain response.
com.google.gson.JsonElement	requestJson(String path, String requestBody, RestClient.HttpVerb verb) Executes a request and returns a JSON response.
org.apache.http.HttpResponse	requestRest(String path, String requestBody, RestClient.HttpVerb verb) Executes a request with Accept-header set to "application/json" and returns plain response.

Method Detail

getGson

com.google.gson.Gson getGson()

Returns Gson with optimal configuration for Gerrit REST API.

getRequest

com.google.gson.JsonElement getRequest(String path)
                                throws RestApiException

Shortcut for #requestJson for doing GET operation.

Throws:

RestApiException

postRequest

com.google.gson.JsonElement postRequest(String path)
                                 throws RestApiException

Shortcut for #requestJson for doing POST operation.

Throws:

RestApiException

postRequest

com.google.gson.JsonElement postRequest(String path,
                                        String requestBody)
                                 throws RestApiException

Shortcut for #requestJson for doing POST operation with a request body.

Throws:

RestApiException

putRequest

com.google.gson.JsonElement putRequest(String path)
                                throws RestApiException

Shortcut for #requestJson for doing PUT operation.

Throws:

RestApiException

putRequest

com.google.gson.JsonElement putRequest(String path,
                                       String requestBody)
                                throws RestApiException

Shortcut for #requestJson for doing PUT operation with a request body.

Throws:

RestApiException

deleteRequest

com.google.gson.JsonElement deleteRequest(String path)
                                   throws RestApiException

Shortcut for #requestJson for doing DELETE operation.

Throws:

RestApiException

requestJson

com.google.gson.JsonElement requestJson(String path,
                                        String requestBody,
                                        RestClient.HttpVerb verb)
                                 throws RestApiException

Executes a request and returns a JSON response.

Throws:

RestApiException

requestRest

org.apache.http.HttpResponse requestRest(String path,
                                         String requestBody,
                                         RestClient.HttpVerb verb)
                                  throws IOException,
                                         HttpStatusException

Executes a request with Accept-header set to "application/json" and returns plain response.

Throws:

IOException

HttpStatusException

request

org.apache.http.HttpResponse request(String path,
                                     String requestBody,
                                     RestClient.HttpVerb verb,
                                     org.apache.http.Header... headers)
                              throws IOException,
                                     HttpStatusException

Executes a HTTP request and returns plain response. Can be used to request non-JSON resources.

Throws:

IOException

HttpStatusException