org.gitlab.api

Class GitlabAPI

java.lang.Object

org.gitlab.api.GitlabAPI

public class GitlabAPI
extends Object

Gitlab API Wrapper class

Author:

@timols

Field Summary

Fields

Modifier and Type	Field and Description
static org.codehaus.jackson.map.ObjectMapper	MAPPER

Method Summary

Methods

Modifier and Type	Method and Description
GitlabProjectHook	addProjectHook(GitlabProject project, String url)
static GitlabAPI	connect(String hostUrl, String apiToken)
static GitlabSession	connect(String hostUrl, String username, String password)
GitlabGroup	createGroup(String name) Creates a Group
GitlabGroup	createGroup(String name, String path) Creates a Group
GitlabGroup	createGroup(String name, String path, String ldapCn, GitlabAccessLevel ldapAccess) Creates a Group
GitlabIssue	createIssue(int projectId, int assigneeId, int milestoneId, String labels, String description, String title)
GitlabNote	createNote(GitlabIssue issue, String message)
GitlabNote	createNote(GitlabMergeRequest mergeRequest, String body)
GitlabNote	createNote(Integer projectId, Integer issueId, String message)
GitlabProject	createProject(String name) Creates a private Project
GitlabProject	createProject(String name, Integer namespaceId, String description, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel, String importUrl) Creates a Project
GitlabProject	createUserProject(Integer userId, String name) Creates a Project for a specific User
GitlabProject	createUserProject(Integer userId, String name, String description, String defaultBranch, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel) Creates a Project for a specific User
void	deleteProjectHook(GitlabProject project, String hookId)
GitlabHTTPRequestor	dispatch()
GitlabIssue	editIssue(int projectId, int issueId, int assigneeId, int milestoneId, String labels, String description, String title, GitlabIssue.Action action)
GitlabProjectHook	editProjectHook(GitlabProject project, String hookId, String url)
List<GitlabMergeRequest>	getAllMergeRequests(GitlabProject project)
List<GitlabNote>	getAllNotes(GitlabMergeRequest mergeRequest)
List<GitlabProject>	getAllProjects()
URL	getAPIUrl(String tailAPIUrl)
GitlabBranch	getBranch(GitlabProject project, String branchName)
List<GitlabBranch>	getBranches(GitlabProject project)
List<GitlabCommit>	getCommits(GitlabMergeRequest mergeRequest)
GitlabSession	getCurrentSession()
GitlabGroup	getGroup(Integer groupId)
List<GitlabGroupMember>	getGroupMembers(GitlabGroup group) Gets all members of a Group
List<GitlabGroupMember>	getGroupMembers(Integer groupId) Gets all members of a Group
List<GitlabGroup>	getGroups()
GitlabIssue	getIssue(Integer projectId, Integer issueId)
List<GitlabIssue>	getIssues(GitlabProject project)
GitlabMergeRequest	getMergeRequest(GitlabProject project, Integer mergeRequestId)
List<GitlabMergeRequest>	getMergeRequests(GitlabProject project)
List<GitlabMergeRequest>	getMergeRequests(Integer projectId)
List<GitlabMilestone>	getMilestones(GitlabProject project)
List<GitlabMilestone>	getMilestones(Integer projectId)
List<GitlabProjectMember>	getNamespaceMembers(GitlabNamespace namespace) This will fail, if the given namespace is a user and not a group
List<GitlabProjectMember>	getNamespaceMembers(Integer namespaceId) This will fail, if the given namespace is a user and not a group
List<GitlabNote>	getNotes(GitlabIssue issue)
List<GitlabNote>	getNotes(GitlabMergeRequest mergeRequest)
List<GitlabMergeRequest>	getOpenMergeRequests(GitlabProject project)
GitlabProject	getProject(Integer projectId)
GitlabProjectHook	getProjectHook(GitlabProject project, String hookId)
List<GitlabProjectHook>	getProjectHooks(GitlabProject project)
List<GitlabProjectMember>	getProjectMembers(GitlabProject project)
List<GitlabProjectMember>	getProjectMembers(Integer projectId)
List<GitlabProject>	getProjects()
URL	getUrl(String tailAPIUrl)
GitlabAPI	ignoreCertificateErrors(boolean ignoreCertificateErrors)
boolean	isIgnoreCertificateErrors()
void	protectBranch(GitlabProject project, String branchName)
GitlabHTTPRequestor	retrieve()
void	unprotectBranch(GitlabProject project, String branchName)

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

public static final org.codehaus.jackson.map.ObjectMapper MAPPER

Method Detail

connect

public static GitlabSession connect(String hostUrl,
                    String username,
                    String password)
                             throws IOException

Throws:

IOException

connect

public static GitlabAPI connect(String hostUrl,
                String apiToken)

ignoreCertificateErrors

public GitlabAPI ignoreCertificateErrors(boolean ignoreCertificateErrors)

retrieve

public GitlabHTTPRequestor retrieve()

dispatch

public GitlabHTTPRequestor dispatch()

isIgnoreCertificateErrors

public boolean isIgnoreCertificateErrors()

getAPIUrl

public URL getAPIUrl(String tailAPIUrl)
              throws IOException

Throws:

IOException

getUrl

public URL getUrl(String tailAPIUrl)
           throws IOException

Throws:

IOException

getGroup

public GitlabGroup getGroup(Integer groupId)
                     throws IOException

Throws:

IOException

getGroups

public List<GitlabGroup> getGroups()
                            throws IOException

Throws:

IOException

getGroupMembers

public List<GitlabGroupMember> getGroupMembers(GitlabGroup group)
                                        throws IOException

Gets all members of a Group

Parameters:

group - The GitLab Group

Returns:

The Group Members

Throws:

IOException

getGroupMembers

public List<GitlabGroupMember> getGroupMembers(Integer groupId)
                                        throws IOException

Gets all members of a Group

Parameters:

groupId - The id of the GitLab Group

Returns:

The Group Members

Throws:

IOException

createGroup

public GitlabGroup createGroup(String name)
                        throws IOException

Creates a Group

Parameters:

name - The name of the group. The name will also be used as the path of the group.

Returns:

The GitLab Group

Throws:

IOException

createGroup

public GitlabGroup createGroup(String name,
                      String path)
                        throws IOException

Creates a Group

Parameters:

name - The name of the group

path - The path for the group

Returns:

The GitLab Group

Throws:

IOException

createGroup

public GitlabGroup createGroup(String name,
                      String path,
                      String ldapCn,
                      GitlabAccessLevel ldapAccess)
                        throws IOException

Creates a Group

Parameters:

name - The name of the group

path - The path for the group

ldapCn - LDAP Group Name to sync with, null otherwise

ldapAccess - Access level for LDAP group members, null otherwise

Returns:

The GitLab Group

Throws:

IOException

getProject

public GitlabProject getProject(Integer projectId)
                         throws IOException

Throws:

IOException

getProjects

public List<GitlabProject> getProjects()
                                throws IOException

Throws:

IOException

getAllProjects

public List<GitlabProject> getAllProjects()
                                   throws IOException

Throws:

IOException

createProject

public GitlabProject createProject(String name)
                            throws IOException

Creates a private Project

Parameters:

name - The name of the project

Returns:

The GitLab Project

Throws:

IOException

createProject

public GitlabProject createProject(String name,
                          Integer namespaceId,
                          String description,
                          Boolean issuesEnabled,
                          Boolean wallEnabled,
                          Boolean mergeRequestsEnabled,
                          Boolean wikiEnabled,
                          Boolean snippetsEnabled,
                          Boolean publik,
                          Integer visibilityLevel,
                          String importUrl)
                            throws IOException

Creates a Project

Parameters:

name - The name of the project

namespaceId - The Namespace for the new project, otherwise null indicates to use the GitLab default (user)

description - A description for the project, null otherwise

issuesEnabled - Whether Issues should be enabled, otherwise null indicates to use GitLab default

wallEnabled - Whether The Wall should be enabled, otherwise null indicates to use GitLab default

mergeRequestsEnabled - Whether Merge Requests should be enabled, otherwise null indicates to use GitLab default

wikiEnabled - Whether a Wiki should be enabled, otherwise null indicates to use GitLab default

snippetsEnabled - Whether Snippets should be enabled, otherwise null indicates to use GitLab default

publik - Whether the project is public or private, if true same as setting visibilityLevel = 20, otherwise null indicates to use GitLab default

visibilityLevel - The visibility level of the project, otherwise null indicates to use GitLab default

importUrl - The Import URL for the project, otherwise null

Returns:

the Gitlab Project

Throws:

IOException

createUserProject

public GitlabProject createUserProject(Integer userId,
                              String name)
                                throws IOException

Creates a Project for a specific User

Parameters:

userId - The id of the user to create the project for

name - The name of the project

Returns:

The GitLab Project

Throws:

IOException

createUserProject

public GitlabProject createUserProject(Integer userId,
                              String name,
                              String description,
                              String defaultBranch,
                              Boolean issuesEnabled,
                              Boolean wallEnabled,
                              Boolean mergeRequestsEnabled,
                              Boolean wikiEnabled,
                              Boolean snippetsEnabled,
                              Boolean publik,
                              Integer visibilityLevel)
                                throws IOException

Creates a Project for a specific User

Parameters:

userId - The id of the user to create the project for

name - The name of the project

description - A description for the project, null otherwise

defaultBranch - The default branch for the project, otherwise null indicates to use GitLab default (master)

issuesEnabled - Whether Issues should be enabled, otherwise null indicates to use GitLab default

wallEnabled - Whether The Wall should be enabled, otherwise null indicates to use GitLab default

mergeRequestsEnabled - Whether Merge Requests should be enabled, otherwise null indicates to use GitLab default

wikiEnabled - Whether a Wiki should be enabled, otherwise null indicates to use GitLab default

snippetsEnabled - Whether Snippets should be enabled, otherwise null indicates to use GitLab default

publik - Whether the project is public or private, if true same as setting visibilityLevel = 20, otherwise null indicates to use GitLab default

visibilityLevel - The visibility level of the project, otherwise null indicates to use GitLab default

Returns:

The GitLab Project

Throws:

IOException

getOpenMergeRequests

public List<GitlabMergeRequest> getOpenMergeRequests(GitlabProject project)
                                              throws IOException

Throws:

IOException

getMergeRequests

public List<GitlabMergeRequest> getMergeRequests(Integer projectId)
                                          throws IOException

Throws:

IOException

getMergeRequests

public List<GitlabMergeRequest> getMergeRequests(GitlabProject project)
                                          throws IOException

Throws:

IOException

getAllMergeRequests

public List<GitlabMergeRequest> getAllMergeRequests(GitlabProject project)
                                             throws IOException

Throws:

IOException

getMergeRequest

public GitlabMergeRequest getMergeRequest(GitlabProject project,
                                 Integer mergeRequestId)
                                   throws IOException

Throws:

IOException

getNotes

public List<GitlabNote> getNotes(GitlabMergeRequest mergeRequest)
                          throws IOException

Throws:

IOException

getAllNotes

public List<GitlabNote> getAllNotes(GitlabMergeRequest mergeRequest)
                             throws IOException

Throws:

IOException

getCommits

public List<GitlabCommit> getCommits(GitlabMergeRequest mergeRequest)
                              throws IOException

Throws:

IOException

createNote

public GitlabNote createNote(GitlabMergeRequest mergeRequest,
                    String body)
                      throws IOException

Throws:

IOException

getBranches

public List<GitlabBranch> getBranches(GitlabProject project)
                               throws IOException

Throws:

IOException

getBranch

public GitlabBranch getBranch(GitlabProject project,
                     String branchName)
                       throws IOException

Throws:

IOException

protectBranch

public void protectBranch(GitlabProject project,
                 String branchName)
                   throws IOException

Throws:

IOException

unprotectBranch

public void unprotectBranch(GitlabProject project,
                   String branchName)
                     throws IOException

Throws:

IOException

getProjectHooks

public List<GitlabProjectHook> getProjectHooks(GitlabProject project)
                                        throws IOException

Throws:

IOException

getProjectHook

public GitlabProjectHook getProjectHook(GitlabProject project,
                               String hookId)
                                 throws IOException

Throws:

IOException

addProjectHook

public GitlabProjectHook addProjectHook(GitlabProject project,
                               String url)
                                 throws IOException

Throws:

IOException

editProjectHook

public GitlabProjectHook editProjectHook(GitlabProject project,
                                String hookId,
                                String url)
                                  throws IOException

Throws:

IOException

deleteProjectHook

public void deleteProjectHook(GitlabProject project,
                     String hookId)
                       throws IOException

Throws:

IOException

getIssues

public List<GitlabIssue> getIssues(GitlabProject project)
                            throws IOException

Throws:

IOException

getIssue

public GitlabIssue getIssue(Integer projectId,
                   Integer issueId)
                     throws IOException

Throws:

IOException

createIssue

public GitlabIssue createIssue(int projectId,
                      int assigneeId,
                      int milestoneId,
                      String labels,
                      String description,
                      String title)
                        throws IOException

Throws:

IOException

editIssue

public GitlabIssue editIssue(int projectId,
                    int issueId,
                    int assigneeId,
                    int milestoneId,
                    String labels,
                    String description,
                    String title,
                    GitlabIssue.Action action)
                      throws IOException

Throws:

IOException

getNotes

public List<GitlabNote> getNotes(GitlabIssue issue)
                          throws IOException

Throws:

IOException

createNote

public GitlabNote createNote(Integer projectId,
                    Integer issueId,
                    String message)
                      throws IOException

Throws:

IOException

createNote

public GitlabNote createNote(GitlabIssue issue,
                    String message)
                      throws IOException

Throws:

IOException

getMilestones

public List<GitlabMilestone> getMilestones(GitlabProject project)
                                    throws IOException

Throws:

IOException

getMilestones

public List<GitlabMilestone> getMilestones(Integer projectId)
                                    throws IOException

Throws:

IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(GitlabProject project)
                                            throws IOException

Throws:

IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(Integer projectId)
                                            throws IOException

Throws:

IOException

getNamespaceMembers

public List<GitlabProjectMember> getNamespaceMembers(GitlabNamespace namespace)
                                              throws IOException

This will fail, if the given namespace is a user and not a group

Parameters:

namespace -

Returns:

Throws:

IOException

getNamespaceMembers

public List<GitlabProjectMember> getNamespaceMembers(Integer namespaceId)
                                              throws IOException

This will fail, if the given namespace is a user and not a group

Parameters:

namespaceId -

Returns:

Throws:

IOException

getCurrentSession

public GitlabSession getCurrentSession()
                                throws IOException

Throws:

IOException