org.gitlab4j.api

Class GitLabApi

java.lang.Object

org.gitlab4j.api.GitLabApi

public class GitLabApi
extends Object

This class is provides a simplified interface to a GitLab API server, and divides the API up into a separate API class for each concern.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitLabApi.ApiVersion Specifies the version of the GitLab API to communicate with.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PER_PAGE GitLab4J default per page.

Constructor Summary

Constructors

Constructor and Description
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken) Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken) Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken, Map<String,Object> clientConfigProperties) Constructs a GitLabApi instance set up to interact with the GitLab server specified by GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, Session session) Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken) Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken) Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.
GitLabApi(GitLabApi.ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken, Map<String,Object> clientConfigProperties) Constructs a GitLabApi instance set up to interact with the GitLab server specified by GitLab API version.
GitLabApi(String hostUrl, Constants.TokenType tokenType, String authToken) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, Constants.TokenType tokenType, String authToken, String secretToken, Map<String,Object> clientConfigProperties) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, Session session) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, String privateToken) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, String privateToken, String secretToken) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.
GitLabApi(String hostUrl, String privateToken, String secretToken, Map<String,Object> clientConfigProperties) Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Method Summary

Modifier and Type	Method and Description
static GitLabApi	create(String url, String username, String password) Deprecated. As of release 4.2.0, replaced by login(String, String, String)
GitLabApi.ApiVersion	getApiVersion() Return the GitLab API version that this instance is using.
CommitsApi	getCommitsApi() Gets the CommitsApi instance owned by this GitLabApi instance.
int	getDefaultPerPage() Get the default number per page for calls that return multiple items.
DeployKeysApi	getDeployKeysApi() Gets the DeployKeysApi instance owned by this GitLabApi instance.
EventsApi	getEventsApi() Gets the EventsApi instance owned by this GitLabApi instance.
GroupApi	getGroupApi() Gets the GroupApi instance owned by this GitLabApi instance.
boolean	getIgnoreCertificateErrors() Returns true if the API is setup to ignore SSL certificate errors, otherwise returns false.
IssuesApi	getIssuesApi() Gets the IssuesApi instance owned by this GitLabApi instance.
JobApi	getJobApi() Gets the JobApi instance owned by this GitLabApi instance.
MergeRequestApi	getMergeRequestApi() Gets the MergeRequestApi instance owned by this GitLabApi instance.
NamespaceApi	getNamespaceApi() Gets the NamespaceApi instance owned by this GitLabApi instance.
NotesApi	getNotesApi() Gets the NotesApi instance owned by this GitLabApi instance.
PipelineApi	getPipelineApi() Gets the PipelineApi instance owned by this GitLabApi instance.
ProjectApi	getProjectApi() Gets the ProjectApi instance owned by this GitLabApi instance.
RepositoryApi	getRepositoryApi() Gets the RepositoryApi instance owned by this GitLabApi instance.
RepositoryFileApi	getRepositoryFileApi() Gets the RepositoryFileApi instance owned by this GitLabApi instance.
ServicesApi	getServicesApi() Gets the ServicesApi instance owned by this GitLabApi instance.
Session	getSession() If this instance was created with login(String, String, String) this method will return the Session instance returned by the GitLab API on login, otherwise returns null.
SessionApi	getSessionApi() Gets the SessionApi instance owned by this GitLabApi instance.
Integer	getSudoAsId() Get the current sudo as ID, will return null if not in sudo mode.
UserApi	getUserApi() Gets the UserApi instance owned by this GitLabApi instance.
Version	getVersion() Get the version info for the GitLab server using the GitLab Version API.
static GitLabApi	login(GitLabApi.ApiVersion apiVersion, String url, String username, String password) Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token and the specified GitLab API version.
static GitLabApi	login(String url, String username, String password) Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token using GitLab API version 4.
void	setDefaultPerPage(int defaultPerPage) Set the default number per page for calls that return multiple items.
void	setIgnoreCertificateErrors(boolean ignoreCertificateErrors) Sets up the Jersey system ignore SSL certificate errors or not.
void	setNamespaceApi(NamespaceApi namespaceApi)
void	setSudoAsId(Integer sudoAsId) Sets up all future calls to the GitLab API to be done as another user specified by provided user ID.
void	sudo(String sudoAsUsername) Sets up all future calls to the GitLab API to be done as another user specified by sudoAsUsername.
void	unsudo() Turns off the currently configured sudo as ID.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PER_PAGE

public static final int DEFAULT_PER_PAGE

GitLab4J default per page. GitLab will ignore anything over 100.

See Also:

Constant Field Values

Constructor Detail

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

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

authToken - the token to use for access to the API

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

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

authToken - the token to use for access to the API

GitLabApi

public GitLabApi(String hostUrl,
                 String privateToken)

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

GitLabApi

public GitLabApi(GitLabApi.ApiVersion apiVersion,
                 String hostUrl,
                 Session session)

Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

session - the Session instance obtained by logining into the GitLab server

GitLabApi

public GitLabApi(String hostUrl,
                 Session session)

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

session - the Session instance obtained by logining into the GitLab server

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

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

authToken - the token to use for access to the API

secretToken - use this token to validate received payloads

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using the specified GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

secretToken - use this token to validate received payloads

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

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

authToken - the token to use for access to the API

secretToken - use this token to validate received payloads

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

secretToken - use this token to validate received payloads

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server specified by GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

secretToken - use this token to validate received payloads

clientConfigProperties - Map instance with additional properties for the Jersey client connection

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

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

authToken - the token to use for access to the API

secretToken - use this token to validate received payloads

clientConfigProperties - Map instance with additional properties for the Jersey client connection

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4.

Parameters:

hostUrl - the URL of the GitLab server

privateToken - to private token to use for access to the API

secretToken - use this token to validate received payloads

clientConfigProperties - Map instance with additional properties for the Jersey client connection

GitLabApi

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

Constructs a GitLabApi instance set up to interact with the GitLab server specified by GitLab API version.

Parameters:

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

hostUrl - the URL of the GitLab server

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

authToken - to token to use for access to the API

secretToken - use this token to validate received payloads

clientConfigProperties - Map instance with additional properties for the Jersey client connection

Method Detail

login

public static GitLabApi login(GitLabApi.ApiVersion apiVersion,
                              String url,
                              String username,
                              String password)
                       throws GitLabApiException

Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token and the specified GitLab API version.

Parameters:

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

url - GitLab URL

username - user name for which private token should be obtained

password - password for a given username

Returns:

new GitLabApi instance configured for a user-specific token

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

login

public static GitLabApi login(String url,
                              String username,
                              String password)
                       throws GitLabApiException

Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token using GitLab API version 4.

Parameters:

url - GitLab URL

username - user name for which private token should be obtained

password - password for a given username

Returns:

new GitLabApi instance configured for a user-specific token

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

create

@Deprecated
public static GitLabApi create(String url,
                                            String username,
                                            String password)
                                     throws GitLabApiException

Deprecated. As of release 4.2.0, replaced by login(String, String, String)

Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token and specified GitLab API version.

Parameters:

url - GitLab URL

username - user name for which private token should be obtained

password - password for a given username

Returns:

new GitLabApi instance configured for a user-specific token

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

getSession

public Session getSession()

If this instance was created with login(String, String, String) this method will return the Session instance returned by the GitLab API on login, otherwise returns null.

Returns:

the Session instance

sudo

public void sudo(String sudoAsUsername)
          throws GitLabApiException

Sets up all future calls to the GitLab API to be done as another user specified by sudoAsUsername. To revert back to normal non-sudo operation you must call unsudo(), or pass null as the username.

Parameters:

sudoAsUsername - the username to sudo as, null will turn off sudo

Throws:

GitLabApiException - if any exception occurs

unsudo

public void unsudo()

Turns off the currently configured sudo as ID.

setSudoAsId

public void setSudoAsId(Integer sudoAsId)
                 throws GitLabApiException

Sets up all future calls to the GitLab API to be done as another user specified by provided user ID. To revert back to normal non-sudo operation you must call unsudo(), or pass null as the sudoAsId.

Parameters:

sudoAsId - the ID of the user to sudo as, null will turn off sudo

Throws:

GitLabApiException - if any exception occurs

getSudoAsId

public Integer getSudoAsId()

Get the current sudo as ID, will return null if not in sudo mode.

Returns:

the current sudo as ID, will return null if not in sudo mode

getApiVersion

public GitLabApi.ApiVersion getApiVersion()

Return the GitLab API version that this instance is using.

Returns:

the GitLab API version that this instance is using

getDefaultPerPage

public int getDefaultPerPage()

Get the default number per page for calls that return multiple items.

Returns:

the default number per page for calls that return multiple item

setDefaultPerPage

public void setDefaultPerPage(int defaultPerPage)

Set the default number per page for calls that return multiple items.

Parameters:

defaultPerPage - the new default number per page for calls that return multiple item

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

getVersion

public Version getVersion()
                   throws GitLabApiException

Get the version info for the GitLab server using the GitLab Version API.

Returns:

the version info for the GitLab server

Throws:

GitLabApiException - if any exception occurs

getCommitsApi

public CommitsApi getCommitsApi()

Gets the CommitsApi instance owned by this GitLabApi instance. The CommitsApi is used to perform all commit related API calls.

Returns:

the CommitsApi instance owned by this GitLabApi instance

getDeployKeysApi

public DeployKeysApi getDeployKeysApi()

Gets the DeployKeysApi instance owned by this GitLabApi instance. The DeployKeysApi is used to perform all deploy key related API calls.

Returns:

the CommitsApi instance owned by this GitLabApi instance

getEventsApi

public EventsApi getEventsApi()

Gets the EventsApi instance owned by this GitLabApi instance. The EventsApi is used to perform all events related API calls.

Returns:

the EventsApi instance owned by this GitLabApi instance

getGroupApi

public GroupApi getGroupApi()

Gets the GroupApi instance owned by this GitLabApi instance. The GroupApi is used to perform all group related API calls.

Returns:

the GroupApi instance owned by this GitLabApi instance

getIssuesApi

public IssuesApi getIssuesApi()

Gets the IssuesApi instance owned by this GitLabApi instance. The IssuesApi is used to perform all iossue related API calls.

Returns:

the CommitsApi instance owned by this GitLabApi instance

getJobApi

public JobApi getJobApi()

Gets the JobApi instance owned by this GitLabApi instance. The JobApi is used to perform all jobs related API calls.

Returns:

the JobsApi instance owned by this GitLabApi instance

getMergeRequestApi

public MergeRequestApi getMergeRequestApi()

Gets the MergeRequestApi instance owned by this GitLabApi instance. The MergeRequestApi is used to perform all merge request related API calls.

Returns:

the MergeRequestApi instance owned by this GitLabApi instance

getNamespaceApi

public NamespaceApi getNamespaceApi()

Gets the NamespaceApi instance owned by this GitLabApi instance. The NamespaceApi is used to perform all namespace related API calls.

Returns:

the NamespaceApi instance owned by this GitLabApi instance

setNamespaceApi

public void setNamespaceApi(NamespaceApi namespaceApi)

getNotesApi

public NotesApi getNotesApi()

Gets the NotesApi instance owned by this GitLabApi instance. The NotesApi is used to perform all notes related API calls.

Returns:

the NotesApi instance owned by this GitLabApi instance

getPipelineApi

public PipelineApi getPipelineApi()

Gets the PipelineApi instance owned by this GitLabApi instance. The PipelineApi is used to perform all pipeline related API calls.

Returns:

the PipelineApi instance owned by this GitLabApi instance

getProjectApi

public ProjectApi getProjectApi()

Gets the ProjectApi instance owned by this GitLabApi instance. The ProjectApi is used to perform all project related API calls.

Returns:

the ProjectApi instance owned by this GitLabApi instance

getRepositoryApi

public RepositoryApi getRepositoryApi()

Gets the RepositoryApi instance owned by this GitLabApi instance. The RepositoryApi is used to perform all repository related API calls.

Returns:

the RepositoryApi instance owned by this GitLabApi instance

getRepositoryFileApi

public RepositoryFileApi getRepositoryFileApi()

Gets the RepositoryFileApi instance owned by this GitLabApi instance. The RepositoryFileApi is used to perform all repository files related API calls.

Returns:

the RepositoryFileApi instance owned by this GitLabApi instance

getServicesApi

public ServicesApi getServicesApi()

Gets the ServicesApi instance owned by this GitLabApi instance. The ServicesApi is used to perform all services related API calls.

Returns:

the ServicesApi instance owned by this GitLabApi instance

getSessionApi

public SessionApi getSessionApi()

Gets the SessionApi instance owned by this GitLabApi instance. The SessionApi is used to perform a login to the GitLab API.

Returns:

the SessionApi instance owned by this GitLabApi instance

getUserApi

public UserApi getUserApi()

Gets the UserApi instance owned by this GitLabApi instance. The UserApi is used to perform all user related API calls.

Returns:

the UserApi instance owned by this GitLabApi instance