Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
BoardsApi.java 15.21 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.util.List;
4 
import java.util.Optional;
5 
import java.util.stream.Stream;
6
7 
import javax.ws.rs.core.GenericType;
8 
import javax.ws.rs.core.Response;
9
10 
import org.gitlab4j.api.models.Board;
11 
import org.gitlab4j.api.models.BoardList;
12
13 
/**
14 
 * This class implements the client side API for the GitLab Issue Boards API calls.
15 
 *
16 
 * NOTE: If a user is not a member of a group and the group is private,
17 
 *       a GET request on that group will result to a 404 status code.
18 
 *
19 
 * @see <a href="https://docs.gitlab.com/ce/api/boards.html">GitLab Issue Boards API Documentaion</a>
20 
 */
21 
public class BoardsApi extends AbstractApi {
22
23 
    public BoardsApi(GitLabApi gitLabApi) {
24 
        super(gitLabApi);
25 
    }
26
27 
    /**
28 
     * Lists Issue Boards in the given project.
29 
     *
30 
     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
31 
     *
32 
     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
33 
     * @return a list of project's issue boards
34 
     * @throws GitLabApiException if any exception occurs
35 
     */
36 
    public List<Board> getBoards(Object projectIdOrPath) throws GitLabApiException {
37 
        return (getBoards(projectIdOrPath, getDefaultPerPage()).all());
38 
    }
39
40 
    /**
41 
     * Get all issue boards for the specified project using the specified page and per page setting
42 
     *
43 
     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
44 
     *
45 
     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
46 
     * @param page the page to get
47 
     * @param perPage the number of items per page
48 
     * @return a list of project's Boards in the specified range
49 
     * @throws GitLabApiException if any exception occurs
50 
     */
51 
    public List<Board> getBoards(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
52 
        Response response = get(javax.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage),
53 
                "projects", getProjectIdOrPath(projectIdOrPath), "boards");
54 
        return (response.readEntity(new GenericType<List<Board>>() {}));
55 
    }
56
57 
    /**
58 
     * Get a Pager of all issue boards for the specified project.
59 
     *
60 
     * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre>
61 
     *
62 
     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
63 
     * @param itemsPerPage the number of items per page
64 
     * @return a Pager of project's issue boards
65 
     * @throws GitLabApiException if any exception occurs
66 
     */
67 
    public Pager<Board> getBoards(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
68 
        return (new Pager<Board>(this, Board.class, itemsPerPage, null,
69 
                "projects", getProjectIdOrPath(projectIdOrPath), "boards"));
70 
    }
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
/** * Get a Stream of all issue boards for the specified project. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @return a Stream of project's issue boards * @throws GitLabApiException if any exception occurs */ public Stream<Board> getBoardsStream(Object projectIdOrPath) throws GitLabApiException { return (getBoards(projectIdOrPath, getDefaultPerPage()).stream()); } /** * Get a single issue board. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @return a Board instance for the specified board ID * @throws GitLabApiException if any exception occurs */ public Board getBoard(Object projectIdOrPath, Integer boardId) throws GitLabApiException { Response response = get(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId); return (response.readEntity(Board.class)); } /** * Get an issue board as an Optional instance. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @return the Board instance for the specified board ID as an Optional instance */ public Optional<Board> getOptionalBoard(Object projectIdOrPath, Integer boardId) { try { return (Optional.ofNullable(getBoard(projectIdOrPath, boardId))); } catch (GitLabApiException glae) { return (GitLabApi.createOptionalFromException(glae)); } } /** * Creates a new Issue Board. * * <p>NOTE: This is only available in GitLab EE</p> * * <pre><code>GitLab Endpoint: POST /projects/:id/boards</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param name the name for the new board * @return the created Board instance * @throws GitLabApiException if any exception occurs */ public Board createBoard(Object projectIdOrPath, String name) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm().withParam("name", name, true); Response response = post(Response.Status.CREATED, formData.asMap(), "projects", getProjectIdOrPath(projectIdOrPath), "boards"); return (response.readEntity(Board.class)); } /** * Updates an existing Issue Board. * * <p>NOTE: This is only available in GitLab EE</p> *
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
* <pre><code>GitLab Endpoint: PUT /projects/:id/boards/:board_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param boardId the ID of the board, required * @param name the new name of the board, optional (can be null) * @param assigneeId the assignee the board should be scoped to, optional (can be null) * @param milestoneId the milestone the board should be scoped to, optional (can be null) * @param labels a comma-separated list of label names which the board should be scoped to, optional (can be null) * @param weight the weight range from 0 to 9, to which the board should be scoped to, optional (can be null) * @return the updated Board instance * @throws GitLabApiException if any exception occurs */ public BoardList updateBoard(Object projectIdOrPath, Integer boardId, String name, Integer assigneeId, Integer milestoneId, String labels, Integer weight) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm() .withParam("name", name) .withParam("assignee_id", assigneeId) .withParam("milestone_id", milestoneId) .withParam("labels", labels) .withParam("weight", weight); Response response = put(Response.Status.OK, formData.asMap(), "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId); return (response.readEntity(BoardList.class)); } /** * Soft deletes an existing Issue Board. * * <p>NOTE: This is only available in GitLab EE</p> * * <pre><code>GitLab Endpoint: DELETE /projects/:id/boards/:board_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @throws GitLabApiException if any exception occurs */ public void deleteBoard(Object projectIdOrPath, Integer boardId) throws GitLabApiException { delete(Response.Status.NO_CONTENT, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId); } /** * Get a list of the board’s lists. Does not include open and closed lists. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @return a list of the issue board's lists * @throws GitLabApiException if any exception occurs */ public List<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId) throws GitLabApiException { return (getBoardLists(projectIdOrPath, boardId, getDefaultPerPage()).all()); } /** * Get a list of the board’s lists for the specified project to using the specified page and per page setting. * Does not include open and closed lists. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param page the page to get * @param perPage the number of Boards per page * @return a list of the issue board's lists in the specified range * @throws GitLabApiException if any exception occurs */ public List<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId, int page, int perPage) throws GitLabApiException { Response response = get(javax.ws.rs.core.Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists");
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
return (response.readEntity(new GenericType<List<BoardList>>() {})); } /** * Get a Pager of the board’s lists. Does not include open and closed lists. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param itemsPerPage the number of Board instances that will be fetched per page * @return a Pager of the issue board's lists * @throws GitLabApiException if any exception occurs */ public Pager<BoardList> getBoardLists(Object projectIdOrPath, Integer boardId, int itemsPerPage) throws GitLabApiException { return (new Pager<BoardList>(this, BoardList.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists")); } /** * Get a Stream of the board’s lists. Does not include open and closed lists. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @return a Stream of the issue board's lists * @throws GitLabApiException if any exception occurs */ public Stream<BoardList> getBoardsListsStream(Object projectIdOrPath, Integer boardId) throws GitLabApiException { return (getBoardLists(projectIdOrPath, boardId, getDefaultPerPage()).stream()); } /** * Get a single issue board list. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param listId the ID of the board lists to get * @return a BoardList instance for the specified board ID and list ID * @throws GitLabApiException if any exception occurs */ public BoardList getBoardList(Object projectIdOrPath, Integer boardId, Integer listId) throws GitLabApiException { Response response = get(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId); return (response.readEntity(BoardList.class)); } /** * Get a single issue board list as an Optional instance. * * <pre><code>GitLab Endpoint: GET /projects/:id/boards/:board_id/lists/:list_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param listId the ID of the board lists to get * @return a BoardList instance for the specified board ID and list ID as an Optional instance */ public Optional<BoardList> getOptionalBoardList(Object projectIdOrPath, Integer boardId, Integer listId) { try { return (Optional.ofNullable(getBoardList(projectIdOrPath, boardId, listId))); } catch (GitLabApiException glae) { return (GitLabApi.createOptionalFromException(glae)); } } /** * Creates a new Issue Board list.
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
* * <pre><code>GitLab Endpoint: POST /projects/:id/boards/:board_id/lists</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param labelId the ID of the label * @return the created BoardList instance * @throws GitLabApiException if any exception occurs */ public BoardList createBoardList(Object projectIdOrPath, Integer boardId, Integer labelId) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm() .withParam("label_id", labelId, true); Response response = post(Response.Status.CREATED, formData, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists"); return (response.readEntity(BoardList.class)); } /** * Updates an existing Issue Board list. This call is used to change list position. * * <pre><code>GitLab Endpoint: PUT /projects/:id/boards/:board_id/lists/:list_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param listId the ID of the list * @param position the new position for the list * @return the updated BoardList instance * @throws GitLabApiException if any exception occurs */ public BoardList updateBoardList(Object projectIdOrPath, Integer boardId, Integer listId, Integer position) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm().withParam("position", position, true); Response response = putWithFormData(Response.Status.OK, formData, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId); return (response.readEntity(BoardList.class)); } /** * Soft deletes an existing Issue Board list. Only for admins and project owners. * * <pre><code>GitLab Endpoint: DELETE /projects/:id/boards/:board_id/lists/:list_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param boardId the ID of the board * @param listId the ID of the list * @throws GitLabApiException if any exception occurs */ public void deleteBoardList(Object projectIdOrPath, Integer boardId, Integer listId) throws GitLabApiException { delete(Response.Status.NO_CONTENT, null, "projects", getProjectIdOrPath(projectIdOrPath), "boards", boardId, "lists", listId); } }