An error occurred while loading the file. Please try again.
An error occurred while loading the file. Please try again.
An error occurred while loading the file. Please try again.
-
Gabriel Barbier authored267ffcf3
package org.gitlab4j.api;import java.util.List;import java.util.stream.Stream;import jakarta.ws.rs.core.GenericType;import jakarta.ws.rs.core.Response;import org.gitlab4j.api.GitLabApi.ApiVersion;import org.gitlab4j.api.models.SystemHook;/** * This class implements the client side API for the GitLab System Hooks Keys API calls. */public class SystemHooksApi extends AbstractApi { public SystemHooksApi(GitLabApi gitLabApi) { super(gitLabApi); } /** * Get a list of all system hooks. This method requires admin access. * * <pre><code>GitLab Endpoint: GET /hooks</code></pre> * * @return a list of SystemHookEvent * @throws GitLabApiException if any exception occurs */ public List<SystemHook> getSystemHooks() throws GitLabApiException { return (getSystemHooks(getDefaultPerPage()).all()); } /** * Get a list of all system hooks using the specified page and per page settings. * This method requires admin access. * * <pre><code>GitLab Endpoint: GET /hooks</code></pre> * * @param page the page to get * @param perPage the number of deploy keys per page * @return the list of SystemHookEvent in the specified range * @throws GitLabApiException if any exception occurs */ public List<SystemHook> getSystemHooks(int page, int perPage) throws GitLabApiException { Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "hooks"); return (response.readEntity(new GenericType<List<SystemHook>>() {})); } /** * Get a Pager of all system hooks. This method requires admin access. * * <pre><code>GitLab Endpoint: GET /hooks</code></pre> * * @param itemsPerPage the number of SystemHookEvent instances that will be fetched per page * @return a Pager of SystemHookEvent * @throws GitLabApiException if any exception occurs */ public Pager<SystemHook> getSystemHooks(int itemsPerPage) throws GitLabApiException { return (new Pager<SystemHook>(this, SystemHook.class, itemsPerPage, null, "hooks")); } /** * Get a Stream of all system hooks. This method requires admin access. * * <pre><code>GitLab Endpoint: GET /hooks</code></pre> * * @return a Stream of SystemHookEvent * @throws GitLabApiException if any exception occurs */ public Stream<SystemHook> getSystemHookStream() throws GitLabApiException {7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
return (getSystemHooks(getDefaultPerPage()).stream());
}
/**
* Add a new system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: POST /hooks</code></pre>
*
* @param url the hook URL, required
* @param token secret token to validate received payloads, optional
* @param pushEvents when true, the hook will fire on push events, optional
* @param tagPushEvents when true, the hook will fire on new tags being pushed, optional
* @param enableSslVerification do SSL verification when triggering the hook, optional
* @return an SystemHookEvent instance with info on the added system hook
* @throws GitLabApiException if any exception occurs
*/
public SystemHook addSystemHook(String url, String token, Boolean pushEvents,
Boolean tagPushEvents, Boolean enableSslVerification) throws GitLabApiException {
SystemHook systemHook = new SystemHook().withPushEvents(pushEvents)
.withTagPushEvents(tagPushEvents)
.withEnableSslVerification(enableSslVerification);
return addSystemHook(url, token, systemHook);
}
/**
* Add a new system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: POST /hooks</code></pre>
*
* @param url the hook URL, required
* @param token secret token to validate received payloads, optional
* @param systemHook the systemHook to create
* @return an SystemHookEvent instance with info on the added system hook
* @throws GitLabApiException if any exception occurs
*/
public SystemHook addSystemHook(String url, String token, SystemHook systemHook) throws GitLabApiException {
if (url == null) {
throw new RuntimeException("url cannot be null");
}
GitLabApiForm formData = new GitLabApiForm()
.withParam("url", url, true)
.withParam("token", token)
.withParam("push_events", systemHook.getPushEvents())
.withParam("tag_push_events", systemHook.getTagPushEvents())
.withParam("merge_requests_events", systemHook.getMergeRequestsEvents())
.withParam("repository_update_events", systemHook.getRepositoryUpdateEvents())
.withParam("enable_ssl_verification", systemHook.getEnableSslVerification());
Response response = post(Response.Status.CREATED, formData, "hooks");
return (response.readEntity(SystemHook.class));
}
/**
* Deletes a system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: DELETE /hooks/:hook_id</code></pre>
*
* @param hook the SystemHook instance to delete
* @throws GitLabApiException if any exception occurs
*/
public void deleteSystemHook(SystemHook hook) throws GitLabApiException {
if (hook == null) {
throw new RuntimeException("hook cannot be null");
}
deleteSystemHook(hook.getId());
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
}
/**
* Deletes a system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: DELETE /hooks/:hook_id</code></pre>
*
* @param hookId the ID of the system hook to delete
* @throws GitLabApiException if any exception occurs
*/
public void deleteSystemHook(Long hookId) throws GitLabApiException {
if (hookId == null) {
throw new RuntimeException("hookId cannot be null");
}
Response.Status expectedStatus = (isApiVersion(ApiVersion.V3) ? Response.Status.OK : Response.Status.NO_CONTENT);
delete(expectedStatus, null, "hooks", hookId);
}
/**
* Test a system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: GET /hooks/:hook_id</code></pre>
*
* @param hook the SystemHookEvent instance to test
* @throws GitLabApiException if any exception occurs
*/
public void testSystemHook(SystemHook hook) throws GitLabApiException {
if (hook == null) {
throw new RuntimeException("hook cannot be null");
}
testSystemHook(hook.getId());
}
/**
* Test a system hook. This method requires admin access.
*
* <pre><code>GitLab Endpoint: GET /hooks/:hook_id</code></pre>
*
* @param hookId the ID of the system hook to test
* @throws GitLabApiException if any exception occurs
*/
public void testSystemHook(Long hookId) throws GitLabApiException {
if (hookId == null) {
throw new RuntimeException("hookId cannot be null");
}
get(Response.Status.OK, null, "hooks", hookId);
}
}