Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
DeployKeysApi.java 9.98 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.Form;
8 
import javax.ws.rs.core.GenericType;
9 
import javax.ws.rs.core.Response;
10
11 
import org.gitlab4j.api.models.DeployKey;
12
13 
/**
14 
 * This class implements the client side API for the GitLab Deploy Keys API calls.
15 
 */
16 
public class DeployKeysApi extends AbstractApi {
17
18 
    public DeployKeysApi(GitLabApi gitLabApi) {
19 
        super(gitLabApi);
20 
    }
21
22 
    /**
23 
     * Get a list of all deploy keys across all projects of the GitLab instance. This method requires admin access.
24 
     *
25 
     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
26 
     *
27 
     * @return a list of DeployKey
28 
     * @throws GitLabApiException if any exception occurs
29 
     */
30 
    public List<DeployKey> getDeployKeys() throws GitLabApiException {
31 
        return (getDeployKeys(getDefaultPerPage()).all());
32 
    }
33
34 
    /**
35 
     * Get a list of all deploy keys across all projects of the GitLab instance using the specified page and per page settings.
36 
     * This method requires admin access.
37 
     *
38 
     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
39 
     *
40 
     * @param page the page to get
41 
     * @param perPage the number of deploy keys per page
42 
     * @return the list of DeployKey in the specified range
43 
     * @throws GitLabApiException if any exception occurs
44 
     */
45 
    public List<DeployKey> getDeployKeys(int page, int perPage) throws GitLabApiException {
46 
        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "deploy_keys");
47 
        return (response.readEntity(new GenericType<List<DeployKey>>() {}));
48 
    }
49
50 
    /**
51 
     * Get a Pager of all deploy keys across all projects of the GitLab instance. This method requires admin access.
52 
     *
53 
     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
54 
     *
55 
     * @param itemsPerPage the number of DeployKey instances that will be fetched per page
56 
     * @return a Pager of DeployKey
57 
     * @throws GitLabApiException if any exception occurs
58 
     */
59 
    public Pager<DeployKey> getDeployKeys(int itemsPerPage) throws GitLabApiException {
60 
        return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "deploy_keys"));
61 
    }
62
63 
    /**
64 
     * Get a Stream of all deploy keys across all projects of the GitLab instance. This method requires admin access.
65 
     *
66 
     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
67 
     *
68 
     * @return a list of DeployKey
69 
     * @throws GitLabApiException if any exception occurs
70 
     */
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
public Stream<DeployKey> getDeployKeysStream() throws GitLabApiException { return (getDeployKeys(getDefaultPerPage()).stream()); } /** * Get a list of the deploy keys for the specified project. This method requires admin access. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @return a list of DeployKey * @throws GitLabApiException if any exception occurs */ public List<DeployKey> getProjectDeployKeys(Object projectIdOrPath) throws GitLabApiException { return (getProjectDeployKeys(projectIdOrPath, getDefaultPerPage()).all()); } /** * Get a list of the deploy keys for the specified project using the specified page and per page settings. * This method requires admin access. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @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(Object projectIdOrPath, int page, int perPage) throws GitLabApiException { Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), "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. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance@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(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException { return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys")); } /** * Get a list of the deploy keys for the specified project. This method requires admin access. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @return a list of DeployKey * @throws GitLabApiException if any exception occurs */ public Stream<DeployKey> getProjectDeployKeysStream(Object projectIdOrPath) throws GitLabApiException { return (getProjectDeployKeys(projectIdOrPath, getDefaultPerPage()).stream()); } /** * Get a single deploy key for the specified project. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys/:key_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param keyId the ID of the deploy key to delete
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
* @return the DeployKey instance for the specified project ID and key ID * @throws GitLabApiException if any exception occurs */ public DeployKey getDeployKey(Object projectIdOrPath, Integer keyId) throws GitLabApiException { if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } Response response = get(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId); return (response.readEntity(DeployKey.class)); } /** * Get a single deploy key for the specified project as an Optional instance. * * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys/:key_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param keyId the ID of the deploy key to delete * @return the DeployKey for the specified project ID and key ID as an Optional instance */ public Optional<DeployKey> getOptionalDeployKey(Object projectIdOrPath, Integer keyId) { try { return (Optional.ofNullable(getDeployKey(projectIdOrPath, keyId))); } catch (GitLabApiException glae) { return (GitLabApi.createOptionalFromException(glae)); } } /** * Creates a new deploy key for a project. * * <pre><code>GitLab Endpoint: POST /projects/:id/deploy_keys</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @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(Object projectIdOrPath, String title, String key, Boolean canPush) throws GitLabApiException { GitLabApiForm formData = new GitLabApiForm() .withParam("title", title, true) .withParam("key", key, true) .withParam("can_push", canPush); Response response = post(Response.Status.CREATED, formData, "projects", getProjectIdOrPath(projectIdOrPath), "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. * * <pre><code>GitLab Endpoint: DELETE /projects/:id/deploy_keys/:key_id</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param keyId the ID of the deploy key to delete * @throws GitLabApiException if any exception occurs */ public void deleteDeployKey(Object projectIdOrPath, Integer keyId) throws GitLabApiException { if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } delete(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId);
211212213214215216217218219220221222223224225226227228229230231232233234
} /** * Enables a deploy key for a project so this can be used. Returns the enabled key when successful. * * <pre><code>GitLab Endpoint: POST /projects/:id/deploy_keys/:key_id/enable</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @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(Object projectIdOrPath, Integer keyId) throws GitLabApiException { if (keyId == null) { throw new RuntimeException("keyId cannot be null"); } Response response = post(Response.Status.CREATED, (Form)null, "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId, "enable"); return (response.readEntity(DeployKey.class)); } }