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.

Constructor Summary

Constructors

Constructor and Description
GitLabApi(String hostUrl, Session session) Constructs a GitLabApi instance set up to interact with the GitLab server specified by hostUrl.
GitLabApi(String hostUrl, String privateToken) Constructs a GitLabApi instance set up to interact with the GitLab server specified by hostUrl.
GitLabApi(String hostUrl, String privateToken, String secretToken) Constructs a GitLabApi instance set up to interact with the GitLab server specified by hostUrl.
GitLabApi(String hostUrl, String privateToken, String secretToken, Map<String,Object> clientConfigProperties)

Method Summary

Modifier and Type	Method and Description
static GitLabApi	create(String url, String username, String password) Logs into GitLab using provided username and password, and creates a new GitLabApi instance using returned private token
CommitsApi	getCommitsApi() Gets the CommitsApi instance owned by this GitLabApi instance.
GroupApi	getGroupApi() Gets the GroupApi 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.
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 create(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.
UserApi	getUserApi() Gets the UserApi instance owned by this GitLabApi instance.
void	setNamespaceApi(NamespaceApi namespaceApi)

Methods inherited from class java.lang.Object

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

Constructor Detail

GitLabApi

public GitLabApi(String hostUrl,
                 String privateToken)

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

Parameters:

hostUrl - the URL of the GitLab server

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

GitLabApi

public GitLabApi(String hostUrl,
                 Session session)

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

Parameters:

hostUrl - the URL of the GitLab server

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

GitLabApi

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

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

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(String hostUrl,
                 String privateToken,
                 String secretToken,
                 Map<String,Object> clientConfigProperties)

Method Detail

create

public static GitLabApi create(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

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 create(String, String, String) this method will return the Session instance returned by the GitLab API on login, otherwise returns null.

Returns:

the Session instance

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

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)

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

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