Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
ProjectApi.java 100.24 KiB
Open in Web IDE
1 
/*
2 
 * The MIT License (MIT)
3 
 *
4 
 * Copyright (c) 2017 Greg Messner <greg@messners.com>
5 
 *
6 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
7 
 * this software and associated documentation files (the "Software"), to deal in
8 
 * the Software without restriction, including without limitation the rights to
9 
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10 
 * the Software, and to permit persons to whom the Software is furnished to do so,
11 
 * subject to the following conditions:
12 
 *
13 
 * The above copyright notice and this permission notice shall be included in all
14 
 * copies or substantial portions of the Software.
15 
 *
16 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18 
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19 
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 
 */
23
24 
package org.gitlab4j.api;
25
26 
import java.io.File;
27 
import java.io.UnsupportedEncodingException;
28 
import java.net.URLEncoder;
29 
import java.util.Date;
30 
import java.util.List;
31 
import java.util.Map;
32 
import java.util.Optional;
33
34 
import javax.ws.rs.core.Form;
35 
import javax.ws.rs.core.GenericType;
36 
import javax.ws.rs.core.Response;
37
38 
import org.gitlab4j.api.GitLabApi.ApiVersion;
39 
import org.gitlab4j.api.models.AccessLevel;
40 
import org.gitlab4j.api.models.Event;
41 
import org.gitlab4j.api.models.FileUpload;
42 
import org.gitlab4j.api.models.Issue;
43 
import org.gitlab4j.api.models.Member;
44 
import org.gitlab4j.api.models.Project;
45 
import org.gitlab4j.api.models.ProjectHook;
46 
import org.gitlab4j.api.models.ProjectUser;
47 
import org.gitlab4j.api.models.PushRules;
48 
import org.gitlab4j.api.models.Snippet;
49 
import org.gitlab4j.api.models.Visibility;
50
51 
/**
52 
 * This class provides an entry point to all the GitLab API project calls.
53 
 */
54 
public class ProjectApi extends AbstractApi implements Constants {
55
56 
    public ProjectApi(GitLabApi gitLabApi) {
57 
        super(gitLabApi);
58 
    }
59
60 
    /**
61 
     * Get a list of projects accessible by the authenticated user.
62 
     *
63 
     * GET /projects
64 
     *
65 
     * @return a list of projects accessible by the authenticated user
66 
     * @throws GitLabApiException if any exception occurs
67 
     */
68 
    public List<Project> getProjects() throws GitLabApiException {
69 
        Response response = get(Response.Status.OK, getDefaultPerPageParam(), "projects");
70 
        return (response.readEntity(new GenericType<List<Project>>() {}));
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
} /** * Get a list of projects accessible by the authenticated user and in the specified page range. * * GET /projects * * @param page the page to get * @param perPage the number of projects per page * @return a list of projects accessible by the authenticated user * @throws GitLabApiException if any exception occurs */ public List<Project> getProjects(int page, int perPage) throws GitLabApiException { Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects"); return (response.readEntity(new GenericType<List<Project>>() { })); } /** * Get a Pager instance of projects accessible by the authenticated user. * * GET /projects * * @param itemsPerPage the number of Project instances that will be fetched per page * @return a Pager instance of projects accessible by the authenticated user * @throws GitLabApiException if any exception occurs */ public Pager<Project> getProjects(int itemsPerPage) throws GitLabApiException { return (new Pager<Project>(this, Project.class, itemsPerPage, null, "projects")); } /** * Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. * All filter parameters are optional. * * GET /projects * * @param archived limit by archived status * @param visibility limit by visibility public, internal, or private * @param orderBy return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields, default is created_at * @param sort return projects sorted in asc or desc order. Default is desc * @param search return list of projects matching the search criteria * @param simple return only the ID, URL, name, and path of each project * @param owned limit by projects owned by the current user * @param membership limit by projects that the current user is a member of * @param starred limit by projects starred by the current user * @param statistics include project statistics * @return a list of projects accessible by the authenticated user and matching the supplied parameters * @throws GitLabApiException if any exception occurs * @deprecated Will be removed in version 5.0, replaced by {@link #getProjects(Boolean, Visibility, * Constants.ProjectOrderBy, Constants.SortOrder, String, Boolean, Boolean, Boolean, Boolean, Boolean)} */ public List<Project> getProjects(Boolean archived, Visibility visibility, String orderBy, String sort, String search, Boolean simple, Boolean owned, Boolean membership, Boolean starred, Boolean statistics) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm() .withParam("archived", archived) .withParam("visibility", visibility) .withParam("order_by", orderBy) .withParam("sort", sort) .withParam("search", search) .withParam("simple", simple) .withParam("owned", owned) .withParam("membership", membership) .withParam("starred", starred) .withParam("statistics", statistics) .withParam(PER_PAGE_PARAM, getDefaultPerPage()); Response response = get(Response.Status.OK, formData.asMap(), "projects"); return (response.readEntity(new GenericType<List<Project>>() {}));