diff --git a/src/main/java/org/gitlab4j/api/DeployKeysApi.java b/src/main/java/org/gitlab4j/api/DeployKeysApi.java new file mode 100644 index 0000000000000000000000000000000000000000..cfdbd795e21498652def37ca1d9e2d5fd8131ea4 --- /dev/null +++ b/src/main/java/org/gitlab4j/api/DeployKeysApi.java @@ -0,0 +1,214 @@ +package org.gitlab4j.api; + +import java.util.List; + +import javax.ws.rs.core.Form; +import javax.ws.rs.core.GenericType; +import javax.ws.rs.core.Response; + +import org.gitlab4j.api.models.DeployKey; + +/** + * This class implements the client side API for the GitLab Deploy Keys API calls. + */ +public class DeployKeysApi extends AbstractApi { + + public DeployKeysApi(GitLabApi gitLabApi) { + super(gitLabApi); + } + + /** + * Get a list of all deploy keys across all projects of the GitLab instance. This method requires admin access. + * Only returns the first page. + * + * GET /deploy_keys + * + * @return a list of DeployKey + * @throws GitLabApiException if any exception occurs + */ + public List getDeployKeys() throws GitLabApiException { + return (getDeployKeys(1, getDefaultPerPage())); + } + + /** + * Get a list of all deploy keys across all projects of the GitLab instance using the specified page and per page settings. + * This method requires admin access. + * + * GET /deploy_keys + * + * @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 getDeployKeys(int page, int perPage) throws GitLabApiException { + Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "deploy_keys"); + return (response.readEntity(new GenericType>() {})); + } + + /** + * Get a Pager of all deploy keys across all projects of the GitLab instance. This method requires admin access. + * + * GET /deploy_keys + * + * @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 getDeployKeys(int itemsPerPage) throws GitLabApiException { + return (new Pager(this, DeployKey.class, itemsPerPage, null, "deploy_keys")); + } + + /** + * Get a list of the deploy keys for the specified project. This method requires admin access. + * Only returns the first page. + * + * GET /projects/:id/deploy_keys + * + * @param projectId the ID of the project + * @return a list of DeployKey + * @throws GitLabApiException if any exception occurs + */ + public List 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 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>() {})); + } + + /** + * 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 getProjectDeployKeys(Integer projectId, Integer itemsPerPage) throws GitLabApiException { + + if (projectId == null) { + throw new RuntimeException("projectId cannot be null"); + } + + return (new Pager(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 the ID of the deploy key to delete + * @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 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)); + } + + /** + * 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)); + } +} diff --git a/src/main/java/org/gitlab4j/api/models/DeployKey.java b/src/main/java/org/gitlab4j/api/models/DeployKey.java new file mode 100644 index 0000000000000000000000000000000000000000..f8e4b3e89758b0945050ee00af97e5e5a159071d --- /dev/null +++ b/src/main/java/org/gitlab4j/api/models/DeployKey.java @@ -0,0 +1,59 @@ + +package org.gitlab4j.api.models; + +import java.util.Date; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlRootElement; + +@XmlRootElement +@XmlAccessorType(XmlAccessType.FIELD) +public class DeployKey { + + private Integer id; + private String title; + private String key; + private Boolean canPush; + private Date createdAt; + + public Integer getId() { + return this.id; + } + + public void setId(Integer id) { + this.id = id; + } + + public String getKey() { + return this.key; + } + + public void setKey(String key) { + this.key = key; + } + + public String getTitle() { + return this.title; + } + + public void setTitle(String title) { + this.title = title; + } + + public Boolean getCanPush() { + return canPush; + } + + public void setCanPush(Boolean canPush) { + this.canPush = canPush; + } + + public Date getCreatedAt() { + return this.createdAt; + } + + public void setCreatedAt(Date createdAt) { + this.createdAt = createdAt; + } +} diff --git a/src/test/resources/org/gitlab4j/api/deploy-keys.json b/src/test/resources/org/gitlab4j/api/deploy-keys.json new file mode 100644 index 0000000000000000000000000000000000000000..3407bdc02a9814fa779fcb7efb5e8e8ac11b9749 --- /dev/null +++ b/src/test/resources/org/gitlab4j/api/deploy-keys.json @@ -0,0 +1,16 @@ +[ + { + "id": 1, + "title": "Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "can_push": false, + "created_at": "2013-10-02T10:12:29Z" + }, + { + "id": 3, + "title": "Another Public key", + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=", + "can_push": true, + "created_at": "2013-10-02T11:12:29Z" + } +] \ No newline at end of file