Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*********************************************************************************
* *
* The MIT License (MIT) *
* *
* Copyright (c) 2015-2022 aoju.org Greg Messner and other contributors. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy *
* of this software and associated documentation files (the "Software"), to deal *
* in the Software without restriction, including without limitation the rights *
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included in *
* all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN *
* THE SOFTWARE. *
* *
********************************************************************************/
package org.aoju.bus.gitlab;
import org.aoju.bus.gitlab.models.Release;
import org.aoju.bus.gitlab.models.ReleaseParams;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
/**
* This class provides an entry point to all the GitLab Releases API calls.
*
* @see Releases API at GitLab
*/
public class ReleasesApi extends AbstractApi {
public ReleasesApi(GitLabApi gitLabApi) {
super(gitLabApi);
}
/**
* Get a list of releases for a project, sorted by release date.
*
*
GitLab Endpoint: GET /projects/:id/releases
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return the list of releases for the specified project
* @throws GitLabApiException if any exception occurs
*/
public List getReleases(Object projectIdOrPath) throws GitLabApiException {
return (getReleases(projectIdOrPath, getDefaultPerPage()).all());
}
/**
* Get a Pager of releases for a project, sorted by release date.
*
*
GitLab Endpoint: GET /projects/:id/releases
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param itemsPerPage the number of Release instances that will be fetched per page
* @return the Pager of Release instances for the specified project ID
* @throws GitLabApiException if any exception occurs
*/
public Pager getReleases(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
return (new Pager(this, Release.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "releases"));
}
/**
* Get a Stream of releases for a project, sorted by release date.
*
*
GitLab Endpoint: GET /projects/:id/releases
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a Stream of Release instances for the specified project ID
* @throws GitLabApiException if any exception occurs
*/
public Stream getReleasesStream(Object projectIdOrPath) throws GitLabApiException {
return (getReleases(projectIdOrPath, getDefaultPerPage()).stream());
}
/**
* Get a Release for the given tag name.
*
*
GitLab Endpoint: GET /projects/:id/releases/:tagName
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param tagName the name of the tag to fetch the Release for
* @return a Releases instance with info on the specified tag
* @throws GitLabApiException if any exception occurs
*/
public Release getRelease(Object projectIdOrPath, String tagName) throws GitLabApiException {
Response response = get(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "releases", urlEncode(tagName));
return (response.readEntity(Release.class));
}
/**
* Get an Optional instance holding a Release instance for the specific tag name.
*
*
GitLab Endpoint: GET /projects/:id/releases/:tagName
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param tagName the name of the tag to fetch the Release for
* @return an Optional instance with the specified Release as the value
* @throws GitLabApiException if any exception occurs
*/
public Optional getOptionalRelease(Object projectIdOrPath, String tagName) throws GitLabApiException {
try {
return (Optional.ofNullable(getRelease(projectIdOrPath, tagName)));
} catch (GitLabApiException glae) {
return (GitLabApi.createOptionalFromException(glae));
}
}
/**
* Create a Release. You need push access to the repository to create a Release.
*
*
GitLab Endpoint: POST /projects/:id/releases
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param params a ReleaseParams instance holding the parameters for the release
* @return a Release instance containing the newly created Release info
* @throws GitLabApiException if any exception occurs
*/
public Release createRelease(Object projectIdOrPath, ReleaseParams params) throws GitLabApiException {
Response response = post(Response.Status.CREATED, params,
"projects", getProjectIdOrPath(projectIdOrPath), "releases");
return (response.readEntity(Release.class));
}
/**
* Updates the release notes of a given release.
*
*
GitLab Endpoint: PUT /projects/:id/releases/:tag_name
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param params a ReleaseParams instance holding the parameters for the release
* @return a Release instance containing info on the updated Release
* @throws GitLabApiException if any exception occurs
*/
public Release updateRelease(Object projectIdOrPath, ReleaseParams params) throws GitLabApiException {
String tagName = params.getTagName();
if (tagName == null || tagName.trim().isEmpty()) {
throw new RuntimeException("params.tagName cannot be null or empty");
}
Response response = put(Response.Status.OK, params,
"projects", getProjectIdOrPath(projectIdOrPath), "releases", urlEncode(tagName));
return (response.readEntity(Release.class));
}
/**
* Delete a Release. Deleting a Release will not delete the associated tag.
*
*
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param tagName the tag name that the release was created from
* @throws GitLabApiException if any exception occurs
*/
public void deleteRelease(Object projectIdOrPath, String tagName) throws GitLabApiException {
delete(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "releases", urlEncode(tagName));
}
}
