org.gitlab.api

Class GitlabAPI

java.lang.Object

org.gitlab.api.GitlabAPI

public class GitlabAPI
extends Object

Gitlab API Wrapper class

Author:

@timols (Tim O)

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Method Summary

Methods

Modifier and Type	Method and Description
GitlabMergeRequest	acceptMergeRequest(GitlabProject project, Integer mergeRequestId, String mergeCommitMessage)
GitlabGroupMember	addGroupMember(GitlabGroup group, GitlabUser user, GitlabAccessLevel accessLevel) Add a group member.
GitlabGroupMember	addGroupMember(Integer groupId, Integer userId, GitlabAccessLevel accessLevel) Add a group member.
GitlabProjectHook	addProjectHook(GitlabProject project, String url)
GitlabProjectHook	addProjectHook(Serializable projectId, String url, boolean pushEvents, boolean issuesEvents, boolean mergeRequestEvents, boolean sslVerification)
GitlabProjectMember	addProjectMember(GitlabProject project, GitlabUser user, GitlabAccessLevel accessLevel) Add a project member.
GitlabProjectMember	addProjectMember(Integer projectId, Integer userId, GitlabAccessLevel accessLevel) Add a project member.
GitlabSystemHook	addSystemHook(String url) Add new system hook hook
void	blockUser(Integer targetUserId) Block a user
static GitlabAPI	connect(String hostUrl, String apiToken)
static GitlabSession	connect(String hostUrl, String username, String password)
static GitlabAPI	connect(String hostUrl, String apiToken, TokenType tokenType)
GitlabCommitStatus	createCommitStatus(GitlabProject project, String commitHash, String state, String ref, String name, String targetUrl, String description)
GitlabSSHKey	createDeployKey(Integer targetProjectId, String title, String key) Create a new deploy key for the project
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(Serializable 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
GitlabSSHKey	createSSHKey(Integer targetUserId, String title, String key) Create a new ssh key for the user
GitlabUser	createUser(String email, String password, String username, String fullName, String skypeId, String linkedIn, String twitter, String website_url, Integer projects_limit, String extern_uid, String extern_provider_name, String bio, Boolean isAdmin, Boolean can_create_group, Boolean skip_confirmation) Create a new User
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	deleteBranch(Serializable projectId, String branchName) Delete Branch.
void	deleteDeployKey(Integer targetProjectId, Integer targetKeyId) Delete a deploy key for a project
void	deleteGroup(Integer groupId) Delete a group.
void	deleteGroupMember(GitlabGroup group, GitlabUser user) Delete a group member.
void	deleteGroupMember(Integer groupId, Integer userId) Delete a group member.
void	deleteProject(Serializable projectId) Delete a Project.
void	deleteProjectHook(GitlabProjectHook hook)
void	deleteProjectHook(GitlabProject project, String hookId)
void	deleteProjectMember(GitlabProject project, GitlabUser user) Delete a project team member.
void	deleteProjectMember(Integer projectId, Integer userId) Delete a project team member.
void	deleteSSHKey(Integer targetUserId, Integer targetKeyId) Delete user's ssh key
GitlabSystemHook	deleteSystemHook(Integer hookId) Delete system hook
void	deleteUser(Integer targetUserId) Delete a user
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<GitlabUser>	findUsers(String emailOrUsername)
List<GitlabCommit>	getAllCommits(Serializable projectId)
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<GitlabBranch>	getBranches(Serializable projectId)
GitlabCommit	getCommit(Serializable projectId, String commitHash)
List<GitlabCommitDiff>	getCommitDiffs(Serializable projectId, String commitHash)
List<GitlabCommit>	getCommits(GitlabMergeRequest mergeRequest)
List<GitlabCommitStatus>	getCommitStatuses(GitlabProject project, String commitHash)
GitlabSession	getCurrentSession()
List<GitlabSSHKey>	getDeployKeys(Integer targetProjectId) Gets all deploy keys for a project
byte[]	getFileArchive(GitlabProject project) Get an archive of the repository
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(Serializable projectId, Integer issueId)
List<GitlabIssue>	getIssues(GitlabProject project)
GitlabMergeRequest	getMergeRequest(GitlabProject project, Integer mergeRequestId)
GitlabMergeRequest	getMergeRequestByIid(Serializable projectId, Integer mergeRequestIid) Return Merge Request.
GitlabMergeRequest	getMergeRequestChanges(Serializable projectId, Integer mergeRequestId) Return a Merge Request including its changes.
List<GitlabMergeRequest>	getMergeRequests(GitlabProject project)
List<GitlabMergeRequest>	getMergeRequests(Serializable projectId)
List<GitlabMilestone>	getMilestones(GitlabProject project)
List<GitlabMilestone>	getMilestones(Serializable 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
GitlabNote	getNote(GitlabMergeRequest mergeRequest, Integer noteId) Get a Note from a Merge Request.
List<GitlabNote>	getNotes(GitlabIssue issue)
List<GitlabNote>	getNotes(GitlabMergeRequest mergeRequest)
List<GitlabMergeRequest>	getOpenMergeRequests(GitlabProject project)
List<GitlabMergeRequest>	getOpenMergeRequests(Serializable projectId)
GitlabProject	getProject(Serializable projectId)
GitlabProjectHook	getProjectHook(GitlabProject project, String hookId)
List<GitlabProjectHook>	getProjectHooks(GitlabProject project)
List<GitlabProjectHook>	getProjectHooks(Serializable projectId)
List<GitlabProjectMember>	getProjectMembers(GitlabProject project)
List<GitlabProjectMember>	getProjectMembers(Serializable projectId)
List<GitlabProject>	getProjects()
byte[]	getRawBlobContent(GitlabProject project, String sha) Get the raw file contents for a blob by blob SHA.
byte[]	getRawFileContent(GitlabProject project, String sha, String filepath) Get raw file content
List<GitlabRepositoryTree>	getRepositoryTree(GitlabProject project, String path, String ref_name) Get an archive of the repository
GitlabSSHKey	getSSHKey(Integer keyId) Get key with user information by ID of an SSH key.
List<GitlabSSHKey>	getSSHKeys(Integer targetUserId) Gets all ssh keys for a user
List<GitlabSystemHook>	getSystemHooks() Get list of system hooks
URL	getUrl(String tailAPIUrl)
GitlabUser	getUser() Return API User
GitlabUser	getUser(Integer userId)
List<GitlabUser>	getUsers()
GitlabUser	getUserViaSudo(String username)
GitlabAPI	ignoreCertificateErrors(boolean ignoreCertificateErrors)
boolean	isIgnoreCertificateErrors()
void	protectBranch(GitlabProject project, String branchName)
GitlabHTTPRequestor	retrieve()
void	testSystemHook(Integer hookId) Test system hook
void	transfer(Integer namespaceId, Integer projectId) Transfer a project to the given namespace
void	unblockUser(Integer targetUserId) Unblock a user
void	unprotectBranch(GitlabProject project, String branchName)
GitlabMergeRequest	updateMergeRequest(Serializable projectId, Integer mergeRequestId, String targetBranch, Integer assigneeId, String title, String description, String stateEvent, String labels) Updates a Merge Request
GitlabNote	updateNote(GitlabMergeRequest mergeRequest, Integer noteId, String body) Update a Merge Request Note
GitlabProject	updateProject(Integer projectId, String name, String description, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel) Updates a Project
GitlabUser	updateUser(Integer targetUserId, String email, String password, String username, String fullName, String skypeId, String linkedIn, String twitter, String website_url, Integer projects_limit, String extern_uid, String extern_provider_name, String bio, Boolean isAdmin, Boolean can_create_group) Update a user

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

public static final com.fasterxml.jackson.databind.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)

connect

public static GitlabAPI connect(String hostUrl,
                String apiToken,
                TokenType tokenType)

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

getUsers

public List<GitlabUser> getUsers()
                          throws IOException

Throws:

IOException

findUsers

public List<GitlabUser> findUsers(String emailOrUsername)
                           throws IOException

Throws:

IOException

getUser

public GitlabUser getUser()
                   throws IOException

Return API User

Throws:

IOException

getUser

public GitlabUser getUser(Integer userId)
                   throws IOException

Throws:

IOException

getUserViaSudo

public GitlabUser getUserViaSudo(String username)
                          throws IOException

Throws:

IOException

createUser

public GitlabUser createUser(String email,
                    String password,
                    String username,
                    String fullName,
                    String skypeId,
                    String linkedIn,
                    String twitter,
                    String website_url,
                    Integer projects_limit,
                    String extern_uid,
                    String extern_provider_name,
                    String bio,
                    Boolean isAdmin,
                    Boolean can_create_group,
                    Boolean skip_confirmation)
                      throws IOException

Create a new User

Parameters:

email - User email

password - Password

username - User name

fullName - Full name

skypeId - Skype Id

linkedIn - LinkedIn

twitter - Twitter

website_url - Website URL

projects_limit - Projects limit

extern_uid - External User ID

extern_provider_name - External Provider Name

bio - Bio

isAdmin - Is Admin

can_create_group - Can Create Group

skip_confirmation - Skip Confirmation

Returns:

A GitlabUser

Throws:

IOException - on gitlab api call error

See Also:

http://doc.gitlab.com/ce/api/users.html

updateUser

public GitlabUser updateUser(Integer targetUserId,
                    String email,
                    String password,
                    String username,
                    String fullName,
                    String skypeId,
                    String linkedIn,
                    String twitter,
                    String website_url,
                    Integer projects_limit,
                    String extern_uid,
                    String extern_provider_name,
                    String bio,
                    Boolean isAdmin,
                    Boolean can_create_group)
                      throws IOException

Update a user

Parameters:

targetUserId - User ID

email - User email

password - Password

username - User name

fullName - Full name

skypeId - Skype Id

linkedIn - LinkedIn

twitter - Twitter

website_url - Website URL

projects_limit - Projects limit

extern_uid - External User ID

extern_provider_name - External Provider Name

bio - Bio

isAdmin - Is Admin

can_create_group - Can Create Group

Returns:

The Updated User

Throws:

IOException - on gitlab api call error

blockUser

public void blockUser(Integer targetUserId)
               throws IOException

Block a user

Parameters:

targetUserId - The id of the Gitlab user

Throws:

IOException - on gitlab api call error

unblockUser

public void unblockUser(Integer targetUserId)
                 throws IOException

Unblock a user

Parameters:

targetUserId - The id of the Gitlab user

Throws:

IOException - on gitlab api call error

createSSHKey

public GitlabSSHKey createSSHKey(Integer targetUserId,
                        String title,
                        String key)
                          throws IOException

Create a new ssh key for the user

Parameters:

targetUserId - The id of the Gitlab user

title - The title of the ssh key

key - The public key

Returns:

The new GitlabSSHKey

Throws:

IOException - on gitlab api call error

deleteSSHKey

public void deleteSSHKey(Integer targetUserId,
                Integer targetKeyId)
                  throws IOException

Delete user's ssh key

Parameters:

targetUserId - The id of the Gitlab user

targetKeyId - The id of the Gitlab ssh key

Throws:

IOException - on gitlab api call error

getSSHKeys

public List<GitlabSSHKey> getSSHKeys(Integer targetUserId)
                              throws IOException

Gets all ssh keys for a user

Parameters:

targetUserId - The id of the GitLab User

Returns:

The list of user ssh keys

Throws:

IOException - on gitlab api call error

getSSHKey

public GitlabSSHKey getSSHKey(Integer keyId)
                       throws IOException

Get key with user information by ID of an SSH key.

Parameters:

keyId - The ID of an SSH key

Returns:

The SSH key with user information

Throws:

IOException - on gitlab api call error

deleteUser

public void deleteUser(Integer targetUserId)
                throws IOException

Delete a user

Parameters:

targetUserId - The target User ID

Throws:

IOException - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

addGroupMember

public GitlabGroupMember addGroupMember(GitlabGroup group,
                               GitlabUser user,
                               GitlabAccessLevel accessLevel)
                                 throws IOException

Add a group member.

Parameters:

group - the GitlabGroup

user - the GitlabUser

accessLevel - the GitlabAccessLevel

Returns:

the GitlabGroupMember

Throws:

IOException - on gitlab api call error

addGroupMember

public GitlabGroupMember addGroupMember(Integer groupId,
                               Integer userId,
                               GitlabAccessLevel accessLevel)
                                 throws IOException

Add a group member.

Parameters:

groupId - the group id

userId - the user id

accessLevel - the GitlabAccessLevel

Returns:

the GitlabGroupMember

Throws:

IOException - on gitlab api call error

deleteGroupMember

public void deleteGroupMember(GitlabGroup group,
                     GitlabUser user)
                       throws IOException

Delete a group member.

Parameters:

group - the GitlabGroup

user - the GitlabUser

Throws:

IOException - on gitlab api call error

deleteGroupMember

public void deleteGroupMember(Integer groupId,
                     Integer userId)
                       throws IOException

Delete a group member.

Parameters:

groupId - the group id

userId - the user id

Throws:

IOException - on gitlab api call error

deleteGroup

public void deleteGroup(Integer groupId)
                 throws IOException

Delete a group.

Parameters:

groupId - the group id

Throws:

IOException - on gitlab api call error

getProject

public GitlabProject getProject(Serializable 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 - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

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 - on gitlab api call error

updateProject

public GitlabProject updateProject(Integer projectId,
                          String name,
                          String description,
                          Boolean issuesEnabled,
                          Boolean wallEnabled,
                          Boolean mergeRequestsEnabled,
                          Boolean wikiEnabled,
                          Boolean snippetsEnabled,
                          Boolean publik,
                          Integer visibilityLevel)
                            throws IOException

Updates a Project

Parameters:

projectId - The id of the project to update

name - The name of the project

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

Returns:

the Gitlab Project

Throws:

IOException - on gitlab api call error

deleteProject

public void deleteProject(Serializable projectId)
                   throws IOException

Delete a Project.

Parameters:

projectId - The id of the project to delete

Throws:

IOException - on gitlab api call error

getOpenMergeRequests

public List<GitlabMergeRequest> getOpenMergeRequests(Serializable projectId)
                                              throws IOException

Throws:

IOException

getOpenMergeRequests

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

Throws:

IOException

getMergeRequests

public List<GitlabMergeRequest> getMergeRequests(Serializable 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

getMergeRequestByIid

public GitlabMergeRequest getMergeRequestByIid(Serializable projectId,
                                      Integer mergeRequestIid)
                                        throws IOException

Return Merge Request.

Parameters:

projectId - The id of the project

mergeRequestIid - The iid of the merge request

Returns:

the Gitlab Merge Request

Throws:

IOException - on gitlab api call error

getMergeRequestChanges

public GitlabMergeRequest getMergeRequestChanges(Serializable projectId,
                                        Integer mergeRequestId)
                                          throws IOException

Return a Merge Request including its changes.

Parameters:

projectId - The id of the project

mergeRequestId - The id of the merge request

Returns:

the Gitlab Merge Request

Throws:

IOException - on gitlab api call error

getMergeRequest

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

Throws:

IOException

updateMergeRequest

public GitlabMergeRequest updateMergeRequest(Serializable projectId,
                                    Integer mergeRequestId,
                                    String targetBranch,
                                    Integer assigneeId,
                                    String title,
                                    String description,
                                    String stateEvent,
                                    String labels)
                                      throws IOException

Updates a Merge Request

Parameters:

projectId - The id of the project

mergeRequestId - The id of the merge request to update

targetBranch - The target branch of the merge request, otherwise null to leave it untouched

assigneeId - The id of the assignee, otherwise null to leave it untouched

title - The title of the merge request, otherwise null to leave it untouched

description - The description of the merge request, otherwise null to leave it untouched

stateEvent - The state (close|reopen|merge) of the merge request, otherwise null to leave it untouched

labels - A comma separated list of labels, otherwise null to leave it untouched

Returns:

the Merge Request

Throws:

IOException - on gitlab api call error

acceptMergeRequest

public GitlabMergeRequest acceptMergeRequest(GitlabProject project,
                                    Integer mergeRequestId,
                                    String mergeCommitMessage)
                                      throws IOException

Parameters:

project - The Project

mergeRequestId - Merge Request ID

mergeCommitMessage - optional merge commit message. Null if not set

Returns:

new merge request status

Throws:

IOException - on gitlab api call error

getNote

public GitlabNote getNote(GitlabMergeRequest mergeRequest,
                 Integer noteId)
                   throws IOException

Get a Note from a Merge Request.

Parameters:

mergeRequest - The merge request

noteId - The id of the note

Returns:

the Gitlab Note

Throws:

IOException - on gitlab api call error

getNotes

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

Throws:

IOException

getAllNotes

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

Throws:

IOException

getCommit

public GitlabCommit getCommit(Serializable projectId,
                     String commitHash)
                       throws IOException

Throws:

IOException

getCommits

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

Throws:

IOException

getAllCommits

public List<GitlabCommit> getAllCommits(Serializable projectId)
                                 throws IOException

Throws:

IOException

getCommitDiffs

public List<GitlabCommitDiff> getCommitDiffs(Serializable projectId,
                                    String commitHash)
                                      throws IOException

Throws:

IOException

getCommitStatuses

public List<GitlabCommitStatus> getCommitStatuses(GitlabProject project,
                                         String commitHash)
                                           throws IOException

Throws:

IOException

createCommitStatus

public GitlabCommitStatus createCommitStatus(GitlabProject project,
                                    String commitHash,
                                    String state,
                                    String ref,
                                    String name,
                                    String targetUrl,
                                    String description)
                                      throws IOException

Throws:

IOException

getRawFileContent

public byte[] getRawFileContent(GitlabProject project,
                       String sha,
                       String filepath)
                         throws IOException

Get raw file content

Parameters:

project - The Project

sha - The commit or branch name

filepath - The path of the file

Throws:

IOException - on gitlab api call error

getRawBlobContent

public byte[] getRawBlobContent(GitlabProject project,
                       String sha)
                         throws IOException

Get the raw file contents for a blob by blob SHA.

Parameters:

project - The Project

sha - The commit or branch name

Throws:

IOException - on gitlab api call error

getFileArchive

public byte[] getFileArchive(GitlabProject project)
                      throws IOException

Get an archive of the repository

Parameters:

project - The Project

Throws:

IOException - on gitlab api call error

getRepositoryTree

public List<GitlabRepositoryTree> getRepositoryTree(GitlabProject project,
                                           String path,
                                           String ref_name)
                                             throws IOException

Get an archive of the repository

Parameters:

project - The Project

path - The path inside the repository. Used to get content of subdirectories (optional)

ref_name - The name of a repository branch or tag or if not given the default branch (optional)

Throws:

IOException - on gitlab api call error

updateNote

public GitlabNote updateNote(GitlabMergeRequest mergeRequest,
                    Integer noteId,
                    String body)
                      throws IOException

Update a Merge Request Note

Parameters:

mergeRequest - The merge request

noteId - The id of the note

body - The content of the note

Returns:

the Gitlab Note

Throws:

IOException - on gitlab api call error

createNote

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

Throws:

IOException

getBranches

public List<GitlabBranch> getBranches(Serializable projectId)
                               throws IOException

Throws:

IOException

getBranches

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

Throws:

IOException

deleteBranch

public void deleteBranch(Serializable projectId,
                String branchName)
                  throws IOException

Delete Branch.

Parameters:

projectId - The id of the project

branchName - The name of the branch to delete

Throws:

IOException - on gitlab api call error

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(Serializable projectId)
                                        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

addProjectHook

public GitlabProjectHook addProjectHook(Serializable projectId,
                               String url,
                               boolean pushEvents,
                               boolean issuesEvents,
                               boolean mergeRequestEvents,
                               boolean sslVerification)
                                 throws IOException

Throws:

IOException

editProjectHook

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

Throws:

IOException

deleteProjectHook

public void deleteProjectHook(GitlabProjectHook hook)
                       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(Serializable 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(Serializable 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(Serializable projectId)
                                    throws IOException

Throws:

IOException

addProjectMember

public GitlabProjectMember addProjectMember(GitlabProject project,
                                   GitlabUser user,
                                   GitlabAccessLevel accessLevel)
                                     throws IOException

Add a project member.

Parameters:

project - the GitlabProject

user - the GitlabUser

accessLevel - the GitlabAccessLevel

Returns:

the GitlabProjectMember

Throws:

IOException - on gitlab api call error

addProjectMember

public GitlabProjectMember addProjectMember(Integer projectId,
                                   Integer userId,
                                   GitlabAccessLevel accessLevel)
                                     throws IOException

Add a project member.

Parameters:

projectId - the project id

userId - the user id

accessLevel - the GitlabAccessLevel

Returns:

the GitlabProjectMember

Throws:

IOException - on gitlab api call error

deleteProjectMember

public void deleteProjectMember(GitlabProject project,
                       GitlabUser user)
                         throws IOException

Delete a project team member.

Parameters:

project - the GitlabProject

user - the GitlabUser

Throws:

IOException - on gitlab api call error

deleteProjectMember

public void deleteProjectMember(Integer projectId,
                       Integer userId)
                         throws IOException

Delete a project team member.

Parameters:

projectId - the project id

userId - the user id

Throws:

IOException - on gitlab api call error

getProjectMembers

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

Throws:

IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(Serializable 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 - The namespace

Returns:

A list of Gitlab Project members

Throws:

IOException - on gitlab api call error

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 - Namespace ID

Returns:

A list of Gitlab Project members

Throws:

IOException - on gitlab api call error

transfer

public void transfer(Integer namespaceId,
            Integer projectId)
              throws IOException

Transfer a project to the given namespace

Parameters:

namespaceId - Namespace ID

projectId - Project ID

Throws:

IOException - on gitlab api call error

createDeployKey

public GitlabSSHKey createDeployKey(Integer targetProjectId,
                           String title,
                           String key)
                             throws IOException

Create a new deploy key for the project

Parameters:

targetProjectId - The id of the Gitlab project

title - The title of the ssh key

key - The public key

Returns:

The new GitlabSSHKey

Throws:

IOException - on gitlab api call error

deleteDeployKey

public void deleteDeployKey(Integer targetProjectId,
                   Integer targetKeyId)
                     throws IOException

Delete a deploy key for a project

Parameters:

targetProjectId - The id of the Gitlab project

targetKeyId - The id of the Gitlab ssh key

Throws:

IOException - on gitlab api call error

getDeployKeys

public List<GitlabSSHKey> getDeployKeys(Integer targetProjectId)
                                 throws IOException

Gets all deploy keys for a project

Parameters:

targetProjectId - The id of the Gitlab project

Returns:

The list of project deploy keys

Throws:

IOException - on gitlab api call error

getCurrentSession

public GitlabSession getCurrentSession()
                                throws IOException

Throws:

IOException

getSystemHooks

public List<GitlabSystemHook> getSystemHooks()
                                      throws IOException

Get list of system hooks

Returns:

The system hooks list

Throws:

IOException - on gitlab api call error

addSystemHook

public GitlabSystemHook addSystemHook(String url)
                               throws IOException

Add new system hook hook

Parameters:

url - System hook url

Throws:

IOException - on gitlab api call error

testSystemHook

public void testSystemHook(Integer hookId)
                    throws IOException

Test system hook

Throws:

IOException - on gitlab api call error

deleteSystemHook

public GitlabSystemHook deleteSystemHook(Integer hookId)
                                  throws IOException

Delete system hook

Throws:

IOException - on gitlab api call error