com.messners.gitlab.api

Class AbstractApi

java.lang.Object

com.messners.gitlab.api.AbstractApi

Direct Known Subclasses:

CommitsApi, GroupApi, MergeRequestApi, ProjectApi, RepositoryApi, RepositoryFileApi, SessionApi, UserApi

public abstract class AbstractApi
extends Object

This class is the base class for all the sub API classes. It provides implementations of delete(), get(), post() and put() that are re-used by all the sub-classes.

Author:

Greg Messner

Constructor Summary

Constructors

Constructor and Description
AbstractApi(GitLabApi gitLabApi)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFormParam(javax.ws.rs.core.Form formData, String name, Object value) Convenience method for adding query and form parameters to a get() or post() call.
protected void	addFormParam(javax.ws.rs.core.Form formData, String name, Object value, boolean required) Convenience method for adding query and form parameters to a get() or post() call.
protected javax.ws.rs.core.Response	delete(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Object... pathArgs) Perform an HTTP DELETE call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	delete(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, URL url) Perform an HTTP DELETE call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	get(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Object... pathArgs) Perform an HTTP GET call with the specified query parameters and path objects, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	get(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, URL url) Perform an HTTP GET call with the specified query parameters and URL, returning a ClientResponse instance with the data returned from the endpoint.
protected GitLabApiClient	getApiClient()
protected GitLabApiException	handle(Exception thrown) Wraps exception if needed
protected javax.ws.rs.core.Response	post(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.Form formData, Object... pathArgs) Perform an HTTP POST call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	post(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.Form formData, URL url) Perform an HTTP POST call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	put(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Object... pathArgs) Perform an HTTP PUT call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	put(javax.ws.rs.core.Response.Status expectedStatus, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, URL url) Perform an HTTP PUT call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	validate(javax.ws.rs.core.Response response, javax.ws.rs.core.Response.Status expected) Validates response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractApi

public AbstractApi(GitLabApi gitLabApi)

Method Detail

getApiClient

protected GitLabApiClient getApiClient()

get

protected javax.ws.rs.core.Response get(javax.ws.rs.core.Response.Status expectedStatus,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            Object... pathArgs)
                                 throws GitLabApiException

Perform an HTTP GET call with the specified query parameters and path objects, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

pathArgs -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

get

protected javax.ws.rs.core.Response get(javax.ws.rs.core.Response.Status expectedStatus,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            URL url)
                                 throws GitLabApiException

Perform an HTTP GET call with the specified query parameters and URL, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

url -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

post

protected javax.ws.rs.core.Response post(javax.ws.rs.core.Response.Status expectedStatus,
                             javax.ws.rs.core.Form formData,
                             Object... pathArgs)
                                  throws GitLabApiException

Perform an HTTP POST call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

formData -

pathArgs -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

post

protected javax.ws.rs.core.Response post(javax.ws.rs.core.Response.Status expectedStatus,
                             javax.ws.rs.core.Form formData,
                             URL url)
                                  throws GitLabApiException

Perform an HTTP POST call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

formData -

url -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

put

protected javax.ws.rs.core.Response put(javax.ws.rs.core.Response.Status expectedStatus,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            Object... pathArgs)
                                 throws GitLabApiException

Perform an HTTP PUT call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

pathArgs -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

put

protected javax.ws.rs.core.Response put(javax.ws.rs.core.Response.Status expectedStatus,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            URL url)
                                 throws GitLabApiException

Perform an HTTP PUT call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

url -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

delete

protected javax.ws.rs.core.Response delete(javax.ws.rs.core.Response.Status expectedStatus,
                               javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                               Object... pathArgs)
                                    throws GitLabApiException

Perform an HTTP DELETE call with the specified form data and path objects, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

pathArgs -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

delete

protected javax.ws.rs.core.Response delete(javax.ws.rs.core.Response.Status expectedStatus,
                               javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                               URL url)
                                    throws GitLabApiException

Perform an HTTP DELETE call with the specified form data and URL, returning a ClientResponse instance with the data returned from the endpoint.

Parameters:

expectedStatus - the HTTP status that should be returned from the server

queryParams -

url -

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

GitLabApiException

addFormParam

protected void addFormParam(javax.ws.rs.core.Form formData,
                String name,
                Object value)
                     throws IllegalArgumentException

Convenience method for adding query and form parameters to a get() or post() call.

Parameters:

formData -

name -

value -

Throws:

IllegalArgumentException

addFormParam

protected void addFormParam(javax.ws.rs.core.Form formData,
                String name,
                Object value,
                boolean required)
                     throws IllegalArgumentException

Convenience method for adding query and form parameters to a get() or post() call. If required is true and value is null, will throw an IllegalArgumentException.

Parameters:

formData -

name -

value -

required -

Throws:

IllegalArgumentException - if a required parameter is null or empty

validate

protected javax.ws.rs.core.Response validate(javax.ws.rs.core.Response response,
                                 javax.ws.rs.core.Response.Status expected)
                                      throws GitLabApiException

Validates response.

Parameters:

response - response

expected - expected respone status

Returns:

original response if the response status is expected

Throws:

GitLabApiException - in case of unexpected response status

handle

protected GitLabApiException handle(Exception thrown)
                             throws GitLabApiException

Wraps exception if needed

Parameters:

thrown - exception

Returns:

never returns

Throws:

GitLabApiException - always