Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
DeployKeysApi.java 7.79 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.util.List;
4
5 
import javax.ws.rs.core.Form;
6 
import javax.ws.rs.core.GenericType;
7 
import javax.ws.rs.core.Response;
8
9 
import org.gitlab4j.api.models.DeployKey;
10
11 
/**
12 
 * This class implements the client side API for the GitLab Deploy Keys API calls.
13 
 */
14 
public class DeployKeysApi extends AbstractApi {
15
16 
    public DeployKeysApi(GitLabApi gitLabApi) {
17 
        super(gitLabApi);
18 
    }
19
20 
    /**
21 
     * Get a list of all deploy keys across all projects of the GitLab instance. This method requires admin access.
22 
     * Only returns the first page.
23 
     *
24 
     * GET /deploy_keys
25 
     *
26 
     * @return a list of DeployKey
27 
     * @throws GitLabApiException if any exception occurs
28 
     */
29 
    public List<DeployKey> getDeployKeys() throws GitLabApiException {
30 
        return (getDeployKeys(1, getDefaultPerPage()));
31 
    }
32
33 
    /**
34 
     * Get a list of all deploy keys across all projects of the GitLab instance using the specified page and per page settings.
35 
     * This method requires admin access.
36 
     *
37 
     * GET /deploy_keys
38 
     *
39 
     * @param page the page to get
40 
     * @param perPage the number of deploy keys per page
41 
     * @return the list of DeployKey in the specified range
42 
     * @throws GitLabApiException if any exception occurs
43 
     */
44 
    public List<DeployKey> getDeployKeys(int page, int perPage) throws GitLabApiException {
45 
        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "deploy_keys");
46 
        return (response.readEntity(new GenericType<List<DeployKey>>() {}));
47 
    }
48
49 
    /**
50 
     * Get a Pager of all deploy keys across all projects of the GitLab instance. This method requires admin access.
51 
     *
52 
     * GET /deploy_keys
53 
     *
54 
     * @param itemsPerPage the number of DeployKey instances that will be fetched per page
55 
     * @return a Pager of DeployKey
56 
     * @throws GitLabApiException if any exception occurs
57 
     */
58 
    public Pager<DeployKey> getDeployKeys(int itemsPerPage) throws GitLabApiException {
59 
        return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "deploy_keys"));
60 
    }
61
62 
    /**
63 
     * Get a list of the deploy keys for the specified project. This method requires admin access.
64 
     * Only returns the first page.
65 
     *
66 
     * GET /projects/:id/deploy_keys
67 
     *
68 
     * @param projectId the ID of the project
69 
     * @return a list of DeployKey
70 
     * @throws GitLabApiException if any exception occurs
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
*/ public List<DeployKey> getProjectDeployKeys(Integer projectId) throws GitLabApiException { return (getProjectDeployKeys(projectId, 1, getDefaultPerPage())); } /** * Get a list of the deploy keys for the specified project using the specified page and per page settings. * This method requires admin access. * * GET /projects/:id/deploy_keys * * @param projectId the ID of the project * @param page the page to get * @param perPage the number of deploy keys per page * @return the list of DeployKey in the specified range * @throws GitLabApiException if any exception occurs */ public List<DeployKey> getProjectDeployKeys(Integer projectId, int page, int perPage) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", projectId, "deploy_keys"); return (response.readEntity(new GenericType<List<DeployKey>>() {})); } /** * Get a Pager of the deploy keys for the specified project. This method requires admin access. * * GET /projects/:id/deploy_keys * * @param projectId the ID of the project * @param itemsPerPage the number of DeployKey instances that will be fetched per page * @return a Pager of DeployKey * @throws GitLabApiException if any exception occurs */ public Pager<DeployKey> getProjectDeployKeys(Integer projectId, Integer itemsPerPage) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "projects", projectId, "deploy_keys")); } /** * Get a single deploy key for the specified project. * * GET /projects/:id/deploy_keys/:key_id * * @param projectId the ID of the project * @param keyId the ID of the deploy key to delete * @return the DeployKey instance for the specified project ID and key ID * @throws GitLabApiException if any exception occurs */ public DeployKey getDeployKey(Integer projectId, Integer keyId) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } Response response = get(Response.Status.OK, null, "projects", projectId, "deploy_keys", keyId); return (response.readEntity(DeployKey.class)); }
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
/** * Creates a new deploy key for a project. * * POST /projects/:id/deploy_keys * * @param projectId the ID of the project owned by the authenticated user, required * @param title the new deploy key's title, required * @param key the new deploy key, required * @param canPush can deploy key push to the project's repository, optional * @return an DeployKey instance with info on the added deploy key * @throws GitLabApiException if any exception occurs */ public DeployKey addDeployKey(Integer projectId, String title, String key, Boolean canPush) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } GitLabApiForm formData = new GitLabApiForm() .withParam("title", title, true) .withParam("key", key, true) .withParam("can_push", canPush); Response response = post(Response.Status.CREATED, formData, "projects", projectId, "deploy_keys"); return (response.readEntity(DeployKey.class)); } /** * Removes a deploy key from the project. If the deploy key is used only for this project,it will be deleted from the system. * * DELETE /projects/:id/deploy_keys/:key_id * * @param projectId the ID of the project * @param keyId the ID of the deploy key to delete * @throws GitLabApiException if any exception occurs */ public void deleteDeployKey(Integer projectId, Integer keyId) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } delete(Response.Status.OK, null, "projects", projectId, "deploy_keys", keyId); } /** * Enables a deploy key for a project so this can be used. Returns the enabled key when successful. * * POST /projects/:id/deploy_keys/:key_id/enable * * @param projectId the ID of the project * @param keyId the ID of the deploy key to enable * @return an DeployKey instance with info on the enabled deploy key * @throws GitLabApiException if any exception occurs */ public DeployKey enableDeployKey(Integer projectId, Integer keyId) throws GitLabApiException { if (projectId == null) { throw new RuntimeException("projectId cannot be null"); } if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } Response response = post(Response.Status.CREATED, (Form)null, "projects", projectId, "deploy_keys", keyId, "enable"); return (response.readEntity(DeployKey.class));
211212213
} }