Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
GitLabApiClient.java 26.19 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.io.IOException;
4 
import java.net.Socket;
5 
import java.net.URL;
6 
import java.security.GeneralSecurityException;
7 
import java.security.SecureRandom;
8 
import java.security.cert.CertificateException;
9 
import java.security.cert.X509Certificate;
10 
import java.util.List;
11 
import java.util.Map;
12
13 
import javax.net.ssl.HostnameVerifier;
14 
import javax.net.ssl.SSLContext;
15 
import javax.net.ssl.SSLEngine;
16 
import javax.net.ssl.SSLSession;
17 
import javax.net.ssl.TrustManager;
18 
import javax.net.ssl.X509ExtendedTrustManager;
19 
import javax.ws.rs.client.Client;
20 
import javax.ws.rs.client.ClientBuilder;
21 
import javax.ws.rs.client.Entity;
22 
import javax.ws.rs.client.Invocation;
23 
import javax.ws.rs.client.WebTarget;
24 
import javax.ws.rs.core.Form;
25 
import javax.ws.rs.core.MediaType;
26 
import javax.ws.rs.core.MultivaluedMap;
27 
import javax.ws.rs.core.Response;
28
29 
import org.gitlab4j.api.Constants.TokenType;
30 
import org.gitlab4j.api.GitLabApi.ApiVersion;
31 
import org.gitlab4j.api.utils.JacksonJson;
32 
import org.glassfish.jersey.client.ClientConfig;
33 
import org.glassfish.jersey.client.ClientProperties;
34
35 
/**
36 
 * This class utilizes the Jersey client package to communicate with a GitLab API endpoint.
37 
 */
38 
public class GitLabApiClient {
39
40 
    protected static final String PRIVATE_TOKEN_HEADER  = "PRIVATE-TOKEN";
41 
    protected static final String SUDO_HEADER           = "Sudo";
42 
    protected static final String AUTHORIZATION_HEADER  = "Authorization";
43 
    protected static final String X_GITLAB_TOKEN_HEADER = "X-Gitlab-Token";
44
45 
    private ClientConfig clientConfig;
46 
    private Client apiClient;
47 
    private String hostUrl;
48 
    private TokenType tokenType = TokenType.PRIVATE;
49 
    private String authToken;
50 
    private String secretToken;
51 
    private boolean ignoreCertificateErrors;
52 
    private SSLContext openSslContext;
53 
    private HostnameVerifier openHostnameVerifier;
54 
    private Integer sudoAsId;
55
56 
    /**
57 
     * Construct an instance to communicate with a GitLab API server using the specified GitLab API version,
58 
     * server URL, private token, and secret token.
59 
     *
60 
     * @param apiVersion the ApiVersion specifying which version of the API to use
61 
     * @param hostUrl the URL to the GitLab API server
62 
     * @param privateToken the private token to authenticate with
63 
     */
64 
    public GitLabApiClient(ApiVersion apiVersion, String hostUrl, String privateToken) {
65 
        this(apiVersion, hostUrl, TokenType.PRIVATE, privateToken, null);
66 
    }
67
68 
    /**
69 
     * Construct an instance to communicate with a GitLab API server using the specified GitLab API version,
70 
     * server URL, auth token type, private or access token, and secret token.
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
* * @param apiVersion the ApiVersion specifying which version of the API to use * @param hostUrl the URL to the GitLab API server * @param tokenType the type of auth the token is for, PRIVATE or ACCESS * @param authToken the token to authenticate with */ public GitLabApiClient(ApiVersion apiVersion, String hostUrl, TokenType tokenType, String authToken) { this(apiVersion, hostUrl, tokenType, authToken, null); } /** * Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified * server URL, private token, and secret token. * * @param hostUrl the URL to the GitLab API server * @param privateToken the private token to authenticate with */ public GitLabApiClient(String hostUrl, String privateToken) { this(ApiVersion.V4, hostUrl, TokenType.PRIVATE, privateToken, null); } /** * Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified * server URL, private token, and secret token. * * @param hostUrl the URL to the GitLab API server * @param tokenType the type of auth the token is for, PRIVATE or ACCESS * @param authToken the token to authenticate with */ public GitLabApiClient(String hostUrl, TokenType tokenType, String authToken) { this(ApiVersion.V4, hostUrl, tokenType, authToken, null); } /** * Construct an instance to communicate with a GitLab API server using the specified GitLab API version, * server URL, private token, and secret token. * * @param apiVersion the ApiVersion specifying which version of the API to use * @param hostUrl the URL to the GitLab API server * @param privateToken the private token to authenticate with * @param secretToken use this token to validate received payloads */ public GitLabApiClient(ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken) { this(apiVersion, hostUrl, TokenType.PRIVATE, privateToken, secretToken, null); } /** * Construct an instance to communicate with a GitLab API server using the specified GitLab API version, * server URL, private token, and secret token. * * @param apiVersion the ApiVersion specifying which version of the API to use * @param hostUrl the URL to the GitLab API server * @param tokenType the type of auth the token is for, PRIVATE or ACCESS * @param authToken the token to authenticate with * @param secretToken use this token to validate received payloads */ public GitLabApiClient(ApiVersion apiVersion, String hostUrl, TokenType tokenType, String authToken, String secretToken) { this(apiVersion, hostUrl, tokenType, authToken, secretToken, null); } /** * Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified * server URL, private token, and secret token. * * @param hostUrl the URL to the GitLab API server * @param privateToken the private token to authenticate with * @param secretToken use this token to validate received payloads */ public GitLabApiClient(String hostUrl, String privateToken, String secretToken) { this(ApiVersion.V4, hostUrl, TokenType.PRIVATE, privateToken, secretToken, null);
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
} /** * Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified * server URL, private token, and secret token. * * @param hostUrl the URL to the GitLab API server * @param tokenType the type of auth the token is for, PRIVATE or ACCESS * @param authToken the token to authenticate with * @param secretToken use this token to validate received payloads */ public GitLabApiClient(String hostUrl, TokenType tokenType, String authToken, String secretToken) { this(ApiVersion.V4, hostUrl, tokenType, authToken, secretToken, null); } /** * Construct an instance to communicate with a GitLab API server using GitLab API version 4, and the specified * server URL and private token. * * @param hostUrl the URL to the GitLab API server * @param privateToken the private token to authenticate with * @param secretToken use this token to validate received payloads * @param clientConfigProperties the properties given to Jersey's clientconfig */ public GitLabApiClient(String hostUrl, String privateToken, String secretToken, Map<String, Object> clientConfigProperties) { this(ApiVersion.V4, hostUrl, TokenType.PRIVATE, privateToken, secretToken, clientConfigProperties); } /** * Construct an instance to communicate with a GitLab API server using the specified GitLab API version, * server URL and private token. * * @param apiVersion the ApiVersion specifying which version of the API to use * @param hostUrl the URL to the GitLab API server * @param privateToken the private token to authenticate with * @param secretToken use this token to validate received payloads * @param clientConfigProperties the properties given to Jersey's clientconfig */ public GitLabApiClient(ApiVersion apiVersion, String hostUrl, String privateToken, String secretToken, Map<String, Object> clientConfigProperties) { this(apiVersion, hostUrl, TokenType.PRIVATE, privateToken, secretToken, clientConfigProperties); } /** * Construct an instance to communicate with a GitLab API server using the specified GitLab API version, * server URL and private token. * * @param apiVersion the ApiVersion specifying which version of the API to use * @param hostUrl the URL to the GitLab API server * @param tokenType the type of auth the token is for, PRIVATE or ACCESS * @param authToken the private token to authenticate with * @param secretToken use this token to validate received payloads * @param clientConfigProperties the properties given to Jersey's clientconfig */ public GitLabApiClient(ApiVersion apiVersion, String hostUrl, TokenType tokenType, String authToken, String secretToken, Map<String, Object> clientConfigProperties) { // Remove the trailing "/" from the hostUrl if present this.hostUrl = (hostUrl.endsWith("/") ? hostUrl.replaceAll("/$", "") : hostUrl); if (ApiVersion.OAUTH2_CLIENT != apiVersion) { this.hostUrl += apiVersion.getApiNamespace(); } this.tokenType = tokenType; this.authToken = authToken; if (secretToken != null) { secretToken = secretToken.trim(); secretToken = (secretToken.length() > 0 ? secretToken : null); } this.secretToken = secretToken;