Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
CommitsApi.java 13.35 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.io.UnsupportedEncodingException;
4 
import java.net.URLEncoder;
5 
import java.util.Date;
6 
import java.util.List;
7
8 
import javax.ws.rs.core.Form;
9 
import javax.ws.rs.core.GenericType;
10 
import javax.ws.rs.core.Response;
11
12 
import org.gitlab4j.api.models.Comment;
13 
import org.gitlab4j.api.models.Commit;
14 
import org.gitlab4j.api.models.Diff;
15 
import org.gitlab4j.api.utils.ISO8601;
16
17 
/**
18 
 * This class implements the client side API for the GitLab commits calls.
19 
 */
20 
public class CommitsApi extends AbstractApi {
21
22 
    public CommitsApi(GitLabApi gitLabApi) {
23 
        super(gitLabApi);
24 
    }
25
26 
    /**
27 
     * Get a list of repository commits in a project.
28 
     *
29 
     * GET /projects/:id/repository/commits
30 
     *
31 
     * @param projectId the project ID to get the list of commits for
32 
     * @return a list containing the commits for the specified project ID
33 
     * @throws GitLabApiException GitLabApiException if any exception occurs during execution
34 
     */
35 
    public List<Commit> getCommits(int projectId) throws GitLabApiException {
36 
        return (getCommits(projectId, null, null, null));
37 
    }
38
39 
    /**
40 
     * Get a list of repository commits in a project.
41 
     *
42 
     * GET /projects/:id/repository/commits
43 
     *
44 
     * @param projectId the project ID to get the list of commits for
45 
     * @param page the page to get
46 
     * @param perPage the number of commits per page
47 
     * @return a list containing the commits for the specified project ID
48 
     * @throws GitLabApiException GitLabApiException if any exception occurs during execution
49 
     */
50 
    public List<Commit> getCommits(int projectId, int page, int perPage) throws GitLabApiException {
51 
        return (getCommits(projectId, null, null, null, page, perPage));
52 
    }
53
54 
    /**
55 
     * Get a Pager of repository commits in a project.
56 
     *
57 
     * GET /projects/:id/repository/commits
58 
     *
59 
     * @param projectId the project ID to get the list of commits for
60 
     * @param itemsPerPage the number of Commit instances that will be fetched per page
61 
     * @return a Pager containing the commits for the specified project ID
62 
     * @throws GitLabApiException GitLabApiException if any exception occurs during execution
63 
     */
64 
    public Pager<Commit> getCommits(int projectId, int itemsPerPage) throws GitLabApiException {
65 
        return (getCommits(projectId, null, null, null, itemsPerPage));
66 
    }
67
68 
    /**
69 
     * Get a list of repository commits in a project.
70 
     *
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
* GET /projects/:id/repository/commits * * @param projectId the project ID to get the list of commits for * @param ref the name of a repository branch or tag or if not given the default branch * @param since only commits after or on this date will be returned * @param until only commits before or on this date will be returned * @return a list containing the commits for the specified project ID * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Commit> getCommits(int projectId, String ref, Date since, Date until) throws GitLabApiException { Form formData = new GitLabApiForm() .withParam("ref_name", ref) .withParam("since", ISO8601.toString(since, false)) .withParam("until", ISO8601.toString(until, false)) .withParam(PER_PAGE_PARAM, getDefaultPerPage()); Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "commits"); return (response.readEntity(new GenericType<List<Commit>>() {})); } /** * Get a list of repository commits in a project. * * GET /projects/:id/repository/commits * * @param projectId the project ID to get the list of commits for * @param ref the name of a repository branch or tag or if not given the default branch * @param since only commits after or on this date will be returned * @param until only commits before or on this date will be returned * @param path the path to file of a project * @return a list containing the commits for the specified project ID * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Commit> getCommits(int projectId, String ref, Date since, Date until, String path) throws GitLabApiException { Form formData = new GitLabApiForm() .withParam(PER_PAGE_PARAM, getDefaultPerPage()) .withParam("ref_name", ref) .withParam("since", ISO8601.toString(since, false)) .withParam("until", ISO8601.toString(until, false)) .withParam("path", (path == null ? null : urlEncode(path))); Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "commits"); return (response.readEntity(new GenericType<List<Commit>>() {})); } /** * Get a list of file commits in a project * * GET /projects/:id/repository/commits?path=:file_path * * @param projectId the project ID to get the list of commits for * @param ref the name of a repository branch or tag or if not given the default branch * @param path the path to file of a project * @return a list containing the commits for the specified project ID and file * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Commit> getCommits(int projectId, String ref, String path) throws GitLabApiException { Form formData = new GitLabApiForm() .withParam(PER_PAGE_PARAM, getDefaultPerPage()) .withParam("ref_name", ref) .withParam("path", (path == null ? null : urlEncode(path))); Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "commits"); return (response.readEntity(new GenericType<List<Commit>>() {})); } /** * Get a list of repository commits in a project. * * GET /projects/:id/repository/commits * * @param projectId the project ID to get the list of commits for * @param ref the name of a repository branch or tag or if not given the default branch
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
* @param since only commits after or on this date will be returned * @param until only commits before or on this date will be returned * @param page the page to get * @param perPage the number of commits per page * @return a list containing the commits for the specified project ID * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Commit> getCommits(int projectId, String ref, Date since, Date until, int page, int perPage) throws GitLabApiException { Form formData = new GitLabApiForm() .withParam("ref_name", ref) .withParam("since", ISO8601.toString(since, false)) .withParam("until", ISO8601.toString(until, false)) .withParam(PAGE_PARAM, page) .withParam(PER_PAGE_PARAM, perPage); Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "commits"); return (response.readEntity(new GenericType<List<Commit>>() {})); } /** * Get a Pager of repository commits in a project. * * GET /projects/:id/repository/commits * * @param projectId the project ID to get the list of commits for * @param ref the name of a repository branch or tag or if not given the default branch * @param since only commits after or on this date will be returned * @param until only commits before or on this date will be returned * @param itemsPerPage the number of Commit instances that will be fetched per page * @return a Pager containing the commits for the specified project ID * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public Pager<Commit> getCommits(int projectId, String ref, Date since, Date until, int itemsPerPage) throws GitLabApiException { Form formData = new GitLabApiForm() .withParam("ref_name", ref) .withParam("since", ISO8601.toString(since, false)) .withParam("until", ISO8601.toString(until, false)); return (new Pager<Commit>(this, Commit.class, itemsPerPage, formData.asMap(), "projects", projectId, "repository", "commits")); } /** * Get a specific commit identified by the commit hash or name of a branch or tag. * * GET /projects/:id/repository/commits/:sha * * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return the Commit instance for the specified project ID/sha pair * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public Commit getCommit(int projectId, String sha) throws GitLabApiException { Response response = get(Response.Status.OK, getDefaultPerPageParam(), "projects", projectId, "repository", "commits", sha); return (response.readEntity(Commit.class)); } /** * Get the list of diffs of a commit in a project. * * GET /projects/:id/repository/commits/:sha/diff * * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return a List of Diff instances for the specified project ID/sha pair * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Diff> getDiff(int projectId, String sha) throws GitLabApiException { Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "commits", sha, "diff"); return (response.readEntity(new GenericType<List<Diff>>() {})); } /**
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
* Get the list of diffs of a commit in a project. * * GET /projects/:id/repository/commits/:sha/diff * * @param projectPath the project path that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return a List of Diff instances for the specified project ID/sha pair * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Diff> getDiff(String projectPath, String sha) throws GitLabApiException { try { projectPath = URLEncoder.encode(projectPath, "UTF-8"); } catch (UnsupportedEncodingException uee) { throw (new GitLabApiException(uee)); } Response response = get(Response.Status.OK, null, "projects", projectPath, "repository", "commits", sha, "diff"); return (response.readEntity(new GenericType<List<Diff>>() {})); } /** * Get the comments of a commit in a project. * * GET /projects/:id/repository/commits/:sha/comments * * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @return a List of Comment instances for the specified project ID/sha pair * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public List<Comment> getComments(int projectId, String sha) throws GitLabApiException { Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "commits", sha, "comments"); return (response.readEntity(new GenericType<List<Comment>>() {})); } /** * Add a comment to a commit. In order to post a comment in a particular line of a particular file, * you must specify the full commit SHA, the path, the line and lineType should be NEW. * * POST /projects/:id/repository/commits/:sha/comments * * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @param note the text of the comment, required * @param path the file path relative to the repository, optional * @param line the line number where the comment should be placed, optional * @param lineType the line type, optional * @return a Comment instance for the posted comment * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public Comment addComment(int projectId, String sha, String note, String path, Integer line, LineType lineType) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm() .withParam("note", note, true) .withParam("path", path) .withParam("line", line) .withParam("line_type", lineType); Response response = post(Response.Status.CREATED, formData, "projects", projectId, "repository", "commits", sha, "comments"); return (response.readEntity(Comment.class)); } /** * Add a comment to a commit. * * POST /projects/:id/repository/commits/:sha/comments * * @param projectId the project ID that the commit belongs to * @param sha a commit hash or name of a branch or tag * @param note the text of the comment, required * @return a Comment instance for the posted comment
281282283284285286287
* @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public Comment addComment(int projectId, String sha, String note) throws GitLabApiException { return (addComment(projectId, sha, note, null, null, null)); } }