Package org.gitlab4j.api

Class RepositoryApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.RepositoryApi

All Implemented Interfaces:

Constants

public class RepositoryApi
extends AbstractApi

This class provides an entry point to all the GitLab API repository calls.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
RepositoryApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
CompareResults	compare(Integer projectId, String from, String to)	Compare branches, tags or commits.
CompareResults	compare(String projectPath, String from, String to)	Compare branches, tags or commits.
Branch	createBranch(Integer projectId, String branchName, String ref)	Creates a branch for the project.
Tag	createTag(Integer projectId, String tagName, String ref, String message, File releaseNotesFile)	Creates a tag on a particular ref of a given project.
Tag	createTag(Integer projectId, String tagName, String ref, String message, String releaseNotes)	Creates a tag on a particular ref of the given project.
void	deleteBranch(Integer projectId, String branchName)	Delete a single project repository branch.
void	deleteTag(Integer projectId, String tagName)	Deletes the tag from a project with the specified tag name.
Branch	getBranch(Integer projectId, String branchName)	Get a single project repository branch.
List<Branch>	getBranches(Integer projectId)	Get a list of repository branches from a project, sorted by name alphabetically.
Pager<Branch>	getBranches(Integer projectId, int itemsPerPage)	Get a Pager of repository branches from a project, sorted by name alphabetically.
List<Branch>	getBranches(Integer projectId, int page, int perPage)	Get a list of repository branches from a project, sorted by name alphabetically.
InputStream	getRawBlobContent(Integer projectId, String sha)	Get the raw file contents for a blob by blob SHA.
InputStream	getRepositoryArchive(Integer projectId, String sha)	Get an archive of the complete repository by SHA (optional).
File	getRepositoryArchive(Integer projectId, String sha, File directory)	Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
List<Tag>	getTags(Integer projectId)	Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
Pager<Tag>	getTags(Integer projectId, int itemsPerPage)	Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
List<Tag>	getTags(Integer projectId, int page, int perPage)	Get a list of repository tags from a project, sorted by name in reverse alphabetical order and in the specified page range.
List<TreeItem>	getTree(Integer projectId)	Get a list of repository files and directories in a project.
Pager<TreeItem>	getTree(Integer projectId, int itemsPerPage)	Get a Pager of repository files and directories in a project.
List<TreeItem>	getTree(Integer projectId, String filePath, String refName)	Get a list of repository files and directories in a project.
Pager<TreeItem>	getTree(Integer projectId, String filePath, String refName, int itemsPerPage)	Get a Pager of repository files and directories in a project.
List<TreeItem>	getTree(Integer projectId, String filePath, String refName, Boolean recursive)	Get a list of repository files and directories in a project.
Pager<TreeItem>	getTree(Integer projectId, String filePath, String refName, Boolean recursive, int itemsPerPage)	Get a Pager of repository files and directories in a project.
Branch	protectBranch(Integer projectId, String branchName)	Protects a single project repository branch.
Branch	unprotectBranch(Integer projectId, String branchName)	Unprotects a single project repository branch.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, post, post, post, put, put, putWithFormData, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryApi

public RepositoryApi(GitLabApi gitLabApi)

Method Detail

getBranches

public List<Branch> getBranches(Integer projectId)
                         throws GitLabApiException

Get a list of repository branches from a project, sorted by name alphabetically. GET /projects/:id/repository/branches

Parameters:

projectId - the project to get the list of branches for

Returns:

the list of repository branches for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getBranches

public List<Branch> getBranches(Integer projectId,
                                int page,
                                int perPage)
                         throws GitLabApiException

Get a list of repository branches from a project, sorted by name alphabetically. GET /projects/:id/repository/branches

Parameters:

projectId - the project to get the list of branches for

page - the page to get

perPage - the number of Branch instances per page

Returns:

the list of repository branches for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getBranches

public Pager<Branch> getBranches(Integer projectId,
                                 int itemsPerPage)
                          throws GitLabApiException

Get a Pager of repository branches from a project, sorted by name alphabetically. GET /projects/:id/repository/branches

Parameters:

projectId - the project to get the list of branches for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

the list of repository branches for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getBranch

public Branch getBranch(Integer projectId,
                        String branchName)
                 throws GitLabApiException

Get a single project repository branch. GET /projects/:id/repository/branches/:branch

Parameters:

projectId - the project to get the branch for

branchName - the name of the branch to get

Returns:

the branch info for the specified project ID/branch name pair

Throws:

GitLabApiException - if any exception occurs

createBranch

public Branch createBranch(Integer projectId,
                           String branchName,
                           String ref)
                    throws GitLabApiException

Creates a branch for the project. Support as of version 6.8.x POST /projects/:id/repository/branches

Parameters:

projectId - the project to create the branch for

branchName - the name of the branch to create

ref - Source to create the branch from, can be an existing branch, tag or commit SHA

Returns:

the branch info for the created branch

Throws:

GitLabApiException - if any exception occurs

deleteBranch

public void deleteBranch(Integer projectId,
                         String branchName)
                  throws GitLabApiException

Delete a single project repository branch. DELETE /projects/:id/repository/branches/:branch

Parameters:

projectId - the project that the branch belongs to

branchName - the name of the branch to delete

Throws:

GitLabApiException - if any exception occurs

protectBranch

public Branch protectBranch(Integer projectId,
                            String branchName)
                     throws GitLabApiException

Protects a single project repository branch. This is an idempotent function, protecting an already protected repository branch will not produce an error. PUT /projects/:id/repository/branches/:branch/protect

Parameters:

projectId - the ID of the project to protect

branchName - the name of the branch to protect

Returns:

the branch info for the protected branch

Throws:

GitLabApiException - if any exception occurs

unprotectBranch

public Branch unprotectBranch(Integer projectId,
                              String branchName)
                       throws GitLabApiException

Unprotects a single project repository branch. This is an idempotent function, unprotecting an already unprotected repository branch will not produce an error. PUT /projects/:id/repository/branches/:branch/unprotect

Parameters:

projectId - the ID of the project to un-protect

branchName - the name of the branch to un-protect

Returns:

the branch info for the unprotected branch

Throws:

GitLabApiException - if any exception occurs

getTags

public List<Tag> getTags(Integer projectId)
                  throws GitLabApiException

Get a list of repository tags from a project, sorted by name in reverse alphabetical order. GET /projects/:id/repository/tags

Parameters:

projectId - the ID of the project to get the tags for

Returns:

the list of tags for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getTags

public List<Tag> getTags(Integer projectId,
                         int page,
                         int perPage)
                  throws GitLabApiException

Get a list of repository tags from a project, sorted by name in reverse alphabetical order and in the specified page range. GET /projects/:id/repository/tags

Parameters:

projectId - the ID of the project to get the tags for

page - the page to get

perPage - the number of Tag instances per page

Returns:

the list of tags for the specified project ID

Throws:

GitLabApiException - if any exception occurs

getTags

public Pager<Tag> getTags(Integer projectId,
                          int itemsPerPage)
                   throws GitLabApiException

Get a list of repository tags from a project, sorted by name in reverse alphabetical order. GET /projects/:id/repository/tags

Parameters:

projectId - the ID of the project to get the tags for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

the list of tags for the specified project ID

Throws:

GitLabApiException - if any exception occurs

createTag

public Tag createTag(Integer projectId,
                     String tagName,
                     String ref,
                     String message,
                     String releaseNotes)
              throws GitLabApiException

Creates a tag on a particular ref of the given project. A message and release notes are optional. POST /projects/:id/repository/tags

Parameters:

projectId - the ID of the project

tagName - The name of the tag Must be unique for the project

ref - the git ref to place the tag on

message - the message to included with the tag (optional)

releaseNotes - the release notes for the tag (optional)

Returns:

a Tag instance containing info on the newly created tag

Throws:

GitLabApiException - if any exception occurs

createTag

public Tag createTag(Integer projectId,
                     String tagName,
                     String ref,
                     String message,
                     File releaseNotesFile)
              throws GitLabApiException

Creates a tag on a particular ref of a given project. A message and a File instance containing the release notes are optional. This method is the same as createTag(Integer, String, String, String, String), but instead allows the release notes to be supplied in a file. POST /projects/:id/repository/tags

Parameters:

projectId - the ID of the project

tagName - the name of the tag, must be unique for the project

ref - the git ref to place the tag on

message - the message to included with the tag (optional)

releaseNotesFile - a whose contents are the release notes (optional)

Returns:

a Tag instance containing info on the newly created tag

Throws:

GitLabApiException - if any exception occurs

deleteTag

public void deleteTag(Integer projectId,
                      String tagName)
               throws GitLabApiException

Deletes the tag from a project with the specified tag name. DELETE /projects/:id/repository/tags/:tag_name

Parameters:

projectId - the ID of the project

tagName - The name of the tag to delete

Throws:

GitLabApiException - if any exception occurs

getTree

public List<TreeItem> getTree(Integer projectId)
                       throws GitLabApiException

Get a list of repository files and directories in a project. GET /projects/:id/repository/tree

Parameters:

projectId - the ID of the project to get the files for

Returns:

a tree with the root directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getTree

public Pager<TreeItem> getTree(Integer projectId,
                               int itemsPerPage)
                        throws GitLabApiException

Get a Pager of repository files and directories in a project. GET /projects/:id/repository/tree

Parameters:

projectId - the ID of the project to get the files for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager containing a tree with the root directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getTree

public List<TreeItem> getTree(Integer projectId,
                              String filePath,
                              String refName)
                       throws GitLabApiException

Get a list of repository files and directories in a project. GET /projects/:id/repository/tree id (required) - The ID of a project path (optional) - The path inside repository. Used to get content of subdirectories ref_name (optional) - The name of a repository branch or tag or if not given the default branch

Parameters:

projectId - the ID of the project to get the files for

filePath - the path inside repository, used to get content of subdirectories

refName - the name of a repository branch or tag or if not given the default branch

Returns:

a tree with the directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getTree

public Pager<TreeItem> getTree(Integer projectId,
                               String filePath,
                               String refName,
                               int itemsPerPage)
                        throws GitLabApiException

Get a Pager of repository files and directories in a project. GET /projects/:id/repository/tree id (required) - The ID of a project path (optional) - The path inside repository. Used to get content of subdirectories ref_name (optional) - The name of a repository branch or tag or if not given the default branch

Parameters:

projectId - the ID of the project to get the files for

filePath - the path inside repository, used to get content of subdirectories

refName - the name of a repository branch or tag or if not given the default branch

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager containing a tree with the directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getTree

public List<TreeItem> getTree(Integer projectId,
                              String filePath,
                              String refName,
                              Boolean recursive)
                       throws GitLabApiException

Get a list of repository files and directories in a project. GET /projects/:id/repository/tree id (required) - The ID of a project path (optional) - The path inside repository. Used to get contend of subdirectories ref_name (optional) - The name of a repository branch or tag or if not given the default branch recursive (optional) - Boolean value used to get a recursive tree (false by default)

Parameters:

projectId - the ID of the project to get the files for

filePath - the path inside repository, used to get content of subdirectories

refName - the name of a repository branch or tag or if not given the default branch

recursive - flag to get a recursive tree or not

Returns:

a tree with the directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getTree

public Pager<TreeItem> getTree(Integer projectId,
                               String filePath,
                               String refName,
                               Boolean recursive,
                               int itemsPerPage)
                        throws GitLabApiException

Get a Pager of repository files and directories in a project. GET /projects/:id/repository/tree id (required) - The ID of a project path (optional) - The path inside repository. Used to get contend of subdirectories ref_name (optional) - The name of a repository branch or tag or if not given the default branch recursive (optional) - Boolean value used to get a recursive tree (false by default)

Parameters:

projectId - the ID of the project to get the files for

filePath - the path inside repository, used to get content of subdirectories

refName - the name of a repository branch or tag or if not given the default branch

recursive - flag to get a recursive tree or not

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a tree with the directories and files of a project

Throws:

GitLabApiException - if any exception occurs

getRawBlobContent

public InputStream getRawBlobContent(Integer projectId,
                                     String sha)
                              throws GitLabApiException

Get the raw file contents for a blob by blob SHA. GET /projects/:id/repository/raw_blobs/:sha

Parameters:

projectId - the ID of the project

sha - the SHA of the file to get the contents for

Returns:

the raw file contents for the blob on an InputStream

Throws:

GitLabApiException - if any exception occurs

getRepositoryArchive

public InputStream getRepositoryArchive(Integer projectId,
                                        String sha)
                                 throws GitLabApiException

Get an archive of the complete repository by SHA (optional). GET /projects/:id/repository/archive

Parameters:

projectId - the ID of the project

sha - the SHA of the archive to get

Returns:

an input stream that can be used to save as a file or to read the content of the archive

Throws:

GitLabApiException - if any exception occurs

getRepositoryArchive

public File getRepositoryArchive(Integer projectId,
                                 String sha,
                                 File directory)
                          throws GitLabApiException

Get an archive of the complete repository by SHA (optional) and saves to the specified directory. If the archive already exists in the directory it will be overwritten. GET /projects/:id/repository/archive

Parameters:

projectId - the ID of the project

sha - the SHA of the archive to get

directory - the File instance of the directory to save the archive to, if null will use "java.io.tmpdir"

Returns:

a File instance pointing to the downloaded instance

Throws:

GitLabApiException - if any exception occurs

compare

public CompareResults compare(Integer projectId,
                              String from,
                              String to)
                       throws GitLabApiException

Compare branches, tags or commits. This can be accessed without authentication if the repository is publicly accessible.

Parameters:

projectId - the ID of the project owned by the authenticated user

from - the commit SHA or branch name

to - the commit SHA or branch name

Returns:

a CompareResults containing the results of the comparison

Throws:

GitLabApiException - if any exception occurs

compare

public CompareResults compare(String projectPath,
                              String from,
                              String to)
                       throws GitLabApiException

Compare branches, tags or commits. This can be accessed without authentication if the repository is publicly accessible.

Parameters:

projectPath - the path of the project owned by the authenticated user

from - the commit SHA or branch name

to - the commit SHA or branch name

Returns:

a CompareResults containing the results of the comparison

Throws:

GitLabApiException - if any exception occurs