org.gitlab4j.api

Class GitLabApiClient

java.lang.Object

org.gitlab4j.api.GitLabApiClient

public class GitLabApiClient
extends Object

This class utilizes the Jersey client package to communicate with a GitLab API endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTHORIZATION_HEADER
protected static String	PRIVATE_TOKEN_HEADER
protected static String	SUDO_HEADER
protected static String	X_GITLAB_TOKEN_HEADER

Constructor Summary

Constructors

Constructor and Description
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, auth token type, private or access token, and secret token.
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken, Map<String,Object> clientConfigProperties) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL and private token.
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.
GitLabApiClient(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken, Map<String,Object> clientConfigProperties) Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL and private token.
GitLabApiClient(String hostUrl, Constants.TokenType tokenType, String authToken) Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.
GitLabApiClient(String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken) Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.
GitLabApiClient(String hostUrl, String privateToken) Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.
GitLabApiClient(String hostUrl, String privateToken, String secretToken) Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.
GitLabApiClient(String hostUrl, String privateToken, String secretToken, Map<String,Object> clientConfigProperties) Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL and private token.

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	delete(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 Response instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	delete(javax.ws.rs.core.MultivaluedMap<String,String> queryParams, URL url) Perform an HTTP DELETE call with the specified form data and URL, returning a Response instance with the data returned from the endpoint.
protected javax.ws.rs.core.Response	get(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.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 URL	getApiUrl(Object... pathArgs) Construct a REST URL with the specified path arguments.
boolean	getIgnoreCertificateErrors() Returns true if the API is setup to ignore SSL certificate errors, otherwise returns false.
protected javax.ws.rs.core.Response	getWithAccepts(javax.ws.rs.core.MultivaluedMap<String,String> queryParams, String accepts, 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	getWithAccepts(javax.ws.rs.core.MultivaluedMap<String,String> queryParams, URL url, String accepts) Perform an HTTP GET call with the specified query parameters and URL, returning a ClientResponse instance with the data returned from the endpoint.
protected javax.ws.rs.client.Invocation.Builder	invocation(URL url, javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
protected javax.ws.rs.client.Invocation.Builder	invocation(URL url, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, String accept)
protected javax.ws.rs.core.Response	post(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.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	post(javax.ws.rs.core.MultivaluedMap<String,String> queryParams, 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.MultivaluedMap<String,String> queryParams, 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.Form formData, 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.Form formData, 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	put(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.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.
void	setIgnoreCertificateErrors(boolean ignoreCertificateErrors) Sets up the Jersey system ignore SSL certificate errors or not.
protected boolean	validateSecretToken(javax.ws.rs.core.Response response) Validates the secret token (X-GitLab-Token) header against the expected secret token, returns true if valid, otherwise returns false.

Methods inherited from class java.lang.Object

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

Field Detail

PRIVATE_TOKEN_HEADER

protected static final String PRIVATE_TOKEN_HEADER

See Also:

Constant Field Values

SUDO_HEADER

protected static final String SUDO_HEADER

See Also:

Constant Field Values

AUTHORIZATION_HEADER

protected static final String AUTHORIZATION_HEADER

See Also:

Constant Field Values

X_GITLAB_TOKEN_HEADER

protected static final String X_GITLAB_TOKEN_HEADER

See Also:

Constant Field Values

Constructor Detail

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       String privateToken)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       Constants.TokenType tokenType,
                       String authToken)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, auth token type, private or access token, and secret token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

tokenType - the type of auth the token is for, PRIVATE or ACCESS

authToken - the token to authenticate with

GitLabApiClient

public GitLabApiClient(String hostUrl,
                       String privateToken)

Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.

Parameters:

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

GitLabApiClient

public GitLabApiClient(String hostUrl,
                       Constants.TokenType tokenType,
                       String authToken)

Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.

Parameters:

hostUrl - the URL to the GitLab API server

tokenType - the type of auth the token is for, PRIVATE or ACCESS

authToken - the token to authenticate with

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       String privateToken,
                       String secretToken)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

secretToken - use this token to validate received payloads

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       Constants.TokenType tokenType,
                       String authToken,
                       String secretToken)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL, private token, and secret token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

tokenType - the type of auth the token is for, PRIVATE or ACCESS

authToken - the token to authenticate with

secretToken - use this token to validate received payloads

GitLabApiClient

public GitLabApiClient(String hostUrl,
                       String privateToken,
                       String secretToken)

Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.

Parameters:

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

secretToken - use this token to validate received payloads

GitLabApiClient

public GitLabApiClient(String hostUrl,
                       Constants.TokenType tokenType,
                       String authToken,
                       String secretToken)

Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL, private token, and secret token.

Parameters:

hostUrl - the URL to the GitLab API server

tokenType - the type of auth the token is for, PRIVATE or ACCESS

authToken - the token to authenticate with

secretToken - use this token to validate received payloads

GitLabApiClient

public GitLabApiClient(String hostUrl,
                       String privateToken,
                       String secretToken,
                       Map<String,Object> clientConfigProperties)

Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified server URL and private token.

Parameters:

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

secretToken - use this token to validate received payloads

clientConfigProperties - the properties given to Jersey's clientconfig

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       String privateToken,
                       String secretToken,
                       Map<String,Object> clientConfigProperties)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL and private token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

privateToken - the private token to authenticate with

secretToken - use this token to validate received payloads

clientConfigProperties - the properties given to Jersey's clientconfig

GitLabApiClient

public GitLabApiClient(GitLabApi.ApiVersion apiVersion,
                       String hostUrl,
                       Constants.TokenType tokenType,
                       String authToken,
                       String secretToken,
                       Map<String,Object> clientConfigProperties)

Construct an instance to communicate with a GitLab API server using the specified GitLab API version, server URL and private token.

Parameters:

apiVersion - the ApiVersion specifying which version of the API to use

hostUrl - the URL to the GitLab API server

tokenType - the type of auth the token is for, PRIVATE or ACCESS

authToken - the private token to authenticate with

secretToken - use this token to validate received payloads

clientConfigProperties - the properties given to Jersey's clientconfig

Method Detail

getApiUrl

protected URL getApiUrl(Object... pathArgs)
                 throws IOException

Construct a REST URL with the specified path arguments.

Parameters:

pathArgs - variable list of arguments used to build the URI

Returns:

a REST URL with the specified path arguments

Throws:

IOException - if an error occurs while constructing the URL

validateSecretToken

protected boolean validateSecretToken(javax.ws.rs.core.Response response)

Validates the secret token (X-GitLab-Token) header against the expected secret token, returns true if valid, otherwise returns false.

Parameters:

response - the Response instance sent from the GitLab server

Returns:

true if the response's secret token is valid, otherwise returns false

get

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

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:

queryParams - multivalue map of request parameters

pathArgs - variable list of arguments used to build the URI

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

get

protected javax.ws.rs.core.Response get(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.

Parameters:

queryParams - multivalue map of request parameters

url - the fully formed path to the GitLab API endpoint

Returns:

a ClientResponse instance with the data returned from the endpoint

getWithAccepts

protected javax.ws.rs.core.Response getWithAccepts(javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                                   String accepts,
                                                   Object... pathArgs)
                                            throws IOException

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:

queryParams - multivalue map of request parameters

accepts - if non-empty will set the Accepts header to this value

pathArgs - variable list of arguments used to build the URI

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

getWithAccepts

protected javax.ws.rs.core.Response getWithAccepts(javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                                   URL url,
                                                   String accepts)

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

Parameters:

queryParams - multivalue map of request parameters

url - the fully formed path to the GitLab API endpoint

accepts - if non-empty will set the Accepts header to this value

Returns:

a ClientResponse instance with the data returned from the endpoint

post

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

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:

formData - the Form containing the name/value pairs

pathArgs - variable list of arguments used to build the URI

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

post

protected javax.ws.rs.core.Response post(javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                         Object... pathArgs)
                                  throws IOException

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:

queryParams - multivalue map of request parameters

pathArgs - variable list of arguments used to build the URI

Returns:

a Response instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

post

protected javax.ws.rs.core.Response post(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.

Parameters:

formData - the Form containing the name/value pairs

url - the fully formed path to the GitLab API endpoint

Returns:

a ClientResponse instance with the data returned from the endpoint

post

protected javax.ws.rs.core.Response post(javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                         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.

Parameters:

queryParams - multivalue map of request parametersformData the Form containing the name/value pairs

url - the fully formed path to the GitLab API endpoint

Returns:

a ClientResponse instance with the data returned from the endpoint

put

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

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:

queryParams - multivalue map of request parameters

pathArgs - variable list of arguments used to build the URI

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

put

protected javax.ws.rs.core.Response put(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.

Parameters:

queryParams - multivalue map of request parameters

url - the fully formed path to the GitLab API endpoint

Returns:

a ClientResponse instance with the data returned from the endpoint

put

protected javax.ws.rs.core.Response put(javax.ws.rs.core.Form formData,
                                        Object... pathArgs)
                                 throws IOException

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:

formData - the Form containing the name/value pairs

pathArgs - variable list of arguments used to build the URI

Returns:

a ClientResponse instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

put

protected javax.ws.rs.core.Response put(javax.ws.rs.core.Form formData,
                                        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.

Parameters:

formData - the Form containing the name/value pairs

url - the fully formed path to the GitLab API endpoint

Returns:

a ClientResponse instance with the data returned from the endpoint

delete

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

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

Parameters:

queryParams - multivalue map of request parameters

pathArgs - variable list of arguments used to build the URI

Returns:

a Response instance with the data returned from the endpoint

Throws:

IOException - if an error occurs while constructing the URL

delete

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

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

Parameters:

queryParams - multivalue map of request parameters

url - the fully formed path to the GitLab API endpoint

Returns:

a Response instance with the data returned from the endpoint

invocation

protected javax.ws.rs.client.Invocation.Builder invocation(URL url,
                                                           javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

invocation

protected javax.ws.rs.client.Invocation.Builder invocation(URL url,
                                                           javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                                           String accept)

getIgnoreCertificateErrors

public boolean getIgnoreCertificateErrors()

Returns true if the API is setup to ignore SSL certificate errors, otherwise returns false.

Returns:

true if the API is setup to ignore SSL certificate errors, otherwise returns false

setIgnoreCertificateErrors

public void setIgnoreCertificateErrors(boolean ignoreCertificateErrors)

Sets up the Jersey system ignore SSL certificate errors or not.

Parameters:

ignoreCertificateErrors - if true will set up the Jersey system ignore SSL certificate errors