Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
GitLabApi.java 61.60 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.util.Collections;
4 
import java.util.List;
5 
import java.util.Map;
6 
import java.util.Optional;
7 
import java.util.WeakHashMap;
8 
import java.util.logging.Level;
9 
import java.util.logging.Logger;
10
11 
import javax.ws.rs.core.MediaType;
12 
import javax.ws.rs.core.Response;
13
14 
import org.gitlab4j.api.Constants.TokenType;
15 
import org.gitlab4j.api.models.OauthTokenResponse;
16 
import org.gitlab4j.api.models.User;
17 
import org.gitlab4j.api.models.Version;
18 
import org.gitlab4j.api.utils.MaskingLoggingFilter;
19 
import org.gitlab4j.api.utils.Oauth2LoginStreamingOutput;
20 
import org.gitlab4j.api.utils.SecretString;
21
22 
/**
23 
 * This class is provides a simplified interface to a GitLab API server, and divides the API up into
24 
 * a separate API class for each concern.
25 
 */
26 
public class GitLabApi implements AutoCloseable {
27
28 
    private final static Logger LOGGER = Logger.getLogger(GitLabApi.class.getName());
29
30 
    /** GitLab4J default per page.  GitLab will ignore anything over 100. */
31 
    public static final int DEFAULT_PER_PAGE = 96;
32
33 
    /** Specifies the version of the GitLab API to communicate with. */
34 
    public enum ApiVersion {
35 
        V3, V4;
36
37 
        public String getApiNamespace() {
38 
            return ("/api/" + name().toLowerCase());
39 
        }
40 
    }
41
42 
    // Used to keep track of GitLabApiExceptions on calls that return Optional<?>
43 
    private static final Map<Integer, GitLabApiException> optionalExceptionMap =
44 
            Collections.synchronizedMap(new WeakHashMap<Integer, GitLabApiException>());
45
46 
    GitLabApiClient apiClient;
47 
    private ApiVersion apiVersion;
48 
    private String gitLabServerUrl;
49 
    private Map<String, Object> clientConfigProperties;
50 
    private int defaultPerPage = DEFAULT_PER_PAGE;
51
52 
    private ApplicationsApi applicationsApi;
53 
    private ApplicationSettingsApi applicationSettingsApi;
54 
    private AuditEventApi auditEventApi;
55 
    private AwardEmojiApi awardEmojiApi;
56 
    private BoardsApi boardsApi;
57 
    private CommitsApi commitsApi;
58 
    private ContainerRegistryApi containerRegistryApi;
59 
    private DiscussionsApi discussionsApi;
60 
    private DeployKeysApi deployKeysApi;
61 
    private DeploymentsApi deploymentsApi;
62 
    private DeployTokensApi deployTokensApi;
63 
    private EnvironmentsApi environmentsApi;
64 
    private EpicsApi epicsApi;
65 
    private EventsApi eventsApi;
66 
    private GroupApi groupApi;
67 
    private HealthCheckApi healthCheckApi;
68 
    private ImportExportApi importExportApi;
69 
    private IssuesApi issuesApi;
70 
    private JobApi jobApi;
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
private LabelsApi labelsApi; private LicenseApi licenseApi; private LicenseTemplatesApi licenseTemplatesApi; private MarkdownApi markdownApi; private MergeRequestApi mergeRequestApi; private MilestonesApi milestonesApi; private NamespaceApi namespaceApi; private NotesApi notesApi; private NotificationSettingsApi notificationSettingsApi; private PackagesApi packagesApi; private PipelineApi pipelineApi; private ProjectApi projectApi; private ProtectedBranchesApi protectedBranchesApi; private ReleasesApi releasesApi; private RepositoryApi repositoryApi; private RepositoryFileApi repositoryFileApi; private ResourceLabelEventsApi resourceLabelEventsApi; private RunnersApi runnersApi; private SearchApi searchApi; private ServicesApi servicesApi; private SnippetsApi snippetsApi; private SystemHooksApi systemHooksApi; private TagsApi tagsApi; private TodosApi todosApi; private UserApi userApi; private WikisApi wikisApi; /** * Get the GitLab4J shared Logger instance. * * @return the GitLab4J shared Logger instance */ public static final Logger getLogger() { return (LOGGER); } /** * Constructs a GitLabApi instance set up to interact with the GitLab server * using GitLab API version 4. This is the primary way to authenticate with * the GitLab REST API. * * @param hostUrl the URL of the GitLab server * @param personalAccessToken the private token to use for access to the API */ public GitLabApi(String hostUrl, String personalAccessToken) { this(ApiVersion.V4, hostUrl, personalAccessToken, null); } /** * Constructs a GitLabApi instance set up to interact with the GitLab server using GitLab API version 4. * * @param hostUrl the URL of the GitLab server * @param personalAccessToken the private token to use for access to the API * @param secretToken use this token to validate received payloads */ public GitLabApi(String hostUrl, String personalAccessToken, String secretToken) { this(ApiVersion.V4, hostUrl, TokenType.PRIVATE, personalAccessToken, secretToken); } /** * <p>Logs into GitLab using OAuth2 with the provided {@code username} and {@code password}, * and creates a new {@code GitLabApi} instance using returned access token.</p> * * @param url GitLab URL * @param username user name for which private token should be obtained * @param password a CharSequence containing the password for a given {@code username} * @return new {@code GitLabApi} instance configured for a user-specific token * @throws GitLabApiException GitLabApiException if any exception occurs during execution */ public static GitLabApi oauth2Login(String url, String username, CharSequence password) throws GitLabApiException {